Soft Stop opscmd Commands

You can use opscmd commands to run commands from the command line for each step of the soft stop process.

The following opscmd commands allow you to run commands from the command line for each step of the soft stop process. The chart shows the UNIX command. For Windows, use the opscmd.cmd command with the same parameters.
Action Command
Marking a node unavailable opscmd.sh -cMarkNodeUnavailable -pname=node_name
Marking a node available opscmd.sh -cMarkNodeAvailable -pname=node_name
Block a queue or all queues

opscmd.sh -cBlockQueue -pname=node_name -pid={queue_id | all} [ -pbpCompletionPolicy={1 | 2 | 3} ]

queue_id can be 1-9 or (for all queues).

Unblock a queue or all queues

opscmd.sh -cUnblockQueue -pname=node_name -pid={queue_id | all}

Drain a queue or all queues

opscmd.sh -cDrainQueue -pname=node_name -pid={queue_id | all} [-pbpDrainPolicy={1 | 2 | 3 | 4}]
Note: If the business process completion policy is the default value of Finish Business Process (pbpCompletionPolicy=1), then the specified drain policy will be honored. If the business process completion policy is Finish Current Step (pbpCompletionPolicy=2) or Finish Current Execution Cycle (pbpCompletionPolicy=3), then the drain policy will be Drain ALL BPs.
Note: This is an asynchronous command. Use the cGetDrainQueueStatus command to see the status of the queue draining.
See the status of the queue draining opscmd.sh -cGetDrainQueueStatus -pname=node_name -pid={queue_id | all}
Move Schedules to another node and stop the scheduler opscmd.sh -cStopScheduler -pname=node_name [-pFailoverNodeName=node_name]
Note: If the failover node is not specified, the system will automatically pick one for you, if possible.
Signal adapters for softstop opscmd.sh -cPrepareStopAllAdapters -pname=node_name
Stop all adapters
Note: You can also shut down adapters using the graceful adapter shutdown tool. For more information, see Graceful Adapter Shutdown.

opscmd.sh -cStopAllAdapters -pname=node_name [-pTimeoutForAdapters=time_out_in_seconds]

List all active adapters. opscmd.sh -cListActiveAdapters -pname=node_name

If the adapter type is stateless, this command will list only one instance of the adapter, even though it may have many configurations for each node. If the adapter type is stateless, only one instance (configuration) is applicable for each service type.

If the adapter type is stateful, then all the active instances are listed for this command for each adapter.

Stop resource monitor opscmd.sh -cStopResourceMonitor -pname=node_name
List all active business processes invoked by server adapters that have not sent the business process result back yet

opscmd.sh -cGETTRANSPORTSESSIONBPS [-pname=node_name] -pid={queue_id | all} -padapterNodeName=adapter_node_name

Where adapter_node_name is the name of the node that is being shut down. If -pname is not specified, all ASI nodes will be scanned. The list of business processes returned by this command have a client session with the adapters on the node.

List all business processes that have not closed sessions with client adapters on the node that is being shut down.

opscmd.sh -cGETCLIENTSESSIONBPS [-pname=node_name] -padapterNodeName=adapter_node_name

Where adapter_node_name is the name of the node that is being shut down. If -pname is not specified, all ASI nodes will be scanned.

Execute business processes on a queue or on all queues. opscmd.sh -cExecuteBPsOnQueue -pname=node_name -pid={queue_id | all} [-ptimeoutForQueues=timeout_out_in_seconds]
Note: This is an asynchronous command. Use the cGetExecuteBPsOnQueueStatus command to see the status of BP execution.
See the status of the business process queues execution. opscmd.sh -cGetExecuteBPsOnQueueStatus -pname=node_name -pid={queue_id | all}
Stop the JVM of a node opscmd.sh -cSTOPJVM -pname=node_name
Shut down a node or a whole cluster opscmd.sh -cSHUTDOWN [-pname=node_name] [-pBPCompletionPolicy={1 | 2 | 3}] [-pBPDrainPolicy={1 | 2 | 3 | 4}] [-pTimeoutForQueues=time_out_in_seconds] [-pTimeoutForAdapters=time_out_in_seconds]
Note: If a node is not specified, the whole cluster is shut down.
Note: If the optional parameter BPCompletionPolicy, BPDrainPolicy, TimeoutForQueues, or TimeoutForAdapters is not specified, the default property value will be used from the noapp.properties_platform_ifcresources_ext.in file.
Important: A soft stop does not stop all JVMs and system processing. To fully stop the system, you must perform a hard stop after the soft stop is complete. For instructions, see Hard Stop of Sterling B2B Integrator.