Python API: samAdmin v8_1_5
samAdmin.disallowDisk()

Just having some fun...
This is the python interface to the command 'samadmin disallow disk'.
Command Description:

Mark a station cache disk as INACTIVE, for (e.g.,) hardware problems, etc.  This
does NOT require a station reboot; but the station must be running in order
to tell it to mark the disk as inactive.

You must be a station administrator for this station in order to mark the disk as
INACTIVE.

You must specify the mount point as a fully specified mount point:
  sam disallow disk --mount=d0mino.fnal.gov:/sam/cache1 --station=central-analysis

If you specify the --keepCachedFiles option, the contents of the disk
will not be destroyed.  This is useful in the case where, for example,
a disk is on a node that is not responding, and you do not want any more
files to be delivered to that node, but you expect that at some point in
the future the node will be rebooted or the network will come back, etc.,
and the cached files on that disk will once again become available.

If the --keepCachedFiles option is NOT specified, the contents of the
disk will be destroyed.  This is useful in the case when you are disallowing
a disk due to physical hardware problem on that disk.


Python Usage:
	from SamAdmin import samAdmin
	result = samAdmin.disallowDisk(...)

Return value: <none>

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
    keepCachedFiles            SamBoolean           do NOT destroy the contents of the disk by removing all cached files
(*) mountPoint                 string               mount point of this station cache disk
    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 where this disk should be marked as INACTIVE
    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: