NSX-T Data Center REST API

OdsRunbookSettingData (type)

{
  "additionalProperties": false,
  "description": "Configuration items for an Online Diagnostic System Runbook.",
  "id": "OdsRunbookSettingData",
  "module_id": "PolicyOds",
  "properties": {
    "enabled": {
      "default": true,
      "description": "The flag that indicates whether the runbook is enabled.",
      "required": false,
      "title": "The flag that indicates whether the runbook is enabled",
      "type": "boolean"
    },
    "threshold_number": {
      "description": "Maximum number of runbook executions allowed in a throttling cycle. Runbook execution will be throttled once the threshold is reached. This option does not take effect when the throttling is disabled.",
      "maximum": 10000,
      "minimum": 1,
      "required": false,
      "title": "Threshold for runbook execution in a throttling cycle",
      "type": "integer"
    },
    "threshold_number_range": {
      "$ref": "OdsRunbookParameterRange",
      "description": "Threshold range for runbook execution in a throttling cycle.",
      "readonly": true,
      "required": false,
      "title": "Threshold range for runbook execution in a throttling cycle"
    },
    "throttle_cycle": {
      "description": "Duration of throttling cycle for runbook execution in minutes. It controls the minimum time between execution of a runbook and avoids executing a runbook too frequently in a short time. If the throttling cycle is set to 0, throttling is disabled.",
      "maximum": 1440,
      "minimum": 0,
      "required": false,
      "title": "Cycle of throttling runbook execution in minutes",
      "type": "integer"
    },
    "throttle_cycle_range": {
      "$ref": "OdsRunbookParameterRange",
      "description": "Cycle range of throttling runbook execution in minutes.",
      "readonly": true,
      "required": false,
      "title": "Cycle range of throttling runbook execution in minutes"
    },
    "timeout": {
      "description": "Timeout of runbook execution in seconds.",
      "maximum": 86400,
      "minimum": 1,
      "required": false,
      "title": "Timeout of runbook execution in seconds",
      "type": "integer"
    },
    "timeout_range": {
      "$ref": "OdsRunbookParameterRange",
      "description": "The timeout range of runbook execution in seconds.",
      "readonly": true,
      "required": false,
      "title": "The timeout range of runbook execution in seconds"
    }
  },
  "title": "Setting data of runbook",
  "type": "object"
}