B Oracle Web Services Manager WSMADMIN Commands

The chapter provides an overview of the capabilities of the Oracle Web Services Manager (Oracle WSM) wsmadmin commands.

Registering the required enforcement components.
Installing additional applications, and enforcement components.

Overview of the WSMADMIN Commands

Once you have installed Oracle WSM, use the information in this chapter to help use the Oracle WSM Configuration Assistant to configure and customize your installation to your topology requirements.

Location of the WSMADMIN commands

Execute the wsmadmin command from the following directory:

ORACLE_HOME\owsm\bin

Using the wsmadmin start Command to Start the Oracle WSM Server

For the standalone Oracle WSM installation, the Oracle WSM server should be started using the wsmadmin start command. See "start".

Note:

Oracle WSM does not work if the bundled application server is started independently.

If you have installed Oracle WSM as part of the Oracle Application Server 10g release 3 (10.1.3.1.0) release, refer to Oracle Application Server Administrator's Guide for more information on starting the server.

Syntax of the WSMADMIN Commands

The following is the syntax for the wsmadmin command:

wsmadmin operation parameters

The following are the valid values for operation:

buildApps
configApps
copyDBConfig
dataGenerator
dataload
dataloadConfigure
deploy
deployApps
encodePasswords
exportDBData
help
initialize
install
installAgent
installOC4J
installOLite
manageUsergroups
md5encode
migrate
start
startOC4J
startOLite
stop
stopOC4J
stopOLite
undeploy
uninstall
uninstallOC4J
uninstallOLite
upgrade

The commands are case-sensitive. Each operation is described in the following pages.

buildApps

This operation uses the JAR and JSP source files to build the J2EE application WAR or EAR files that are deployed.

Syntax

wsmadmin buildApps

Usage

The values for the installed applications are saved to the install.properties file during the Oracle WSM installation. After you have performed the buildApps operation, you need to perform the deployApps operation. There may be situations when you need to individually build and deploy your applications. For example, you may need to perform the following manual tasks between the buildApps and deployApps operations:

Version the Oracle WSM application archives before they are deployed
Prepare the application archives to be deployed manually

When you have finished building applications with the buildApps operation, use deployApps to deploy the application archives using the standard settings.

configApps

This operation generates new application configuration files based on the values in the install.properties file.

Syntax

wsmadmin configApps

Usage

Use this operation before running buildApps or deploy. Performing this operation does not affect JSSO-enabled applications. You may use this operation to change a database password and then redeploy the application.

This operation reads the following properties from the install.properties file:

Table B-1 install.properties Used During configApps

Attribute Name	Description
`install.appserver.type`	Select the Application Server type as `oracle-as`.
`install.http.host`	Specify the HTTP host name.
`install.http.port`	Specify the HTTP port.
`install.oc4j.instance`	Specifies the name of the container to deploy the application.
`install.sso.support`	Specify the value as `true`, only if you enable single sign-on for the Oracle WSM Control.
`install.proxy.host`	Name of the proxy server.
`install.proxy.port`	Port number of the proxy server.
`install.noproxy.hosts`	List of hosts where you may not connect using the proxy server. You can create a list separated by a vertical bar (\|), and use the asterisk (*), for wildcard matching.
`install.db.type`	Set the value to `oracle`, or `olite`.
`install.db.driver.type`	Specify the driver type, either `thick` or `thin`.
i`nstall.db.host`	Specify the machine name where the database is installed or the IP address.
`install.db.port`	Specify the port number for the database.
`install.db.userid`	Specify the database user ID.
`install.db.password`	Specify the password for the database.
`sqlserver.jdbc.jars.path`	Specify the location of the SQL Server JDBC JAR files.

Performing this operation overwrites the existing files and creates the following files:

ORACLE_HOME\owsm\bin\agent.properties

ORACLE_HOME\owsm\bin\coresv.properties

ORACLE_HOME\owsm\config\ccore\logging.xml

ORACLE_HOME\owsm\config\ccore\ui-config-installer.properties

ORACLE_HOME \owsm\config\clientagent\clientagent-config-installer.properties

ORACLE_HOME\owsm\config\clientagent\logging.xml

ORACLE_HOME\owsm\config\coreman\logging.xml

ORACLE_HOME\owsm\config\coreman\monitor-config-installer.properties

ORACLE_HOME \owsm\config\gateway\gateway-config-installer.properties

ORACLE_HOME\owsm\config\gateway\logging.xml

This operation creates all the files necessary to configure all the applications, including the subset of files created when you use the copyDBConfig operation.

You need to redeploy the applications to propagate the changes.

copyDBConfig

This operation copies the database configuration parameters into the configuration directory property files.

Syntax

wsmadmin copyDBConfig

Syntax

Use this operation before buildApps or deploy. This operation reads the following values from the coresv.properties file:

Table B-2 coresv.properties Used During copyDBConfig

Attribute Name	Description
`dataload.messagelog.db.url`	Location of the database URL.
`dataload.messagelog.db.driver`	Type of database driver, `thick` or `thin`.
`dataload.messagelog.db.userid`	User ID used to login to the database.
`dataload.messagelog.db.password`	Encrypted password used to log in to the database.

After reading the values, the operation modifies the following coresv.properties files:

ORACLE_HOME\owsm\bin\agent.properties

ORACLE_HOME\owsm\bin\coresv.properties

ORACLE_HOME\owsm\config\ccore\ui-config-installer.properties

ORACLE_HOME \owsm\config\clientagent\clientagent-config-installer.properties

ORACLE_HOME\owsm\config\coreman\monitor-config-installer.properties

ORACLE_HOME\owsm\config\gateway\gateway-config-installer.properties

You need to redeploy the applications to propagate the changes.

dataGenerator

This operation is a test tool that generates the data you can view on the Oracle WSM Monitor. Use wsmadmin dataGenerator to view the following types of data:

ping data
flow data
invocation data.

Syntax

wsmadmin dataGenerator

Usage

Use wsmadmin dataGenerator to view the following types of data:

ping data
flow data
invocation data.

The following properties are exclusively for the Oracle WSM Monitor. This operation reads the following values from the coresv.properties file:

Table B-3 coresv.properties Used During dataGenerator

Attribute Name	Description
`dataload.monitor.rmi.host`	Host name where the Oracle WSM Monitor is installed.
`dataload.monitor.rmi.port`	Port number where the Oracle WSM Monitor is installed.

dataload

This operation loads SQL scripts generated by the dataloadConfigure operation into the primary Oracle WSM Database.

Syntax

wsmadmin dataload database_server_password

Parameter

database_server_password – Database server password

Usage

The dataload operation checks whether the data already exists in the database before loading the data into the Oracle WSM Database. If data exists, then the operation exits.

You must perform the dataloadConfigure operation before performing dataload. The two operations dataload and dataloadConfigure provide the flexibility to customize the data before loading it into the database.

The initialize operation combines the dataload and dataloadConfigure operations.

The dataload operation reads the following attributes from the coresv.properties file:

Table B-4 coresv.properties Used During dataload

Attribute name	Description
`dataload.messagelog.db.url`	Location of the database URL.
`dataload.messagelog.db.driver`	Type of database driver, `thick` or `thin`.
`dataload.messagelog.db.userid`	User ID used to log in to the database.
`dataload.messagelog.db.password`	Encrypted password to log in to the database.

dataloadConfigure

This operation generates SQL scripts that are used to create the database schema and load seed data.

Syntax

wsmadmin dataloadConfigure

Usage

The database files are created in ORACLE_HOME\owsm\db. The dataloadConfigure operation reads the following attributes from the coresv.properties file:

Table B-5 coresv.properties Used During dataloadConfigure

Attribute name	Description
`dataload.messagelog.db.url`	Location of the database URL.
`dataload.messagelog.db.driver`	Type of database driver, `thick` or `thin`.
`dataload.messagelog.db.userid`	User ID used to log in to the database.
`dataload.messagelog.db.password`	Encrypted password to log in to the database.

Perform the dataload operation after you have performed dataloadConfigure. For more information, see "dataload" .

The initialize operation combines the dataload and dataloadConfigure operations.

deploy

This operation builds, deploys, and binds components to an OC4J application engine.

Syntax

wsmadmin deploy application_server_password component

application_server_password – Password for the application server.
component – Name of the component being deployed. The valid values are:
- all – Deploys all components
- control – Deploys the Web Services Manager Control
- gateway – Deploys the Oracle WSM Gateway
- monitor – Deploys the Oracle WSM Monitor
- policymanager – Deploys the Oracle WSM Policy Manager

Usage

Use this operation to build, deploy, bind controls, gateways, monitors, or policy manager instances. You can perform these tasks on all the components at the same time. Perform this operation to deploy applications without customizing them before deployment. To customize applications before deploying, see "buildApps" .

deployApps

This operation deploys components to an OC4J application engine.

Syntax

wsmadmin deployApps application_server_password component

Parameters

application_server_password – OC4J system administrator password
component – Name of the component being deployed. The valid values are as follows:
- all – Deploys all components
- control – Deploys the Web Services Manager Control
- gateway – Deploys the Oracle WSM Gateway
- monitor – Deploys the Oracle WSM Monitor
- policymanager – Deploys the Oracle WSM Policy Manager

Usage

Use this operation to deploy instances of Web Services Manager Control, Oracle WSM Gateway, Oracle WSM Monitor, or Oracle WSM Policy Manager. You can deploy all of the components at once using the all parameter or you can deploy the individual components. Use this operation after using the buildApps operation. For more information see "buildApps". The deployApps operation reads the following attributes from the coresv.properties file:

Table B-6 coresv.properties Used During deployApps

Attribute Name	Description
`oc4j.j2ee.home`	Location of the OC4J container.
`external.oc4j.home`	Location of the external OC4J installation.
`external.oc4j.host`	Host name for the external OC4J installation.
`external.oc4j.port`	Port number for the external OC4J installation.
`external.oc4j.adminPort`	Port number for the administrator of the external OC4J installation.
`external.oc4j.adminID`	Administrator's user name for the external OC4J installation.
`external.oc4j.instance`	Location of the OC4J instance.

encodePasswords

This operation encodes passwords in a property file.

Syntax

wsmadmin encodePasswords propertyFile properties

Parameters

propertyFile – Name of the specified file
properties – List of passwords that will be encoded

Usage

You can separate multiple passwords with a colon (:). However, spaces are not permitted.

exportDBData

This operation exports data from the Oracle WSM Database to a file.

Syntax

wsmadmin exportDBData database_server_password

Parameter

database_server_password – Database server password

Usage

When you execute the command, the following message is displayed:

"Warning!!! The data in the input directory will be deleted. Are you sure you want to continue? Y-Yes N-No:"

Select Y to proceed with the data export.

The exported tables are stored as XML files. You may perform this operation for the following reasons:

To back up your Oracle WSM data.
To store your data before moving your data to different location.

Note:

Check that the PATH environment variable is set to the location where SQL*Plus is installed.

The exportDBData operation reads the following attributes from the coresv.properties file:

Table B-7 coresv.properties Used During exportDBData

Attribute Name	Description
`db.export.dir`	Default location where you want to store your Oracle WSM Database file is `c:\temp`. Change this value to the location of your choice.

help

This operation displays the list of wsmadmin operations.

Syntax

wsmadmin help [operation]

Parameter

[operation] – Any valid wsmadmin operation described in this appendix. See "Syntax of the WSMADMIN Commands" for a complete list of wsmadmin operations.

Usage

If you execute the command wsmadmin help, you get a list of the valid operations you can perform with the command. To get help for a specific operation, including any arguments that the operation accepts, specify the name of the operation with the operation variable.

importDBData

This operation imports data from a file into the Oracle WSM Database.

Syntax

wsmadmin importDBData database_server_password

Parameter

database_server_password – Database server password

Usage

Confirm that the following requirements have been met:

Ensure that SQL*Plus is installed before performing this operation.
Verify that the PATH environment variable is set to the location where SQL*Plus is installed.

The importDBData operation reads the following attributes from the coresv.properties file:

Table B-8 coresv.properties Used During importDBData

Attribute Name	Description
`db.import.dir`	Default location from where you want to transfer data to your Oracle WSM Database is `c:\temp`. You may change this value to another location.

initialize

This operation initializes the primary database.

Syntax

wsmadmin initialize database_server_password

Parameter

database_server_password – Database server password

Usage

