IBM Business Process Manager, V8.0.1, All platforms > Reference > Commands and scripts

Commands (wsadmin scripting)

Look up a scripting object or command class to find details about its command syntax.

To open the information center table of contents to the location of this reference information, click the Show in Table of Contents button (

) on your information center border.

If you are using a SOAP connection, a command can take longer to complete than the specified SOAP timeout value. Although the command continues to run until it is finished, you might see the exception...

java.net.SocketTimeoutException: Read timed out

To prevent this exception, set a higher value for the property....

com.ibm.SOAP.requestTimeout

...in the file....

profile_root/properties/soap.client.props

Some wsadmin commands return multiple lines of information. If you are using jython and the command output is not formatted appropriately, add the print statement before the command.

print AdminTask.BPMShowSnapshot('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main]')

Many of the command reference pages contain examples. Because these are examples, they often show the use of explicit values for things like user names, passwords, and server names. Use the appropriate values for your environment when running these commands.

See

• addNodetoDeploymentEnvDef
  Add a node to an existing deployment environment definition.

• addSCMConnectivityProvider
  Add a SCM connectivity provider.

• BPMActivate
  Activate a process application snapshot on the Process Center server or Process Server.

• BPMSecurityUnlock
  Unlock an application cluster member during server startup.

• BPMCheckOrphanTokens
  Detect the possibility of orphaned tokens before installing a new snapshot and identify whether to delete or move each token.

• BPMCreateOfflinePackage
  Create an installation package for a process application snapshot on the Process Center server.

• BPMDeactivate
  Deactivate a running process application snapshot on the Process Center server or a Process Server.

• BPMDeleteSnapshot
  Run against a server instance to delete process application snapshots and their dependencies. For example, you may want to run the command if an excessive number of snapshots is causing your system to slow down.

• BPMExport
  Export a process application snapshot from Process Center.

• BPMImport
  Import a process application into the Process Center.

• BPMInstall
  Install a process application snapshot from a Process Center to a Process Server in a test or production environment.

• BPMInstallOfflinePackage
  Install a process application snapshot from a Process Center to an offline process server that is not currently connected to the Process Center.

• BPMExtractOfflinePackage
  Extract the process application snapshot installation package from Process Center.

• BPMListProcessApplications
  List all process applications and toolkits on a Process Center server or Process Server.

• BPMListServers
  List all of the Process Server instances that are federated into the Process Center.

• BPMProcessInstancesCleanup
  Delete business process definition (BPD) instance data for a process application snapshot on IBM Process Server.

• BPMShowProcessApplication
  List information about a process application on a Process Center or a Process Server.

• BPMShowServer
  List information for a federated Process Server instance in a Process Center.

• BPMShowSnapshot
  List information about a process application or toolkit snapshot, or information about the tip if you are not working with a snapshot.

• BPMStop
  Stop a process application snapshot that has already been deactivated on a process server. It is available only for snapshots that have Advanced Integration Services.

• BPMUndeploy
  Undeploy a process application snapshot from a server. It is available only if the snapshot contains Advanced Integration Services and has a corresponding business level application (BLA) deployed on the server.

• configEventServiceDB2DB
  Configure the Common Event Infrastructure using a DB2 database.

• configEventServiceDB2ZOSDB
  Configure the Common Event Infrastructure using a DB2 for z/OS database.

• configEventServiceOracleDB
  Configure the Common Event Infrastructure using an Oracle database.

• configEventServiceSQLServerDB
  Configure the Common Event Infrastructure (CEI) using a SQL Server database.

• configRecoveryForCluster
  Specify a cluster, that you have configured to support Service Component Architecture, to manage failed events.

• configRecoveryForServer
  Specify a server, that you have configured to support Service Component Architecture, to manage failed events.

• configSCAAsyncForCluster
  Configure a cluster to run SCA applications. You can specify a number of commands in a file to batch a large number of configurations without having to navigate the administrative console panels.

• configSCAAsyncForServer
  Configure a specific server to run SCA applications. You can specify a number of commands in a file to batch a large number of configurations without having to navigate the administrative console panels.

• configSCAAsyncRetryCount
  Change asynchronous retry counts at run time.

• configSCAJMSForCluster
  Configure a cluster to run SCA applications that use JMS resources. You can specify a number of commands in a file to batch a large number of configurations without having to navigate the administrative console panels.

• configSCAJMSForServer
  Configure a specific server to run SCA applications that use JMS resources. You can specify a number of commands in a file to batch a large number of configurations without having to navigate the administrative console panels.

• configureBPMProcessPortal
  Configure Process Portal.

• configureBusinessSpace
  Configure the Business Space database.

• configureLotusWebformServer
  Configure Business Space to use IBM Forms Server and the Webform Server component. IBM Forms Server works with Human Task Management widgets.

• configureProcessServer
  Configure a server or cluster as a Process Server.

• configureProcessCenter
  Configure a server or cluster as a Process Center.

• configurePerfDW
  Configure Performance Data Warehouse on a server of cluster.

• ConsolidateJAASAuthAliases.py script
  Consolidate the JAAS authentication aliases, which are used for database access. These aliases are defined by the augmentation process or are defined when a deployment environment is created.

• createDB2.sh script
  Create your IBM Business Process Manager database objects in a DB2 for z/OS subsystem. You can run the script from UNIX System Services.

• createDeploymentEnvDef
  Specify a new deployment environment definition (with a specific name) for a particular feature and pattern. The XML document that results from running this command provides the definition of the deployment environment.

• createVersionedSCAModule
  Create a unique instance of an SCA module EAR file. The SCA module must have the sca.module.attributes file as part of its content. The sca.module.attributes file exists for all versioned SCA modules before IBM Business Process Manager Advanced Version 8.0 and for all modules created with Integration Designer Version 8.0.

• createWSRRDefinition
  Create a WSRR definition.

• createWXSDefinition
  Create a WebSphere eXtreme Scale definition.

• dbUtility.py administrative script
  Check for and repair problems in the Business Process Choreographer database.

• Ddl2Pds.sh script
  Copy your database configuration scripts from the UNIX System Services environment into a z/OS PDS. The script optionally converts the database scripts from ASCII to EBCDIC format. The database scripts must have a .ddl or a .sql suffix.

• Sample DB2 for z/OS commands and SQL
  Create the DB2 for z/OS databases and storage groups after configuring the stand-alone server or deployment manager.

• deleteDeploymentEnvDef
  Delete an existing deployment environment definition on the deployment manager.

• deleteSCADestinations.jacl script
  Remove SCA destinations associated with a particular module.

• deleteWSRRDefinition
  Delete a WSRR definition that has been named or supplied as a target object.

• deleteWXSDefinition
  Delete a WebSphere eXtreme Scale(eXtreme Scale) definition that has been named.

• deployEventService
  Deploy the event service application onto your server.

• deployEventServiceMdb
  Deploy the event service message driven bean onto your server.

• disableEventService
  Disable the event service on your server.

• enableEventService
  Enable the event service on your server.

• exportBusinessRuleArtifacts.jacl script
  Export business rules and selector components to a compressed file using a command line.

• exportDeploymentEnvDef
  Export topologies from the deployment manager.

• generateDeploymentEnv
  Configure deployment environments on a deployment manager.

• getBusinessSpaceDeployStatus
  Check whether the Business Space component is configured on a particular deployment target.

• getDefaultWSRRDefinition
  Return the current default WSRR definition. If no default is set (this should only happen if there are no WSRR definitions), then it will return null.

• getBPMTargetSignificance
  Discover the target significance on all the resources for a given deployment target. The deployment target can be either a server or cluster.

• getDefaultWXSDefinition
  Return the current default WebSphere eXtreme Scale definition. If no default is set (that is, when there are no eXtreme Scale definitions), then the command will return null.

• importBusinessRuleArtifacts.jacl script
  Import business rule artifacts from a compressed file using a command line.

• importDeploymentEnvDef
  Import topologies into the deployment manager.

• importSelectorArtifacts.jacl script
  Import selector artifacts from a compressed file using a command line.

• installBusinessSpace
  Set up the Business Space component on your IBM Business Process Manager environment.

• installBusinessSpaceWidgets
  Install, deploy and register widgets for use with the Business Space component.

• installHumanTaskManagementWidgets
  Install the human task management widgets application on an IBM BPM Standard or IBM BPM Advanced server or cluster.

• isDefaultWSRRDefinition
  Return true or false, depending on whether the specified WSRR definition is the current cell default.

• isDefaultWXSDefinition
  Return true or false, depending on whether the specified WebSphere eXtreme Scale definition is the current cell default.

• listBPMApiFederationDomains
  List all federation domains for your environment.

• listSCAExports
  List the exports of a SCA module.

• listSCAImports
  List the imports of a SCA module.

• listSCAModules
  List the SCA modules deployed to a cell.

• listSCMConnectivityProviders
  Return a list of all the parameters for a SCM connectivity providers that exist in the cell.

• listWSRRDefinitions
  Return a list of all the WSRR definitions that exist in the cell.

• listWXSDefinitions
  Return a list of all the WebSphere eXtreme Scale definitions that exist in the cell.

• modifyBPMApiFederationDomain
  Add or remove targets from a federation domain using the addTarget and deleteTarget steps.

• modifySCAExportHttpBinding
  Change the attributes of an HTTP export binding.

• modifySCAExportJMSBinding
  Change the attributes of a JMS export binding. This command applies to JMS bindings, WebSphere MQ JMS bindings, or Generic JMS bindings.

• modifySCAExportMQBinding
  Change the attributes of a WebSphere MQ export binding.

• modifySCAImportEJBBinding
  Modify the attributes of an EJB import binding.

• modifySCAImportHttpBinding
  Change the attributes of an HTTP import binding.

• modifySCAImportJMSBinding
  Change the attributes of a JMS import binding. This applies to JMS bindings, WebSphere MQ JMS bindings, or Generic JMS bindings.

• modifySCAImportMQBinding
  Change the attributes of a WebSphere MQ import binding.

• modifySCAImportSCABinding
  Change attributes of SCA import bindings.

• modifySCAImportWSBinding
  Change the attributes of a web service import binding.

• modifySCAModuleProperty
  Modify the property values for a specified SCA module.

• modifySCMConnectivityProvider
  Modify the details of a SCM connectivity provider.

• modifyWSRRDefinition
  Modify the details of a definition, given its name.

• modifyWXSDefinition
  Modify the details of a WebSphere eXtreme Scale definition, dependent on how the object that is being modified is identified.

• moveBPCExplorer
  Move the Business Process Choreographer Explorer from one deployment target to another deployment target.

• moveBRManager
  Move the Business Process Rules Manager from one deployment target to another deployment target.

• moveCEIServer
  Move the Common Event Infrastructure (CEI) server from one deployment target to another deployment target.

• registerRESTServiceEndpoint
  Register configured and enabled REST endpoints so that your team can use IBM Business Process Manager widgets.

• removeEventService
  Remove the event service application from your server.

• removeEventServiceDB2DB
  Remove the event service and, optionally, the associated DB2 event database.

• removeEventServiceDB2ZOSDB
  Remove the event service and, optionally, the associated DB2 for z/OS event database.

• removeEventServiceMdb
  Remove the event service message driven bean from your server.

• removeEventServiceOracleDB
  Remove the event service and, optionally, the associated Oracle event database.

• removeEventServiceSQLServerDB
  Remove the event service and, optionally, the associated SQL Server event database.

• removeNodeFromDeploymentEnvDef
  Remove a node from the existing deployment environment definition.

• removeSCMConnectivityProvider
  Remove a SCM connectivity provider.

• renameDeploymentEnvDef
  Rename a deployment environment definition.

• renameNodeInDeploymentEnvDef
  Rename a node across all roles in an existing deployment environment definition.

• setBPMTargetSignificance
  Set the target significance for all the outbound activation specification and outbound connection factories configured on the given cluster or server.

• setEventServiceJmsAuthAlias
  Set or update the JMS authentication alias associated with the event service on your server.

• setWSRRDefinitionAsDefault
  Set the named WSRR definition to be the default one.

• setWXSDefinitionAsDefault
  Set the named WebSphere eXtreme Scale definition to be the default.

• showDeploymentEnvStatus
  Display the current status of the deployment environment.

• showEventServiceStatus
  Display the event service status on your server.

• showSCAExport
  Display the attributes of a SCA module export.

• showSCAExportBinding
  Display the attributes of SCA module export bindings.

• showSCAExportEJBBinding
  Show the attributes of an EJB export binding.

• showSCAExportHttpBinding
  Show the attributes of an HTTP export binding.

• showSCAExportJMSBinding
  Show the attributes of a JMS export binding. This applies to JMS bindings, WebSphere MQ JMS bindings, or Generic JMS bindings.

• showSCAExportMQBinding
  Show the attributes of a WebSphere MQ export binding.

• showSCAExportWSBinding
  Show the attributes of a web service export binding.

• showSCAImport
  Display the attributes of a SCA module import.

• showSCAImportBinding
  Display the attributes of SCA module import bindings.

• showSCAImportEJBBinding
  Show the attributes of an EJB import binding.

• showSCAImportHttpBinding
  Show the attributes of an HTTP import binding.

• showSCAImportJMSBinding
  Show the attributes of a JMS import binding. Applies to JMS, WebSphere MQ JMS, or Generic JMS bindings.

• showSCAImportMQBinding
  Show the attributes of a WebSphere MQ import binding.

• showSCAImportWSBinding
  Show the attributes of a web service import binding.

• showSCAModule
  Display the attributes of a SCA module.

• showSCAModuleProperties
  Display the properties of a SCA module.

• showSCMConnectivityProvider
  Return a list of all the parameters for a SCM connectivity provider.

• showWSRRDefinition
  Return a list of all the parameters for a WSRR definition, including the type of the connection and whether the definition is the default.

• showWXSDefinition
  Return a list of all the parameters for a WebSphere eXtreme Scale definition.

• startDeploymentEnv
  Start the deployment environment.

• stopDeploymentEnv
  Stop the deployment environment.

• uninstallBusinessSpaceWidgets
  Remove widgets and widget definitions from the profile, including removing individual widget assets (application, catalog, endpoints, spaces, templates, help).

• updateBusinessSpaceWidgets
  Update previously configured widgets and their endpoints, catalogs, templates, and help plugins.

• updateEndpointBindingsOnPortal
  Create endpoint references on the WebSphere Portal application server so

• updateRESTGatewayService
  Update a REST gateway service so that REST services are configured and enabled.

• validateDeploymentEnvDef
  Determine whether you have met all the constraints for a deployment environment.

• validateSCAImportExportInformation
  Validate import and export information associated with an SCA module. It takes an EAR file as input and validates that all expected exports exist on the bus.

Parent topic: Commands and scripts