Python API: sam v8_1_5 sam.dumpStation()
|  |
This is the python interface to the command 'sam dump station'.
Command Description:
Dump information about a SAM station. The information is written to the screen.
NOTE, dumping of CACHED files is currently disabled.
Python Usage:
from Sam import sam
result = sam.dumpStation(...)
Return value: string
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
------------------------------------------------------------------------------------------------------------------------------------
all SamBoolean dump all of the above
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
disks SamBoolean dump information about station cache disks
files SamBoolean dump information about files that have been requested and/or cached
fsman SamBoolean dump information about the configuration of the fairShare management
groups SamBoolean dump information about group quotas, admins, etc.
projects SamBoolean dump information about currently running projects
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)
(*) station string station about which information is desired
t SamBoolean time-it mode (print additional info on timings)
v SamBoolean verbose mode
====================================================================================================================================
Must have at least one of:
(groups, disks, projects, fsman, files, all)
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']
station = os.environ['SAM_STATION']
See Also: