Python API: samAdmin v8_1_5 samAdmin.uncacheEntireStation()
|  |
This is the python interface to the command 'samadmin uncache entire station'.
Command Description:
This command is used by a sam shifter to mark
all files on a particular station as 'uncached' in the
SAM db. It does not remove the files from disk, nor even
check that they actually exist.
The station must NOT be running when this command is
invoked. The station will notice the change in status
at its next restart.
Example:
samadmin uncache entire station --station=myVeryHosedStation \
--connect=myOracleUser/myOraclePassword
Related commands:
samadmin uncache station file
samadmin uncache station disk
Python Usage:
from SamAdmin import samAdmin
result = samAdmin.uncacheEntireStation(...)
Return value:
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
connect string oracle username/password for connecting to this database
corbaCallTimeout int time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
d SamBoolean debug mode
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 the station whose cache is to be completely emptied
t SamBoolean time-it mode (print additional info on timings)
v SamBoolean verbose mode
====================================================================================================================================
Environment Defaults:
c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
connect = os.environ['SAM_ORACLE_CONNECT']
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: