Python API: samMis v8_1_5 samMis.glance()
|  |
This is the python interface to the command 'sammis glance'.
Command Description:
This command runs at periodic intervals to generate the
"Sam At A Glance" web pages.
If --serverListFile is specified, the output will include links to any
server log files that are from servers running on this node, as listed
in the given serverListFile. If --envPattern is specified, the serverList
file will be filtered to include only those lines matching this
env pattern.
Python Usage:
from SamMis import samMis
result = samMis.glance(...)
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
corbaCallTimeout int time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
d SamBoolean debug mode
envPattern string regular expression describing server environment (e.g., "prd", "int", etc.)
minMonitorLevel string default set to "normal"; use "ignore" to see all stations
noIgnoredSummary SamBoolean do not include the list of stations being ignored (and why) in the report
numThreads int The number of threads to use in the thread pool for querying servers
output string full path to output HTML file (supporting files will be written to this directory; default ./saag.html)
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)
serverListFile string path to server list file on this node
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: