C Oracle Web Services Manager WSMADMIN Commands

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 Command on UNIX

When using the Oracle WSM WSMADMIN commands on UNIX operating systems, the command must be specified as wsmadmin.sh. The Oracle WSM documentation uses the syntax for Microsoft Windows operating systems (that is, wsmadmin) for all WSMADMIN commands. If you are using the commands on a UNIX system, replace wsmadmin with wsmadmin.sh.

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".

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:

• applyTopology

• buildApps

• configApps

• copyDBConfig

• dataGenerator

• dataload

• dataloadConfigure

• deploy

• deployApps

• encodePasswords

• exportDBData

• exportPolicySet

• exportTransferableObjects

• help

• importTransferableObjects

• initialize

• inspectTopology

• install

• installAgent

• installOC4J

• installOLite

• manageUsergroups

• md5encode

• migrate

• purgePolicies

• start

• startOC4J

• startOLite

• stop

• stopOC4J

• stopOLite

• undeploy

• uninstall

• uninstallOC4J

• uninstallOLite

• upgrade

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

Passwords for WSMADMIN Commands

In order to execute many of the WSMADMIN commands, you must supply a password for the application server, the database server, or both. When you execute the command, you will be prompted to provide the required password. When you provide the password in this manner, the password is encoded and secure.

There may be times when you need to automate a process and provide the password without direct user input. In such situations, you can provide passwords on the command line using the following syntax:

• -Doc4jAdminPassword=password – Use this parameter to supply the password for Oracle Application Server.

• -DDBPassword=password – Use this parameter to supply the password for Oracle Database Server.

You can also supply the password to a script using input redirection operators.

applyTopology

This operation creates a clone of Oracle WSM.

Syntax

wsmadmin applyTopology

Usage Notes

• This command uses the topology.properties file that is generated with the inspectTopology command to create a clone of Oracle WSM. If you clone the Oracle Application Server, the topology folder from the source machine is copied over to the correct location on the destination machine. Otherwise, the folder will have to be manually copied to ORACLE_HOME\owsm\config on the destination machine.

• Before you use the wsmadmin applyTopology command, you must edit the topology.properties file with the topology information for the destination machine. See "The topology.properties File" for information about the contents of this file and how to update this information.

• If the database.update property is set to true, then the applyTopology command deletes any Oracle WSM data in the Oracle Database on the destination machine. Then it copies the tables from the ORACLE_HOME/owsm/config/topology/export and ORACLE_HOME/owsm/config/topology/template directories on the source machine to the ORACLE_HOME/owsm/config/topology/import directory on the destination machine. It applies the necessary changes to the database tables. Finally, it imports the database tables into the destination installation and redeploys the Oracle WSM components.

• If your destination installation is distributed across multiple systems, then the first time you execute this command, the database.update property in the topology.properties file should be set to true to import the database tables. When you clone Oracle WSM components on subsequent machines, the database.update property should be set to false.

The topology.properties File

The file containing the description of the source installation topology is: ORACLE_HOME/owsm/config/topology/topology.properties. The following table is a partial list of properties in this file. Verify the values for these properties and change them, as necessary, so that they are appropriate for the destination machine. For example, if the source and destination installations are on different machines, at a minimum, you will have to change the host names and ports for the components.

If the database on the destination installation is different than the source installation, the edit the database properties in the file. Enter the database password for the database.password property in clear text, then use the wsmadmin encodePassword command to encrypt the password.

In addition, you will find additional properties from the component configuration files are added to the topology.properties file, depending on the particular components, policy enforcement points, and policies in your destination installation. For example, you may find the following categories of properties:

• Oracle WSM Gateway Context URL Property

• Web Service WSDL Property

• Policy Enforcement Point Properties

• Component Configuration Properties

• Policy Pipeline Step Properties

Oracle WSM Gateway Context URL Property The following property defines the context URL for each Oracle WSM Gateway:

component–component_ID.contextUrl=url

where:

• component – Name of the component

• component_ID – ID of the component

• url – URL to the Oracle WSM Gateway

For example,

gateway-C0003001.contextUrl=http://10.178.95.103:80/gateway

Web Service WSDL Property Each Web Service WSDL is defined with the following property:

component_name–component_ID.service–service_ID.wsdl_url=url

where:

• component_name – Name of the component, for example, gateway

• component_ID – ID of the component

• service_ID – ID of the Web service

• url – URL for the Web service endpoint

For example:

gateway-C0003001.service-SID0003001.wsdl_url=http://10.178.95.103:80/ccore/TimeService.wsdl
gateway-C0003001.service-SID0003002.wsdl_url=http://10.178.95.103:80/6149927_Client-HelloWorld_WS-context-root/MyWebService1Soap12HttpPort?WSDL
gateway-C0003001.service-SID0003003.wsdl_url=http://10.178.95.103:80/CDIServicesWS/CDIServicesWSSoapHttpPort?WSDL

Policy Enforcement Point Properties Each Oracle WSM component has a set of default properties. These properties are defined with the following syntax:

default.property=value

• property – property name

• value – value assigned to the property

where:

default.cfluent.messagelog.enabled=true
default.cfluent.messagelog.type=db
default.cfluent.messagelog.file.maxFileSize=5000000
default.cfluent.messagelog.db.url=${database.url}
default.cfluent.messagelog.db.driver=${database.driver}
default.cfluent.messagelog.db.userid=${database.userid}
default.cfluent.messagelog.db.password=${database.password}
...

These default settings cannot be changed once the Oracle WSM installation is cloned. Therefore, if you want to change the defaults, you must make any changes to these properties in the topology.properties file.

Component Configuration Properties There is a set of properties that specify the configuration for each policy enforcement point with the following syntax:

pep–component_ID–vversion–property=value

where:

• component_ID – Component ID

• version – Version of the component

• property – Name of the component property

• value – Value assigned to the property

pep-C0003003-v26-cfluent.messagelog.enabled=true
pep-C0003003-v26-cfluent.messagelog.type=db
pep-C0003003-v26-cfluent.messagelog.file.logDirectory=
pep-C0003003-v26-cfluent.messagelog.file.maxFileSize=5000000
pep-C0003003-v26-cfluent.messagelog.db.url=${database.url}
pep-C0003003-v26-cfluent.messagelog.db.driver=${database.driver}
pep-C0003003-v26-cfluent.messagelog.db.userid=${database.userid}
...
pep-C0003002-v58-cfluent.messagelog.enabled=true

Policy Pipeline Step Properties A comment identifies the type of policy step. This is followed by a series of properties describing the configuration of the policy step:

pep–component_ID–policy_version–service_name (service_version)–pipeline_type.stepstep_number.property= value

where:

• component_ID – ID of the pipeline

• policy_version – Version number of the policy

• service_name – Name of the Web service

• service_version – Version of the Web service

• pipeline_type – Specifies the pipeline to which the policy step belongs. Valid values are Request or Response.

• step_number – ID of the step

• property – Name of the property

• value – Value assigned to the property

#pipeline3047.step0.implementation=com.cfluent.policysteps.common.LoggerStep
pep-C0003002-v3-OpenTradeService(1.0)-Response.step0.Enabled=true
pep-C0003002-v3-OpenTradeService(1.0)-Response.step0.LogLevel=envelope
#pipeline3049.step0.implementation=com.cfluent.policysteps.common.LoggerStep
pep-C0003002-v3-OpenTradeService(1.0)-Request.step0.Enabled=true
pep-C0003002-v3-OpenTradeService(1.0)-Request.step0.LogLevel=envelope
#pipeline3049.step1.implementation=com.cfluent.policysteps.security.wssecurity.SignStep
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.Enabled=false
#pipeline3049.step1.implementation=com.cfluent.policysteps.security.wssecurity.SignStep
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.Enabled=false
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.KeyStoreFile=/my/keystore/location
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.KeyStoreType=jks
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.KeyStorePassword=????BUUpfArOY7Dqr32ZiBi0f9A=
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.SignerKeyAlias=alias
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.SignerKeyPassword=????BSp5xQ0leeFHs3CvuBTlcng/EqyYAv72kA==
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.SignatureAlgorithm=RSA-SHA1
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.SignedContent=BODY
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.XpathExpression=
pep-C0003002-v3-OpenTradeService(1.0)-Request.step1.NameSpaces=vt