Use this operation to initialize and create the schema for an Oracle Lite database. However, to initialize an Oracle database, the schema must exist prior to using this operation. If you need to customize the data that is loaded into the database, use the dataloadConfigure and dataload operations. For more information, see "dataloadConfigure", and "dataload" .

The initialize operation reads the following attributes from the coresv.properties file:

Table B-9 coresv.properties Used During dataload

Attribute Name	Description
`dataload.messagelog.db.url`	Location of the database URL.
`dataload.messagelog.db.driver`	Type of database driver, `thick` or `thin`.
`dataload.messagelog.db.userid`	User ID used to log in to the database.
`dataload.messagelog.db.password`	Encrypted password for logging in to the database.
`dataload.db.import`	Value that imports only the data, or the schema and the data.

install

This operation is invoked by the installer automatically at the end of the installation procedure.

Syntax

wsmadmin install application_server_password database_server_password

Parameters

application_server_password – OC4J system administrator password
database_server_password – Database server password

Usage

The installer invokes this command at the end of the Oracle WSM configuration. If required, the configuration procedure includes the initialization of the bundled OC4J and Oracle Lite components. It also builds and deploys the J2EE applications, such as the Web Services Manager Control, Oracle WSM Policy Manager, and Oracle WSM Monitor. This single operation invokes and performs all the following operations:

configApps
installOLite
installOC4J
initialize
encodePasswords

The encodePasswords operation compares the passwords against the install.properties file.

installAgent

This operation builds and installs the J2EE agent based on the properties in the agent.properties file.

Syntax

wsmadmin installAgent application_server_password

Parameter

application_server_password – OC4J system administrator password

Usage

This operation requires the application server password to build and install an OC4J interceptor agent. The installAgent operation requires the following attribute from the agent.properties file:

Table B-10 agent.properties Used During installAgent

Attribute Name	Description
`agent.componentType`	Type of agent can be either a client or server agent.

Note:

See Chapter 6, "Installing Oracle WSM Agents", for more information on setting properties for each type of agent.

installOC4J

This operation installs the bundled OC4J application server included with the standalone installation.

Syntax

wsmadmin installOC4J application_server_password

Parameter

application_server_password – OC4J system administrator password

Usage

This operation initializes the OC4J server ports for Oracle WSM. When this operation runs for the first time, it sets the OC4J administrator password.

installOLite

This operation installs the bundled Oracle Lite database included with the basic installation.

Syntax

wsmadmin installOLite database_server_password

Parameter

database_server_password – Password for the system user for the Oracle WSM Database (orawsm) instance.

Usage

This operation performs the following functions:

Reads the install.db.* attribute in the install.properties file
Adds database entries to %WinDir%/OCBC.ini
Creates and updates %WinDir%/POLITE.ini
Creates a service for the Oracle Lite database, under the Windows Services Administrative Tool

manageUsergroups

Use this operation to manage user groups in the database.

Syntax

wsmadmin manageUserGroups database_server_password parameter

Parameters

database_server_password – Password for the Oracle Lite database
parameter – User or group name. The valid values are as follows:
- addUser
- addGroup
- addUserGroup
- deleteUser
- deleteGroup
- deleteUserGroup

Usage

The manageUserGroups operation requires certain attributes from the manageUserGrops.properties file. See the Oracle Web Services Manager Administrator's Guide for information about the changes you need to make to the properties file.

md5encode

Use this operation to encode a password associated with a user to the specified password file. This is used with file-based authentication.

Syntax

wsmadmin md5encode username password htpasswdfile

Parameters

username – User name in the text file
password – Password assigned to the user
htpasswdfile – Name of the file containing the user name and password

Usage

Run the md5encode command for each user name and password. Each encrypted result gets appended to the end of the file. The following are examples in an htpasswdfile file:

johndoe:{MD5}JMnhX1KvxHwiW3V+e+4fnQ==

janedoe:{MD5}dqIXO+Y5M1TnL/pNbfEDCg==

migrate

This operation migrates properties and database settings from a previous version.

Syntax

wsmadmin migrate previous_home application_server_password database_server_password

Parameters

previous_home – Location of the properties files and database settings of the existing version
application_server_password – OC4J system administrator password
database_server_password – Database server password

start

This operation starts the OC4J application engine and the Oracle Lite database server included with the basic installation.

