Command Usage: sam v8_1_5 sam establish consumer
|  |
Command Description:
Establish a consumer for this project, by calling the
sam_idl/sam_station/GPM2Consumer.establishNewConsumer interface
of the project master. (Hence, the project must already be running).
A 'consumer' is a 'container' for one or more consumer processes
(which must be separately established with the 'sam establish process'
command). The application name and version must be registered in the
SAM db (for bookkeeping purposes).
Uses sam_common_pylib/SamUtility/SamUserIdentifier.getSamUserIdentifier()
to determine your SAM identity.
If no group name is specified, the processing resources
will be assigned to the group under which the project is running
(obtained by querying the dbServer).
The application name, version (and family, if specified) must be registered
applications known to the SAM database. NOTE that the appFamily field will
be IGNORED if talking to a station version prior to v6_1_1_13.
Usage:
sam establish consumer <--requiredOptions> [--options] [-flags]
sam create consumer <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--appName=<value> # application name that the consumer will be using
--appVersion=<value> # application version that the consumer will be using
--project=<value> # name of the project against which the consumer should run
--station=<value> # name of the station where this project is running
--options:
--minimalOutput # Write unadorned output (useful for scripting)
--appFamily=<value> # application family of the application that the consumer will be using (default: unknown)
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--group=<value> # work group under which this consumer will be running
--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)
--rtfile=<value> # routing file into which results will be written
-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:
--minOutput # synonym for --minimalOutput
Required Data Types:
appFamily : string
appName : string
appVersion : string
corbaCallTimeout : int
group : string
project : string
retryInterval : int
retryJitter : int
retryMaxCount : int
rtfile : string
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: