Command Usage: sam v8_1_5 sam create definition
|  |
Command Description:
Create a new dataset definition. Later, this definition may be used
to take a snapshot of files matchine the definition constraints
(aka "dimensions").
Usage:
sam create definition <--requiredOptions> [--options] [-flags]
sam create dataset definition <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--definitionName=<value> # name to be assigned to this definition
--dimensions=<value> # string specifying the dimensional quantities of interest
--group=<value> # work group to which this definition should be assigned for bookkeeping
--options:
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--description=<value> # description to be associated with this definition
--keywords=<value> # comma-separated list of keywords to be associated with this definition
--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:
--defName=<value> # synonym for --definitionName=<value>
--defdesc=<value> # synonym for --description=<value>
--desc=<value> # synonym for --description=<value>
--dim=<value> # synonym for --dimensions=<value>
--dimension=<value> # synonym for --dimensions=<value>
--dims=<value> # synonym for --dimensions=<value>
Required Data Types:
corbaCallTimeout : int
definitionName : string
description : string
dimensions : string
group : string
keywords : SamStringList
retryInterval : int
retryJitter : int
retryMaxCount : int
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 "--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.
UNIX ExitStatus:
Success : 0
Unhandled exceptions : 127
See Also: