Parameter definitions
The
ParameterDefinitions
statement defines the parameters that are used in the script.
When a user creates an agent, the user can specify values for the parameters. The user must specify values for parameters that the script identifies as required parameters.
When you write a script, Hewlett Packard Enterprise recommends that you create parameters for any user-configurable option in the script.
If the script has no parameters, omit the
ParameterDefinitions
statement.
The following example of a
ParameterDefinitions
statement defines the following parameters:
threshold
The
threshold
parameter is an integer and has a default value90
.password
The
password
parameter is a string. The parameter is optional. If the user supplies a value, the user-supplied text is encrypted when the text is stored.
ParameterDefinitions = {
'threshold': {
'Name': 'Critical CPU Threshold value in percentage',
'Description': ('When System CPU utilization exceeds this value, '
'set the policy status to Critical and the policy will log '
'system daemon CPU utilization details and CPU queue statistics in syslog.'),
'Type': 'integer',
'Default': 90
}
'password': {
'Name': 'Password',
'Description': ' Service Password',
'Type': 'string',
'Encrypted': True,
'Required': False
}
}