Command Usage: samadmin v8_1_5 samadmin add param suite
|  |
Command Description:
Add a whole dictionary of ParamCategory and ParamType
definitions to the database. Ignore any duplicates (i.e.,
if it's already there, don't panic). Just suck in a
dictionary and add it to the db.
Also, register all of the newly-added paramCategory/paramType
combinations to the list of valid dimensions.
The dictionary to be passed must be in the following
syntax:
paramSuite = { 'ParamCategoryName1' :
{ 'pc1_ParamTypeName1' : specification_of_dataTypeOf_pc1ParamTypeName1,
'pc1_ParamTypeName2' : specification_of_dataTypeOf_pc1ParamTypeName2,
...
},
'ParamCategoryName2' :
{ ... }
The ParamCategory names are strings.
The ParamTypeName names are strings.
The dataType specification must adhere to the rules
described in the online help for the "samadmin add data type"
command.
Example:
# a file named MyParams.py:
from SamStruct.SamSize import SamSize
from SamStruct.SamTime import SamTime
from SamStruct.ApplicationFamily import ApplicationFamily
paramSuite = { 'Global' :
{'userName' : 'string',
'date' : SamTime,
'size' : SamSize,
'application' : ApplicationFamily},
'Local' :
{'nodeName' : 'string',
'cmEnergy' : 'float',
}
}
from SamAdmin import samAdmin
samAdmin.addParamSuite(paramSuite=paramSuite)
Or, from the command line:
samadmin add param suite --param-file=./MyParams.py
If a paramType is already registered in the SAM database,
and your input data contains a different dataType than was
originally listed, you must use the --updateDataTypes flag
to update the dataType in the database; otherwise, the
dataType will NOT be changed to the new dataType.
Usage:
samadmin add param suite [--options] [-flags]
Where:
--options:
--updateDataTypes # update dataType specification where new data is different from existing data
--connect=<value> # oracle username/password for connecting to this database
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--paramFile=<value> # file containing the definition of an object named paramSuite
--paramSuite=<value> # two-level nested dictionary of valid paramCategories, paramTypes, and their dataTypes
--retryInterval=<value> # retry interval base in seconds; will multiply this base times retryCount (default: 5)
--retryJitter=<value> # retry jitter, random jitter added to base retry interval times retryCount (default: 5)
--retryMaxCount=<value> # number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
-flags:
-c # automatically close all servants after each method call
-d # debug mode
-s # retrySilently mode (do not issue messages to stderr on proxy retries)
-t # time-it mode (print additional info on timings)
-v # verbose mode
Synonymous Options:
--param-file=<value> # synonym for --paramFile=<value>
--param-suite=<value> # synonym for --paramSuite=<value>
Must specify at least one of:
--param-file=<value> OR --param-suite=<value>
Mutually Exclusive Options:
--param-file=<value> OR --param-suite=<value>
Required Data Types:
connect : string
corbaCallTimeout : int
paramFile : string
paramSuite : SamDictionaryIdlStruct
retryInterval : int
retryJitter : int
retryMaxCount : int
You may omit "-c" if the $SAM_PYAPI_AUTO_CLOSE_SERVANTS environmental variable is set.
You may omit "--connect=<value>" if the $SAM_ORACLE_CONNECT environmental variable is set.
You may omit "--corbaCallTimeout=<value>" if the $SAM_PYAPI_CORBA_CALL_TIMEOUT environmental variable is set.
You may omit "--retryInterval=<value>" if the $SAM_PYAPI_RETRY_INTERVAL environmental variable is set.
You may omit "--retryJitter=<value>" if the $SAM_PYAPI_RETRY_JITTER environmental variable is set.
You may omit "--retryMaxCount=<value>" if the $SAM_PYAPI_RETRY_MAX_COUNT environmental variable is set.
You may omit "-s" if the $SAM_PYAPI_RETRY_SILENTLY environmental variable is set.
UNIX ExitStatus:
Success : 0
Unhandled exceptions : 127
See Also: