Python API: samMis v8_1_5 samMis.buildSamzillaDiagnosticIncludeFile()
|  |
This is the python interface to the command 'sammis build samzilla diagnostic include file'.
Command Description:
This command is used in the nightly cron jobs which
generate portions of the SAM Diagnostics page; specifically,
the portions related to Samzilla browsing of various server
log files.
Python Usage:
from SamMis import samMis
result = samMis.buildSamzillaDiagnosticIncludeFile(...)
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" or "int"); default=".*"
outputDir string output directory name; default=${SAM_WEB_LOCAL}
outputFile string output file name; default=samzillaLogFilesForDiagnostics.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)
samzillaCgiPath string path to samzilla cgi script; default=/samzilla/cgi/logViewer.py
serverListFile string path to server list file; default=${SAM_HOME}/private/<node>_server_list.txt
t SamBoolean time-it mode (print additional info on timings)
tomcatJvmList string comma-separated list of java virtual machines (e.g., jvm8107, jvm8109)default=None
tomcatLogDir string parent directory of jvmNNNN/logs (if desired); default=None
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: