NSX-T Data Center REST API

OdsRunbookParameter (schema)

Base type for runbook parameter

Base type for Online Diagnostic System Runbook parameter.
This is an abstract type. Concrete child types:
OdsRunbookCompoundParameter
OdsRunbookEnumParameter
OdsRunbookIntegerParameter
OdsRunbookPatternParameter
OdsRunbookStringParameter

Name Description Type Notes
default_value Runbook argument default value

Runbook argument will be set to this value if not provided.
string Readonly
max Runbook argument max value

Runbook argument is not allowed to set value bigger than this.
string Readonly
min Runbook argument min value

Runbook argument is not allowed to set value smaller than this.
string Readonly
name Runbook argument name

Runbook argument name.
string Required
Readonly
optional The flag that indicates whether the argument is optional

The flag that indicates whether the argument is optional.
boolean Readonly
Default: "False"
parameter_type Runbook parameter type

Runbook parameter type.
INTEGER - integer
STRING - string
ENUM - enumeration
PATTERN - string that matches certain regular expression
COMPOUND - string that is accepted by the validation of runbook
BOOLEAN - boolean
FLOAT - float
string Required
Readonly
Enum: INTEGER, STRING, ENUM, PATTERN, COMPOUND, BOOLEAN, FLOAT