Python API: sam v8_1_5
sam.startReservedProjectViaStation()

Just having some fun...
This is the python interface to the command 'sam start reserved project'.
Command Description:

Tells the appropriate station to start a previously-reserved
SAM project.

The project is started asynchronously by the station. If you need to verify that
it is started and available before running any other commands you can use 'sam
ping project' to test if it is responding yet.


Python Usage:
	from Sam import sam
	result = sam.startReservedProjectViaStation(...)

Return value: SamStruct.BaseProjectInfo.BaseProjectInfo

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
    detached                   SamBoolean           tell station not to start project master
(*) project                    string               name of the already-reserved project to be started
    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 the already-reserved project is to be run
    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']
	project = os.environ['SAM_PROJECT']
	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: