Command Usage: sam v8_1_5 sam schedule process shutdown
|  |
Command Description:
Force shutdown of the consumer process listener (C++ API).
This command is usually not needed as the listener will be shutdown once
the user application exits. The command can be executed by an authorized
account only. Once the listener is scheduled for shutdown, no more input
files will be delivered to the user application.
Usage:
sam schedule process shutdown <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--processId=<value> # ID of the consumer process which should have shutdown scheduled
--project=<value> # name of the project this consumer process is running under
--station=<value> # station where the project is running
--options:
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--retryInterval=<value> # retry interval base in seconds; will multiply this base times retryCount (default: 5)
--retryJitter=<value> # retry jitter, random jitter added to base retry interval times retryCount (default: 5)
--retryMaxCount=<value> # number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
-flags:
-c # automatically close all servants after each method call
-d # debug mode
-s # retrySilently mode (do not issue messages to stderr on proxy retries)
-t # time-it mode (print additional info on timings)
-v # verbose mode
Synonymous Options:
--cpid=<value> # synonym for --processId=<value>
Required Data Types:
corbaCallTimeout : int
processId : long
project : string
retryInterval : int
retryJitter : int
retryMaxCount : int
station : string
You may omit "-c" if the $SAM_PYAPI_AUTO_CLOSE_SERVANTS environmental variable is set.
You may omit "--corbaCallTimeout=<value>" if the $SAM_PYAPI_CORBA_CALL_TIMEOUT environmental variable is set.
You may omit "--project=<value>" if the $SAM_PROJECT environmental variable is set.
You may omit "--retryInterval=<value>" if the $SAM_PYAPI_RETRY_INTERVAL environmental variable is set.
You may omit "--retryJitter=<value>" if the $SAM_PYAPI_RETRY_JITTER environmental variable is set.
You may omit "--retryMaxCount=<value>" if the $SAM_PYAPI_RETRY_MAX_COUNT environmental variable is set.
You may omit "-s" if the $SAM_PYAPI_RETRY_SILENTLY environmental variable is set.
You may omit "--station=<value>" if the $SAM_STATION environmental variable is set.
UNIX ExitStatus:
Success : 0
Unhandled exceptions : 127
See Also: