The wsadmin scripting tool for managing process applications

The WebSphere® administrative (wsadmin) scripting program is a powerful, non-graphical command interpreter environment that you can use to run administrative operations in a scripting language. You can use the wsadmin tool in connected mode to install, manage, and undeploy snapshots.

In a network deployment environment, an application cluster member runs the Process Server and Process Center applications. Therefore, you must run these wsadmin commands on the node that contains that application cluster member. Do not run the commands from the deployment manager profile.

Not all commands can be used on both the Process Center server and process servers. Use the table below to determine which commands can be used on each type of server. See the related links at the end of the topic for more information on each command.

Table 1. wsadmin commands for managing process applications
Command	Description	Available for Process Center server or a process server?
Commands for installing and undeploying snapshots (connected and offline servers)
BPMInstall	Installs a snapshot on a connected process server.	Process Center server only
BPMUndeploy	Undeploys a process application snapshot from a process server. If the snapshot is active, this command stops the snapshot and allows all processing to complete before removing the snapshot.	Process Center server only
BPMCreateOfflinePackage	Use this set of commands to create an installation package for a snapshot, extract it to a .zip file on a local file system, and install the package on an offline process server.	Process Center server only
BPMExtractOfflinePackage		Process Center server only
BPMInstallOfflinePackage		Offline process server only
Commands for viewing process applications and artifacts
BPMListProcessApplications	Lists all process application snapshots on a given server.	Process Center server and any running process server instance
BPMShowProcessApplication	Lists information about a process application on a given server.	Process Center server and any running process server instance
BPMListServers	Lists all process server instances that are federated into the Process Center server.	Process Center server only
BPMShowServer	Lists information about a specific server.	Process Center server and any running process server instance
BPMShowSnapshot	Lists information about a process application or toolkit snapshot on a given server.	Process Center server and any running process server instance
Commands for administering snapshots
BPMActivate	Activates a snapshot on a server.	Process Center server and any running process server instance
BPMDeactivate	Deactivates a snapshot that is running on a server.	Process Center server and any running process server instance
BPMStop	Stops a snapshot that is running on the Process Center server or that is deactivated on a process server.	Any running process server instance
Commands for exporting and importing
BPMExport	Exports a process application snapshot to a .twx file so that it can be imported on another Process Center server.	Process Center server only
BPMImport	Imports a process application snapshot that has been exported from another Process Center server.	Process Center server only

These commands require administrative access; the user ID must belong to either the tw_admins or tw_authors group. See "Managing default users and groups" in the related links section of this topic.

Connection types

All wsadmin commands for managing process applications must be run in connected mode and the server must be running. Use the -contype argument to indicate what connection type you want to use (SOAP or RMI).

Important: In a network deployment environment, use the port configured for the application cluster member that runs the Process Server or Process Center applications. To determine the correct port number, see the WebSphere administrative console Ports collection page (click Servers > Server Types > WebSphere application servers > server_name > Communications > Ports). The values for SOAP_CONNECTOR_ADDRESS and BOOTSTRAP_ADDRESS indicate the SOAP and RMI port numbers.

See

Using the wsadmin scripting tool in the WebSphere Application Server Information Center for detailed instructions.

Example

In the following syntax example, ProcessCenterServer01.mycompany.com is the name of the host in the wsadmin.properties file that is specified by the com.ibm.ws.scripting.port property. Make sure to substitute your own port, host name, user name, and password when creating a connection.

wsadmin -conntype SOAP -port 4080 -host ProcessCenterServer01.mycompany.com -user admin -password admin