Related Commands

inspectTopology

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:

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\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:

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:

dataload

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

Syntax

wsmadmin dataload

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:

You will be prompted to provide a password to Oracle WSM Database. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

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:

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 component

Parameters

• 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" .

You will be prompted to provide a password to Oracle Application Server. Use the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

If you are using Oracle Process Manager and Notification Server (OPMN) to manage Oracle WSM and you deploy Oracle WSM Policy Manager, then you must restart the OPMN process on the OC4J instance where the Oracle WSM components are installed. If you do not restart OPMN, you will get an error when you try to log in to Web Services Manager Control.

deployApps

This operation deploys components to an OC4J application engine.

Syntax

wsmadmin deployApps component

Parameters

• 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:

You will be prompted to provide a password to Oracle Application Server. Use the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

If you are using Oracle Process Manager and Notification Server (OPMN) to manage Oracle WSM and you deploy Oracle WSM Policy Manager, then you must restart the OPMN process on the OC4J instance where the Oracle WSM components are installed. If you do not restart OPMN, you will get an error when you try to log in to Web Services Manager Control.

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

Usage

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.

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

You will be prompted to provide a password to Oracle WSM Database. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

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.

exportPolicySet

This operation exports policies associated with a component.

Syntax

wsmadmin exportPolicySet component_ID

• component_ID – the component ID of the Oracle Web Services Gateway or Agent whose policies are being exported.

Usage

• The command packages the policies with the policy enforcement point so that the Oracle WSM Gateway or Agent does not have to communicate with Oracle WSM Policy Manager to get the policies.

• The Oracle WSM instance must be up and running when this command is executed.

• Before you use the exportPolicy command, you must add several properties to the ORACLE_HOME/owsm/bin/coresv.properties file.

  Table C-9 coresv.properties Used with exportPolicySet

  Property	Description
  pm.server.httpScheme	Transport on which Policy Manager is running. The valid values are http and https.
  pm.server.httpHost	Name of the host on which Policy Manager is running
  pm.server.httpPort	Port on which Policy Manager listens for requests.

  
  

• The policy is exported to the directory defined by the db.export.dir property which is set in the ORACLE_HOME/owsm/bin/coresv.properties file. The name of the file is generated dynamically as PolicySet–component_ID–timestamp.xml. The variable, component_ID is the component ID specified in the wsmadmin exportPolicySet command. The timestamp of the export is appended to the file name to further identify the exported policy.

exportTransferableObjects

This operation exports selected Oracle WSM objects.

Syntax

wsmadmin exportTransferableObjects

Usage Notes

• The wsmadmin exportTransferableObjects command uses the ORACLE_HOME\scripts\LMTInstructions.xml file and exports the Oracle WSM objects specified in the file.

• You must specify the ID of the components, services, and custom step templates that you want to export in the LMTInstructions.xml file. In addition, you must specify the version of the step template being exported. See Chapter 10, "Oracle WSM Cloning and Horizontal Migation," in Oracle Web Services Manager Administrator's Guide for an example of the input file.

• Set the db.export.dir property in ORACLE_HOME\owsm\bin\coresv.properties file to the directory where you want the components exported.

Related Commands

importTransferableObjects

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

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:

You will be prompted to provide a password to Oracle WSM Database. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

importTransferableObjects

Imports Oracle WSM objects.

Syntax

wsmadmin importTransferableObjects

Usage

• The command uses the information in the LMTInstructions.xml file and imports the specified components, services, policies, and custom templates with the attributes specified in the file.

• Any imported Oracle WSM components, services, and step templates are assigned the next available ID on the destination machine.

LMTInstructions.xml File

The LMTInstructions.xml file must be in the ORACLE_HOME/scripts directory on the destination machine.

Component Attributes You must specify attributes for each component being imported. The following is an example of a < component> tag and its attributes.

<component id="C0003029"
     import-name="ImportedGateway16Jan"
     url="http://jdoe-pc.abc.oracle.com:7780/gateway"
     monitor-rmi-host="localhost"
     monitor-rmi-port="3118"
     monitor-soap="http://localhost:7780/coreman/services/CoremanClient"
     monitor-type="rmi"
     database-url="jdbc:oracle:thin:@//10.177.34.170:1521/orcl.abc.oracle.com"
     database-driver="oracle.jdbc.driver.OracleDriver"
     database-user-id="ORAWSM"
     database-user-password="????BXbXX/cf08QHKYYAb6v4o/bb2r37tTw4Tw==" 
     create-new="false"
     type="Gateway"
     mapped-to-component-id="C0003029">
...
</component>

Table C-11 describes the attributes that must be specified.

Service Attributes You must specify attributes for each Web service being imported. The <service> tag is a child tag of the <component> tag. A <component> tag may have multiple <service> tags. The following is an example of the <service> tag and attributes.

<component id="C0003029" 
...
     <service id="SID0003268"
               import-name="TimeService16Jan1" 
               version="1.0"
               wsdl="http://jdoe-pc.abc.oracle.com:7780/ccore/TimeService.wsdl" 
               url="http://jdoe-pc.abc.oracle.com:7780/ccore/TimeService.jsp">
          <pipeline-property pipeline-name="Service" step="0"  prop-name="ReplyTimeout" prop-value="300000"/>
          <pipeline-property pipeline-name="Request" step="0" prop-name="LDAPHost" prop-value="localhost"/>
    </service>
...
</component>

Table C-12 describes the attributes that must be specified for each service being exported.

Property Values When you import a service to the destination machine, you may want to change some of the properties. For example, the name of the LDAP Host on the destination installation may differ from the source installation, and, therefore, you need to change the value assigned to the LDAPHost property. Or you may want to change the time out value. When you import the component, you can specify the property and the new value using the <pipeline-property> tag. The <pipeline-property> tag is a child of the <service> tag. Table C-13 describes the pipeline-property attributes.

Custom Template Attributes The <step-template> tag is a child of the <component> tag. When you import a step template into the destination Oracle Web Services Manager instance, you must assign an ID, name, and version number to the step template. The step template ID and name must be unique in the destination Oracle Web Services Manager instance. The following is an example of the <step-template> tag.

<component id="C0003030" 
...
     <step-template id="891B611A-0F24-85DD-3C27-8B56B5F7G4F21248" 
          version="1.0"
          import-id="891B611A-0F24-85DD-3C27-8B56B5F7G4F21249"
          import-name="Custom JMS Header step - XXXXXX"
          import-version="1.0"
     </step-template>
</component>

Table C-14 describes the attributes that must be specified for the <step-template> tag.

Related Commands

exportTransferableObjects

inspectTopology

This operation inspects an Oracle WSM installation.

Syntax

wsmadmin inspectTopology -D inspect.level=inspect_level_value

Parameters

• inspect_level_value – 0 (the default) inspects only the latest version of a policy, and 1 inspects all versions of a policy. The result of this inspection is recorded in the topology.properties file.

Usage Notes

• This command generates a file that describes the topology of the Oracle WSM installation, and expports the Oracle WSM data from the Oracle Database.

• The generated file describing the topology is ORACLE_HOME/owsm/config/topology/topology.properties.

• By default, only the most current version of each policy is inspected and described in the topology.properties file. To inspect earlier policy versions, use the -Dinspect.level parameter. By default, this is set to 0 to inspect only the current version. If you set it to 1, all version are inspected. Policies that are described in the topology.properties file can be configured for the destination installation. When policies are imported to the destination installation, they are imported with the configuration specified in the topology.properties file.

  The -Dinspect.level parameter only specifies which policies are described in the topology.properties file. Regardless of this setting, all policy versions are exported from the source installation and imported to the destination installation. Policies that are not described in the topology.properties file, are imported with the configuration for the source installation. Once the cloning process is completed, you can use Web Services Manager Control to view and make changes to any of the policies.

• The wsmadmin inspectTopology command exports the Oracle Database tables to the following location on the source installation:

  • ORACLE_HOME/owsm/config/topology/export – Each database table is exported to an XML file in this directory.

  • ORACLE_HOME/owsm/config/topology/template – Several tables require some reformatting in order to be correctly imported into the destination database. The reformatted tables are in this directory.

• If you need to make any changes to the data in the database tables before it is imported into the destination installation, Oracle recommends that you copy the XML file from the ORACLE_HOME/owsm/config/topology/export directory to the ORACLE_HOME/owsm/config/topology/template directory, and make any changes to the copied file.

• During the cloning process, any files in the ORACLE_HOME/owsm/config/topology/template directory override the files in the ORACLE_HOME/owsm/config/topology/export directory.

Related Commands

applyTopology

initialize

This operation initializes the primary database.

Syntax

wsmadmin initialize

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:

You will be prompted to provide a password to Oracle WSM Database. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

install

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

Syntax

wsmadmin install

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

You will be prompted to provide passwords to Oracle WSM Database and Oracle Application Server. For the application server password, provide the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

installAgent

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

Syntax

wsmadmin installAgent

Usage

The installAgent operation requires the following attribute from the agent.properties file:

You will be prompted to provide a password to Oracle Application Server. Use the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

installOC4J

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

Syntax

wsmadmin installOC4J

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.

You will be prompted to provide a password to Oracle Application Server. Use the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

installOLite

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

Syntax

wsmadmin installOLite

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

You will be prompted to provide a password for the system user for the Oracle WSM Database (orawsm) instance. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

manageUsergroups

Use this operation to manage user groups in the database.

Syntax

wsmadmin manageUserGroups parameter

Parameters

• 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.

You will be prompted to provide a password to Oracle WSM Database. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

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 htpasswdfile username

Parameters

• htpasswdfile – Name of the file containing the user name and password

• username – User name in the text file

Usage

Run the md5encode command for each user name and password. You will be prompted to enter the password for the user specified at the command line. 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 the Oracle WSM 10.1.2 properties and database settings to Oracle WSM 10.1.3.1.0.

Syntax

wsmadmin migrate OWSM_10.1.2_dir

Parameters

• OWSM_10.1.2_dir – Directory where Oracle WSM 10.1.2 is installed

Usage

You will be prompted to provide passwords to Oracle WSM Database and Oracle Application Server. For the application server password, provide the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

For more information about the wsmadmin migrate command, see Oracle Web Services Manager Upgrade Guide.

purgePolicies

This operation deletes old versions of policies from Oracle WSM Policy Manager.

Syntax

wsmadmin purgePolicies component_ID policy_version

• component_ID – ID of the Web Services Manager Agent or Gateway

• policy_version – Version number of the policy. All older versions of policies (policies whose version number is less than policy_version) are purged.

Usage Notes

• If the version number specified with policy_version is greater than the current active policy, then all policies except the current active policy are purged. For example, if the current active policy has a version number of 5, and the wsmadmin purgePolicies is executed with policy_version set to 6, then versions 1 through 4 are purged. Version 5 is not purged and remains as the active policy.

• Policy version numbers are positive numbers. If a negative number is specified for the policy_version, no policies are purged.

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:

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:

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

Usage

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

You will be prompted to provide a password to Oracle Application Server. Use the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

The stop operation combines the operations stopOC4J and stopOLite.

stopOC4J

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

Syntax

wsmadmin stopOC4J

Usage

You will be prompted to provide a password to Oracle Application Server. Use the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

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 component

Parameters

• 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:

You will be prompted to provide a password to Oracle Application Server. Use the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

uninstall

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

Syntax

wsmadmin uninstall

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:

1. Runs uninstallOC4J. If you do not supply the password, OC4J is not uninstalled. You need to uninstall OC4J manually.

2. Runs uninstallOLite

3. Deletes configuration files

You will be prompted to provide a password to Oracle Application Server. Use the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

uninstallOC4J

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

Syntax

wsmadmin uninstallOC4J

Usage

This operation performs the functions of the following operations:

• undeployAll

• stopOC4J

You will be prompted to provide a password to Oracle Application Server. Use the OC4J system administrator password. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

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_type

Parameters

• database_type – Must be oracle, since this version of Oracle WSM only supports the Oracle database

Usage

You will be prompted to provide a password to Oracle WSM Database. For alternate ways to provide WSMADMIN passwords, see "Passwords for WSMADMIN Commands".

This version of Oracle WSM only supports the Oracle database.