Python API: sam v8_1_5 sam.getRegisteredDataDisks()
|  |
This is the python interface to the command 'sam get registered data disks'.
Command Description:
Retrieve a list of the registered data disks (not station disks).
This can be helpful when trying to figure out how to add a new
data storage location.
Example:
$ sam get registered data disks --node=my.node.domain
my.node.domain:/sam/IncomingRouting
my.node.domain:/sam/OutgoingRouting/
$ sam add disk location --mountPoint=my.node.domain:/sam/IncomingRouting --relativePath=files/come/here
$ sam add disk location --mountPoint=my.node.domain:/sam/OutgoingRouting/ --relativePath=files/go/there
Python Usage:
from Sam import sam
result = sam.getRegisteredDataDisks(...)
Return value: SamStruct.SamStringList.SamStringList
Arguments are passed as keyword-value pairs, as in:
myfunc(arg1='myarg', arg2='anotherarg', d=1)
Argument Keyword Description:
(*) indicates that this keyword is required
>>> indicates that either the API object or the CLI equivalent (<<<) is required
====================================================================================================================================
KEYWORD DATA TYPE DESCRIPTION
------------------------------------------------------------------------------------------------------------------------------------
c SamBoolean automatically close all servants after each method call
corbaCallTimeout int time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
d SamBoolean debug mode
locations SamBoolean list the full paths of the data storage locations belonging to the disks
node string limit the results to disks on this node
retryInterval int retry interval base in seconds; will multiply this base times retryCount (default: 5)
retryJitter int retry jitter, random jitter added to base retry interval times retryCount (default: 5)
retryMaxCount int number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
s SamBoolean retrySilently mode (do not issue messages to stderr on proxy retries)
t SamBoolean time-it mode (print additional info on timings)
v SamBoolean verbose mode
====================================================================================================================================
Environment Defaults:
c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
retryInterval = os.environ['SAM_PYAPI_RETRY_INTERVAL']
retryJitter = os.environ['SAM_PYAPI_RETRY_JITTER']
retryMaxCount = os.environ['SAM_PYAPI_RETRY_MAX_COUNT']
s = os.environ['SAM_PYAPI_RETRY_SILENTLY']
See Also: