Command Usage: sam v8_1_5 sam start project
|  |
Command Description:
Start the requested project. The project may, but need not, have been previously
reserved in the database.
The project is started asynchronously by the station. If you need to verify that
it is started and available before running any other commands you can use 'sam
ping project' to test if it is responding yet.
Usage:
sam start project <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--station=<value> # station where the project will run
--options:
--detached # tell station not to start project master
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--definitionId=<value> # DB ID number of the dataset definition to be used to create the project file list
--definitionName=<value> # name of the dataset definition to be used to create the project file list
--fileCut=<value> # maximum number of files to be delivered
--group=<value> # working group under which this project should be run
--project=<value> # name of the project
--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)
--snapshotId=<value> # DB ID number of an existing snapshot to be used as the project file list
--snapshotName=<value> # name of an existing snapshot to be used as the project file list
--snapshotVersion=<value> # "new", "last", or an existing snapshot version taken with the specified dataset definition
-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:
--def-id=<value> # synonym for --definitionId=<value>
--def-name=<value> # synonym for --definitionName=<value>
--defid=<value> # synonym for --definitionId=<value>
--defname=<value> # synonym for --definitionName=<value>
--name=<value> # synonym for --project=<value>
--snap-id=<value> # synonym for --snapshotId=<value>
--snap-name=<value> # synonym for --snapshotName=<value>
--snap-ver=<value> # synonym for --snapshotVersion=<value>
--snap-version=<value> # synonym for --snapshotVersion=<value>
--snapid=<value> # synonym for --snapshotId=<value>
--snapname=<value> # synonym for --snapshotName=<value>
--snapver=<value> # synonym for --snapshotVersion=<value>
--snapversion=<value> # synonym for --snapshotVersion=<value>
Mutually Exclusive Options:
--definitionName=<value> OR --definitionId=<value>
--snapshotName=<value> OR --snapshotId=<value>
--snapshotName=<value> OR --snapshotVersion=<value>
Incompatible Option Combinations:
[definitionName, definitionId, snapshotVersion] OR [snapshotName, snapshotId]
Required Data Types:
corbaCallTimeout : int
definitionId : long
definitionName : string
fileCut : long
group : string
project : string
retryInterval : int
retryJitter : int
retryMaxCount : int
snapshotId : long
snapshotName : string
snapshotVersion : SnapshotVersion
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: