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.

Purpose

This command provides a command-line method to return information about the IBM BPM document store in IBM Business Process Manager. The command can only be run in connected mode.

Before running this command, you should review the task topic "Obtaining the status of the IBM BPM document store."

Required parameters

-serverName: Specifies the server name of the IBM BPM document store. If you specify the serverName parameter, you must also specify the nodeName parameter.
-nodeName: Specifies the node name of the IBM BPM document store. If you specify the nodeName parameter, you must also specify the serverName parameter.
-clusterName: Specifies the cluster name of the IBM BPM document store.
-deName: Specifies the deployment environment name of IBM Business Process Manager.

You must specify the clusterName parameter, or the deName parameter, or both the serverName and nodeName parameters. As an alternative to specifying any parameters, you can invoke the command on a target object of type BPMDeploymentEnvironment, ServerCluster, or Server.

Optional parameters

None

Examples

Note: The examples are for illustrative purposes only. They include variable values and are not meant to be reused as snippets of code.

The following example uses the getDocumentStoreStatus command to retrieve the status of the IBM BPM document store for a specified node and server.

Jython example:

AdminTask.getDocumentStoreStatus('[-nodeName myNodeName -serverName myServerName]')

Jacl example:

$AdminTask getDocumentStoreStatus {-nodeName myNodeName -serverName myServerName}

The following example uses the getDocumentStoreStatus command to retrieve the status of the IBM BPM document store for a specified cluster.

Jython example:

AdminTask.getDocumentStoreStatus('[-clusterName myClusterName]')

Jacl example:

$AdminTask getDocumentStoreStatus {-clusterName myClusterName}

The following example uses the getDocumentStoreStatus command to retrieve the status of the IBM BPM document store for a specified deployment environment.

Jython example:

AdminTask.getDocumentStoreStatus('[-deName myDeName]')

Jacl example:

$AdminTask getDocumentStoreStatus {-deName myDeName}

The following example invokes the getDocumentStoreStatus command on a specified target object:

Jython example:

server = AdminConfig.getid('/Cell:myCellName/Node:myNodeName/Server:myServerName')
AdminTask.getDocumentStoreStatus(server)

Jacl example:

set server [$AdminConfig getid /Cell:myCellName/Node:myNodeName/Server:myServerName]
$AdminTask getDocumentStoreStatus $server

The following example invokes the getDocumentStoreStatus command on a specified target object:

Jython example:

cluster = AdminConfig.getid('/Cell:myCellName/ServerCluster:myClusterName')
AdminTask.getDocumentStoreStatus(cluster)

Jacl example:

set cluster [$AdminConfig getid /Cell:myCellName/ServerCluster:myClusterName]
$AdminTask getDocumentStoreStatus $cluster

The following example invokes the getDocumentStoreStatus command on a specified target object:

Jython example:

de = AdminUtilities.convertToList(AdminConfig.list("BPMDeploymentEnvironment"))[0]
AdminTask.getDocumentStoreStatus(de)

Jacl example:

foreach de [$AdminConfig list "BPMDeploymentEnvironment"] {
set result [$AdminTask getDocumentStoreStatus ${de}]
puts ${result}
}