Syntax

wsmadmin start

Usage

The start operation reads the following attributes from the coresv.properties file:

Table B-11 coresv.properties Used During start

Attribute Name	Description
`oc4j.j2ee.home`	Location of the OC4J container.
`proxy.host`	Host name of the OC4J installation.
`proxy.port`	Port number of the proxy server.
`noproxy.hosts`	Names of the host machines that should not exchange data using the proxy.

Use this operation if you intend to use startOLite followed by startOC4J.

startOC4J

This operation starts the OC4J application engine included with the basic installation.

Syntax

wsmadmin startOC4J

Usage

The startOC4J operation reads the following attributes from the coresv.properties file:

Table B-12 coresv.properties Used During start

Attribute Name	Description
`oc4j.j2ee.home`	Location of the OC4J container.
`proxy.host`	Host name of the OC4J installation.
`proxy.port`	Port number of the proxy server.
`noproxy.hosts`	Names of the host machines that should not be accessed through the proxy. You can enter multiple host names, and use the vertical bar (\|) character to separate them.

startOLite

This operation starts the Oracle Lite database server include in the basic installation.

Syntax

wsmadmin startOLite

stop

This operation stops the OC4J application engine and the Oracle Lite database server included with the basic installation.

Syntax

wsmadmin stop application_server_password

Parameters

application_server_password – OC4J system administrator password

Usage

This operation reads the oc4j.j2ee.home attribute in the coresv.properties file.

Use this operation if you intend to use stopOC4J and stopOLite.

stopOC4J

This operation stops the OC4J application engine included with the basic installation.

Syntax

wsmadmin stopOC4J application_server_password

Parameter

application_server_password – OC4J system administrator password

stopOLite

This operation stops the Oracle Lite database server included with the basic installation.

Syntax

wsmadmin stopOLite

undeploy

This operation unbinds and undeploys the specified components from an OC4J instance.

Syntax

wsmadmin undeploy application_server_password component

Parameters

application_server_password – OC4J system administrator password
component – Name of the component being deployed. The valid values are as follows:
- all – Deploys all components
- control – Deploys the Web Services Manager Control
- gateway – Deploys the Oracle WSM Gateway
- monitor – Deploys the Oracle WSM Monitor
- policymanager – Deploys the Oracle WSM Policy Manager

Usage

The undeploy operation reads the following attributes from the install.properties file:

Table B-13 coresv.properties Used During undeploy

Attribute Name	Description
`install.http.host`	Host name for the OC4J installation.
`install.oc4j.adminID`	Administrator's username for the OC4J installation.
`install.oc4j.instance`	Location of the OC4J instance.

uninstall

The installer invokes this operation automatically when uninstalling the Oracle WSM product.

Syntax

wsmadmin uninstall application_server_password

Parameter

application_server_password – OC4J systems administrator password

Usage

The deconfiguration procedure includes uninstalling the OC4J and Oracle Lite components. It also uninstalls the J2EE applications. The operation will not uninstall the OC4J components if you do not supply the password. This operation performs the functions of all the following operations:

Runs uninstallOC4J. If you do not supply the password, OC4J is not uninstalled. You need to uninstall OC4J manually.
Runs uninstallOLite
Deletes configuration files

Note:

This operation does not clean up the database. You have to perform this step separately.

uninstallOC4J

This operation deactivates the OC4J application server included with the basic installation.

Syntax

wsmadmin uninstallOC4J application_server_password

Parameter

application_server_password – OC4J system administrator password

Usage

This operation performs the functions of all the following operations:

undeployAll

stopOC4J

uninstallOLite

This operation uninstalls the Oracle Lite database server included with a Basic Oracle WSM installation.

Syntax

wsmadmin uninstallOLite

Usage

This operation performs the following tasks:

Stops the Oracle Lite database server and removes the service from the system
Removes the database entries from %WinDir%/OCBC.ini
Clears %WinDir%/POLITE.ini

upgrade

This operation upgrades the Oracle WSM Database.

Syntax

wsmadmin upgrade database_server_password database_type

Parameters

database_server_password – Database server password
database_type – Must be oracle, since this version of Oracle WSM only supports the Oracle database

Usage

This version of Oracle WSM only supports the Oracle database.