Commands (wsadmin scripting)
Look up a scripting object or command class to find details about its command syntax.
Tip: Read the following tips before
using the topics and the commands.
- 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 com.ibm.SOAP.requestTimeout property in the profile_root/properties/soap.client.props file.
- 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, as shown in the following example.
print AdminTask.BPMShowSnapshot('[-containerAcronym BILLDISP -containerSnapshotAcronym SS2.0.1 -containerTrackAcronym Main]') - Use the following command to get detailed help on a particular
command:
print AdminTask.help('command_name') - 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. Be sure to use the appropriate values for your environment when running these commands.
- If you are not connecting to the default profile, use the -profileName profile_name option.
- After running the command, save your changes to the master configuration using AdminConfig.save().
- addBPMSystem command
Use the addBPMSystem command to add an IBM® Business Process Manager system with a Business Process Execution Language (BPEL) or business process definition (BPD) engine to the local IBM Business Process Manager federated API. - addSCMConnectivityProvider command
Use the addSCMConnectivityProvider command to add a Service Connectivity Management (SCM) connectivity provider. - BPMActivate command
This command activates a process application snapshot on the Process Center server or Process Server. - BPMArchive command
This command archives a process application snapshot on the Process Center server. - BPMArchiveProcessApplication command
This command archives a deactivated process application from the Process Center server. - BPMArchiveToolkit command
This command archives a deactivated toolkit from the Process Center server. - BPMCheckOrphanTokens command
Use the BPMCheckOrphanTokens command to detect the possibility of orphaned tokens before installing a new snapshot and identify whether to delete or move each token. - BPMClearWSICache command
Use this command in Process Server to clear the web service integration cache of WSDL and XSD definitions when the WSDL of the web service provider changes during the lifecycle of the server or cluster. The server or cluster is the deployment target of the web service integration. - BPMCreateOfflinePackage command
Use this command to create an installation package for a process application snapshot on the Process Center server. You cannot use the BPMCreateOfflinePackage command to set the migration plan. - BPMDeactivate command
This command deactivates an active snapshot. - BPMDeleteDurableMessages command
The BPMDeleteDurableMessages command deletes old durable subscription messages from the LSW_DUR_MSG_RECEIVED database table. - BPMDeleteSnapshot command
This command is run against a server instance to delete snapshots for process applications or toolkits. For example, you may want to run the command if an excessive number of snapshots is causing your system to slow down. - BPMExport command
This command exports a process application or toolkit snapshot as a .twx file that you can import into a Process Center server. - BPMExportInstallPackage command
This command creates a generic install package (.zip file) for a process application or toolkit snapshot. The generic install package is not targeted at any specific process server. - BPMExtractMigrationPolicy command
This command extracts the migration policy from Process Center. - BPMExtractOfflinePackage command
This command extracts the process application snapshot installation package from Process Center. The package is a .zip file that contains a .twx file. - BPMGetSnapshotAcronym command
This command retrieves the snapshot acronym of a snapshot. - BPMGroupMembershipUpdateTask command
Use the BPMGroupMembershipUpdateTask command to update the group membership for the users that you specify on the command line. - BPMImport command
This command imports a process application into the Process Center. - BPMInstall command
This command installs a process application snapshot from a Process Center to a Process Server in a test or production environment. - BPMInstallOfflinePackage command
This command uses a custom installation package to install a process application snapshot from Process Center to an offline process server. - BPMInstallPackage command
This command installs a process application snapshot from Process Center to a process server. - BPMListProcessApplications command
This command lists all process applications and toolkits on a Process Center server or Process Server. - BPMListServers command
This command lists all of the Process Server instances that are federated into the Process Center. - BPMMigrateInstances command
Use the BPMMigrateInstances command to run an instance migration. - BPMProcessInstancesCleanup command
Use this command to delete business process definition (BPD) instance data and associated documents for a process application snapshot on IBM Process Server. - BPMProcessInstancesResumption command
Use this command to resume business process definition (BPD) instances that are in a suspended state on IBM Process Center and IBM Process Server. - BPMRemoveProcessApplication command
This command removes an archived process application and all of its snapshots from the Process Center server. - BPMRemoveToolkit command
This command removes a toolkit and all of its snapshots from the Process Center server. - BPMReplayOnHoldEMTasks command
This command resumes Event Manager tasks that are on hold so that they can be scheduled by the Event Manager again. - BPMSecurityUnlock command
Use the BPMSecurityUnlock command to unlock an application cluster member during server startup. - BPMSetDefaultSnapshot command
Use the BPMSetDefaultSnapshot command to designate a default snapshot on the Process Center server or Process Server. - BPMSetEnvironmentVariable command
Use the BPMSetEnvironmentVariable command to set the value of an environment variable for a specific snapshot. - BPMShowInstallMessages command
This command returns detailed messages from the snapshot installation on a Process Center or a Process Server. - BPMShowProcessApplication command
This command lists information about a process application on a Process Center or a Process Server. - BPMShowServer command
This command lists information for a federated Process Server instance in a Process Center. - BPMShowSnapshot command
This command lists information about a process application or toolkit snapshot, or information about the tip if you are not working with a snapshot. - BPMSnapshotCleanup command
Use the BPMSnapshotCleanup command to delete unnamed and archived snapshots of a process application or toolkit on a Process Center server. - BPMStop command
This command stops a process application snapshot that has already been deactivated on a process server. It is available only for snapshots that have Advanced Integration Services. - BPMSyncEnvironmentVariables command
Use the BPMSyncEnvironmentVariables command to copy environment variables between two snapshots. - BPMSyncEPVValues command
Use the BPMSyncEPVValues command to copy exposed process values between two snapshots. - BPMSyncTeamBindings command
Use the BPMSyncTeamBindings command to copy teams between two snapshots. - BPMTasksCleanup command
Use this command to delete completed tasks from running process instances on IBM Process Server. - BPMUpdateInstallationInformation command
This command associates the generic installation package that is created by the BPMExportInstallPackage with a specific server so that you can install a snapshot onto that server. - BPMUpdateSystemApp command
The BPMUpdateSystemApp command applies interim fixes to toolkits and process apps. This command must only be used if you are directed to use it by IBM Software Support or by the instructions in an interim fix file. Before running the command, read the instructions included with the interim fix. - BPMUndeploy command
This command undeploys 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. - cleanupDocumentStoreEventSubscriptions command
The cleanupDocumentStoreEventSubscriptions command removes subscriptions to events where event subscriptions no longer exist. - cleanupDocumentStoreProperties command
The cleanupDocumentStoreProperties command deletes all properties that are currently specified in the case and document classes for a specific application but are no longer used. (An unused property is one that is no longer referenced in any named snapshot or tip in any branch of a process application or toolkit.) After the properties are removed, the command also removes any unused property templates. - clearBPMEndpointServiceCache command
Use the clearBPMEndpointServiceCache command to reset the endpoint service caches of all running servers, including the endpoint service configuration cache and the endpoint service URL cache. The command can help with problem determination because you can enable endpoint service tracing for a running server and still see where the configuration is read and how the URLs are constructed. - configSCAAsyncRetryCount command
Use the configSCAAsyncRetryCount command to change asynchronous retry counts at run time. - correctDocumentStoreInstanceAuthorization command
Use the correctDocumentStoreInstanceAuthorization command to correct user and group authorizations for case, BPD, and team instances that reside on an external ECM server. - createVersionedSCAModule command
This command creates 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 command
Use the createWSRRDefinition command to create a WSRR definition. - createWXSDefinition command
Use the createWXSDefinition command to create a WebSphere® eXtreme Scale (eXtreme Scale) definition. - deleteBPMProperty command
Use the deleteBPMProperty command to delete an IBM BPM custom property from the configuration repository. For predefined IBM BPM properties, the deleteBPMProperty command only removes any customization and resets the custom property value to the factory default. In stand-alone environments, such as IBM BPM Express and the unit test environment of IBM Integration Designer, the IBM BPM custom property is deleted immediately when you run the command. In network deployment (ND) environments, the IBM BPM custom property is deleted when the next node synchronization occurs. For both stand-alone and ND environments, it is not necessary to restart the server or cluster after running the command. - deleteBPMVirtualHost command
Use the deleteBPMVirtualHost command to delete an IBM BPM virtual host. For both stand-alone and network deployment (ND) environments, it is not necessary to restart the server or cluster after running the deleteBPMVirtualHost command if you also run the clearBPMEndpointServiceCache command. In ND environments, you must wait until node synchronization has completed before you run the clearBPMEndpointServiceCache command. - deleteSCADestinations.jacl script
Use the deleteSCADestinations.jacl script to remove Service Component Architecture (SCA) destinations associated with a particular module. - deleteWSRRDefinition command
Use the deleteWSRRDefinition command to delete a WSRR definition that has been named or supplied as a target object. - deleteWXSDefinition command
Use the deleteWXSDefinition command to delete a WebSphere eXtreme Scale(eXtreme Scale) definition that has been named. - exportBusinessRuleArtifacts.jacl script
Use the exportBusinessRuleArtifacts.jacl script to export business rules and selector components to a compressed file using the command line. - exportWASConfig.py script
Use the exportWASConfig.py script to export WebSphere Application Server configuration, in addition to the configuration exported by the BPMConfig –export or BPMConfig –migrate command. - getBPMDefaultVirtualHost command
Use the getBPMDefaultVirtualHost command to get the IBM BPM default virtual host. - getBPMProperty command
Use the getBPMProperty command to get the value of an IBM BPM custom property from the configuration repository. - getBPMVirtualHost command
Use the getBPMVirtualHost command to display the attributes of an IBM BPM virtual host. - getDefaultWSRRDefinition command
Use the getDefaultWSRRDefinition command to return the current default WSRR definition. If no default is set (only if there are no WSRR definitions), it returns null. - getDocumentStoreStatus command
Use the getDocumentStoreStatus command to return information about the IBM BPM document store in IBM Business Process Manager. The command determines the availability of the IBM BPM document store and returns detailed information about document migrations to the document store. It also returns information about whether the IBM_BPM_DocumentStore application is up-to-date in comparison to the authentication alias and the EAR file version. - getDefaultWXSDefinition command
Use the getDefaultWXSDefinition command to return the current default WebSphere eXtreme Scale (eXtreme Scale) definition. If no default is set (that is, when there are no eXtreme Scale definitions), the command will return null. - importBusinessRuleArtifacts.jacl script
Use the importBusinessRuleArtifacts.jacl script to import business rule artifacts from a compressed file using a command line. - importSelectorArtifacts.jacl script
Use the importSelectorArtifacts.jacl script to import selector artifacts from a compressed file using a command line. - importWASConfig.py script
Use the importWASConfig.py script to import WebSphere Application Server configuration that was exported from the source deployment environment, including data sources, authentication aliases, and Secure Sockets Layer (SSL) settings. - installBusinessSpaceWidgets command
Use the installBusinessSpaceWidgets command to install, deploy and register widgets for use with the Business Space component. - installHumanTaskManagementWidgets command
Use the installHumanTaskManagementWidgets command to install the human task management widgets application on an IBM BPM Standard or IBM BPM Advanced server or cluster. - isDefaultWSRRDefinition command
Use the isDefaultWSRRDefinition command to return true or false, depending on whether the specified WSRR definition is the current cell default. - isDefaultWXSDefinition command
Use the isDefaultWXSDefinition command to return true or false, depending on whether the specified WebSphere eXtreme Scale (eXtreme Scale) definition is the current cell default. - listBPMApiFederationDomains command
Use the listBPMApiFederationDomains command to list all federation domains for your environment. - listSCAExports command
Use the listSCAExports command to list the exports of a Service Component Architecture (SCA) module. - listSCAImports command
Use the listSCAImports command to list the imports of a Service Component Architecture (SCA) module. - listSCAModules command
Use the listSCAModules command to list the SCA modules deployed to a cell. - listSCMConnectivityProviders command
Use the listSCMConnectivityProviders command to return a list of all the parameters for a Service Connectivity Management (SCM) connectivity providers that exist in the cell. - listWSRRDefinitions command
Use the listWSRRDefinitions command to return a list of all the WSRR definitions that exist in the cell. - listWXSDefinitions command
Use the listWXSDefinition command to return a list of all the WebSphere eXtreme Scale (eXtreme Scale) definitions that exist in the cell. - maintainDocumentStoreAuthorization command
Use the maintainDocumentStoreAuthorization command to add or remove users and groups from the authorization role for managing and working with the IBM BPM document store. - maintainDocumentStoreTrace command
Use the maintainDocumentStoreTrace command to enable or disable tracing for an individual component or all components of the IBM BPM document store. - modifyBPMApiFederationDomain command
Use the modifyBPMApiFederationDomain command to add or remove targets from a federation domain using the addTarget and deleteTarget steps. - modifySCAExportHttpBinding command
Use the modifySCAExportHttpBinding command to change the attributes of an HTTP export binding. - modifySCAExportJMSBinding command
Use the modifySCAExportJMSBinding command to change the attributes of a JMS export binding. This command applies to JMS bindings, WebSphere MQ JMS bindings, and Generic JMS bindings. - modifySCAExportMQBinding command
Use the modifySCAExportMQBinding command to change the attributes of a WebSphere MQ export binding. - modifySCAImportEJBBinding command
Use the modifySCAImportEJBBinding command to modify the attributes of an Enterprise JavaBeans (EJB) import binding. - modifySCAImportHttpBinding command
Use the modifySCAImportHttpBinding command to change the attributes of an HTTP import binding. - modifySCAImportJMSBinding command
Use the modifySCAImportJMSBinding command to change the attributes of a JMS import binding. This applies to JMS bindings, WebSphere MQ JMS bindings, and Generic JMS bindings. - modifySCAImportMQBinding command
Use the modifySCAImportMQBinding command to change the attributes of a WebSphere MQ import binding. - modifySCAImportSCABinding command
Use the modifySCAImportSCABinding command to change attributes of Service Component Architecture (SCA) import bindings. - modifySCAImportWSBinding command
Use the modifySCAImportWSBinding command to change the attributes of a web service import binding . - modifySCAModuleProperty command
Use the modifySCAModuleProperty command to modify the property values for a specified Service Component Architecture (SCA) module. - modifySCMConnectivityProvider command
Use the modifySCMConnectivityProvider command to modify the details of a Service Connectivity Management (SCM) connectivity provider. - modifyWSRRDefinition command
Use the modifyWSRRDefinition command to modify the details of a definition, given its name. - modifyWXSDefinition command
Use the modifyWXSDefinition command to modify the details of a WebSphere eXtreme Scale (eXtreme Scale) definition, dependent on how the object that is being modified is identified. - registerBusinessMonitorTarget.py script
The registerBusinessMonitorTarget.py script is a Python script that configures a target connection to a Business Monitor server. - registerRESTServiceEndpoint command
Use the registerRESTServiceEndpoint command to register configured and enabled Representational State Transfer (REST) endpoints so that your team can use IBM Business Process Manager widgets. - removeSCMConnectivityProvider command
Use the removeSCMConnectivityProvider command to remove a Service Connectivity Management (SCM) connectivity provider. - setBPMDefaultVirtualHost command
Use the setBPMDefaultVirtualHost command to set the IBM BPM default virtual host. For both stand-alone and network deployment (ND) environments, it is not necessary to restart the server or cluster after running the setBPMDefaultVirtualHost command if you also run the clearBPMEndpointServiceCache command. In ND environments, you must wait until node synchronization has completed before you run the clearBPMEndpointServiceCache command. - setBPMExternalECM command
Use the setBPMExternalECM command to configure IBM Business Process Manager to use an external Enterprise Content Management server. - setBPMProperty command
Use the setBPMProperty command to set the value of an IBM BPM custom property in the configuration repository. In stand-alone environments, such as IBM BPM Express and the unit test environment of IBM Integration Designer, the value of the IBM BPM custom property is set immediately when you run the command. In network deployment (ND) environments, the value of the IBM BPM custom property is set when the next node synchronization occurs. For both stand-alone and ND environments, it is not necessary to restart the server or cluster after running the command. - setBPMVirtualHost command
Use the setBPMVirtualHost command to create or update an IBM BPM virtual host. For both stand-alone and network deployment (ND) environments, it is not necessary to restart the server or cluster after running the setBPMVirtualHost command if you also run the clearBPMEndpointServiceCache command. In ND environments, you must wait until node synchronization has completed before you run the clearBPMEndpointServiceCache command. - setWSRRDefinitionAsDefault command
Use the setWSRRDefinitionAsDefault command to set the named WSRR definition to be the default one. - setWXSDefinitionAsDefault command
Use the setWXSDefinitionAsDefault command to set the named WebSphere eXtreme Scale (eXtreme Scale) definition to be the default. - showBPMExternalECM command
Use the showBPMExternalECM command to show the external Enterprise Content Management servers that are configured for IBM Business Process Manager. - showSCAExport command
Use the showSCAExport command to display the attributes of a Service Component Architecture (SCA) module export. - showSCAExportBinding command
Use the showSCAExportBinding command to display the attributes of Service Component Architecture (SCA) module export bindings. - showSCAExportEJBBinding command
Use the showSCAExportEJBBinding command to show the attributes of an Enterprise JavaBeans (EJB) export binding. - showSCAExportHttpBinding command
Use the showSCAExportHttpBinding command to show the attributes of an HTTP export binding. - showSCAExportJMSBinding command
Use the showSCAExportJMSBinding command to show the attributes of a JMS export binding. This applies to JMS bindings, WebSphere MQ JMS bindings, and Generic JMS bindings. - showSCAExportMQBinding command
Use the showSCAExportMQBinding command to show the attributes of a WebSphere MQ export binding. - showSCAExportWSBinding command
Use the showSCAExportWSBinding command to show the attributes of a web service export binding. - showSCAImport command
Use the showSCAImport command to display the attributes of a Service Component Architecture (SCA) module import. - showSCAImportBinding command
Use the showSCAImportBinding command to display the attributes of Service Component Architecture (SCA) module import bindings. - showSCAImportEJBBinding command
Use the showSCAImportEJBBinding command to show the attributes of an Enterprise JavaBeans (EJB) import binding. - showSCAImportHttpBinding command
Use the showSCAImportHttpBinding command to show the attributes of an HTTP import binding. - showSCAImportJMSBinding command
Use the showSCAImportJMSBinding command to show the attributes of a JMS import binding. This applies to JMS bindings, WebSphere MQ JMS bindings, and Generic JMS bindings. - showSCAImportMQBinding command
Use the showSCAImportMQBinding command to show the attributes of a WebSphere MQ import binding. - showSCAImportWSBinding command
Use the showSCAImportWSBinding command to show the attributes of a web service import binding. - showSCAModule command
Use the showSCAModule command to display the attributes of a Service Component Architecture (SCA) module. - showSCAModuleProperties command
Use the showSCAModuleProperties command to display the properties of a Service Component Architecture (SCA) module. - showSCMConnectivityProvider command
Use the showSCMConnectivityProvider command to return a list of all the parameters for a Service Connectivity Management (SCM) connectivity provider. - showWSRRDefinition command
Use the showWSRRDefinition command to 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 command
Use the showWXSDefinition command to return a list of all the parameters for a WebSphere eXtreme Scale (eXtreme Scale) definition. - startDocumentStoreMigration command
Use the startDocumentStoreMigration command to migrate BPM documents from the BPM database to the IBM BPM document store in IBM Business Process Manager or to an external ECM server. - uninstallBusinessSpaceWidgets command
Use the uninstallBusinessSpaceWidgets command to remove widgets and widget definitions from the profile, including removing individual widget assets (application, catalog, endpoints, spaces, templates, help). - updateBPMAliasesAndRunAsRolesPasswords command
When the password of the user defined in the file registry or external security provider is changed and the user ID is used by IBM Business Process Manager authentication aliases or RunAs roles of IBM BPM applications, the password must be synchronized. The updateBPMAliasesAndRunAsRolesPasswords command enables this synchronization in one step. - updateBPMConfig command
Use the updateBPMConfig command to modify the IBM Process Server environment name or environment type. In network deployment (ND) environments, the modified values are set when the next node synchronization occurs. In stand-alone environments, such as IBM BPM Express and the unit test environment of IBM Integration Designer, the modified values are set immediately when you run the command. - updateBPMExternalECM command
When you add or remove cluster members either on IBM Business Process Manager or IBM FileNet® Content Manager, use the updateBPMExternalECM command. This command reconciles the change from the old list of cluster members and servers to the new list of cluster members and servers. You use this command only if you have IBM BPM configured with an external ECM server. - updateBusinessSpaceWidgets command
Use the updateBusinessSpaceWidgets command to update previously configured widgets and their endpoints, catalogs, templates, and help plugins. - updateDocumentStoreApplication command
Use the updateDocumentStoreApplication command to check the status of the installed IBM_BPM_DocumentStore application in a deployment target. If the application is not current or the authentication alias used by the application does not match the one mapped in the EmbeddedECMTechnicalUser role, the application is updated. - updateEndpointBindingsOnPortal command
Use the updateEndpointBindingsOnPortal command to create endpoint references on the WebSphere Portal application server so that your team can use the widgets on WebSphere Portal. - updateRESTGatewayService command
Use the updateRESTGatewayService command to update a Representational State Transfer (REST) gateway service so that REST services are configured and enabled. - validateSCAImportExportInformation command
This command validates 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