ParameterDefinitions
description
Structure and syntax
The
ParameterDefinitions
is a Python dictionary that contains one or more parameters. Each parameter is defined by a Python dictionary containing information specific to the parameter. At the time the agent is created, the default value is assigned to the parameter unless the user specifies a different value.
This part of the script is omitted if the script does not include user-defined parameters.
ParameterDefinitions = {
'<param_name>': {
'Name': '<descriptive_parameter_name>',
'Description': '<description>'
'Type': '<datatype>',
'Default': <default_value>
}
}
Components
Each parameter definition must contain the following:
- The parameter declaration
Specifies a unique name for parameter. This name must be unique within the script. The name is a text string that can contain alphanumeric characters,
-
(hyphen), and_
(underscore). Example:threshold
- Name
The name of the parameter. This name is displayed in the user interfaces.
- Description
Describes the parameter. This description is displayed to users in the Create Agent screen of the Web UI.
- Type
Specifies the datatype of parameter. Parameter type is one of the following values:
integer
string
- Default
Specifies the default value of the parameter. At the time the agent is created, the default value is assigned to the parameter unless the user specifies a different value. A default value is required.