Command Usage: sam v8_1_5 sam list definitions
|  |
Command Description:
List all matching dataset definitions.
Usage:
sam list definitions [--options] [-flags]
Where:
--options:
--after=<value> # limit the search to definitions created after this date
--before=<value> # limit the search to definitions created before this date
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--definitionName=<value> # dataset definition name
--group=<value> # group for whom the dataset was created
--keywords=<value> # keywords associated with the 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)
--userName=<value> # user who created the 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:
--defName=<value> # synonym for --definitionName=<value>
Must specify at least one of:
--definitionName=<value> OR --userName=<value> OR --group=<value> OR --keywords=<value> OR --before=<value> OR
--after=<value>
Required Data Types:
after : SamTime
before : SamTime
corbaCallTimeout : int
definitionName : string
group : string
keywords : SamStringList
retryInterval : int
retryJitter : int
retryMaxCount : int
userName : 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 "--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: