NSX-T Data Center REST API

OdsRunbookCompoundParameter (type)

{
  "additionalProperties": false, 
  "description": "Online Diagnostic System Runbook parameter of compound type.", 
  "extends": {
    "$ref": "OdsRunbookParameter
  }, 
  "id": "OdsRunbookCompoundParameter", 
  "module_id": "PolicyOds", 
  "polymorphic-type-descriptor": {
    "type-identifier": "COMPOUND"
  }, 
  "properties": {
    "default_value": {
      "description": "Runbook argument will be set to this value if not provided.", 
      "readonly": true, 
      "required": false, 
      "title": "Runbook argument default value", 
      "type": "string"
    }, 
    "max": {
      "description": "Runbook argument is not allowed to set value bigger than this.", 
      "readonly": true, 
      "required": false, 
      "title": "Runbook argument max value", 
      "type": "string"
    }, 
    "min": {
      "description": "Runbook argument is not allowed to set value smaller than this.", 
      "readonly": true, 
      "required": false, 
      "title": "Runbook argument min value", 
      "type": "string"
    }, 
    "name": {
      "description": "Runbook argument name.", 
      "readonly": true, 
      "required": true, 
      "title": "Runbook argument name", 
      "type": "string"
    }, 
    "optional": {
      "default": false, 
      "description": "The flag that indicates whether the argument is optional.", 
      "readonly": true, 
      "required": false, 
      "title": "The flag that indicates whether the argument is optional", 
      "type": "boolean"
    }, 
    "parameter_type": {
      "description": "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", 
      "enum": [
        "INTEGER", 
        "STRING", 
        "ENUM", 
        "PATTERN", 
        "COMPOUND", 
        "BOOLEAN", 
        "FLOAT"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Runbook parameter type", 
      "type": "string"
    }
  }, 
  "title": "Runbook parameter of compound type", 
  "type": "object"
}