NSX-T Data Center REST API

OdsRunbookInvocationStatus (type)

{
  "additionalProperties": false, 
  "description": "The runtime status of the invocation of an Online Diagnostic System Runbook.", 
  "id": "OdsRunbookInvocationStatus", 
  "module_id": "PolicyOds", 
  "properties": {
    "operation_state": {
      "description": "Operation state of an invocation of an Online Diagnostic System Runbook on its target node.   NONE - No operation state is available.   RUNBOOK_NOT_FOUND - The specified runbook does not exist on the target.   QUEUED - The runbook invocation is queued to be scheduled.   BUSY_REJECTED - The runbook invocation is rejected because the runbook runner                   on the target node is busy.   THROTTLED - The runbook invocation is rejected by throttling check.   ARG_INVALID - The runbook invocation is rejected by argument validation.   RUNNING - The runbook invocation is running.   FINISHED - The runbook invocation is finished.   GENERAL_ERROR - Runbook invocation fails with some internal errors.   RUNBOOK_NOT_ENABLED - The specified runbook is not enabled on the target.   ABORTED - The runbook invocation is cancelled.", 
      "enum": [
        "NONE", 
        "RUNBOOK_NOT_FOUND", 
        "QUEUED", 
        "BUSY_REJECTED", 
        "THROTTLED", 
        "ARG_INVALID", 
        "RUNNING", 
        "FINISHED", 
        "GENERAL_ERROR", 
        "RUNBOOK_NOT_ENABLED", 
        "ABORTED"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Operation state of a runbook invocation on the target node", 
      "type": "string"
    }, 
    "request_status": {
      "description": "Request status of an invocation of an Online Diagnostic System Runbook.   SUCCESS - The runbook invocation request is acknowledged by the target.   CONNECTION_ERROR - The runbook invocation request cannot be dispatched to                      the target because the messaging channel is broken.   TIMEOUT - The runbook invocation request was acknowledged by the target, but it             did not report operational state of the terminating class to NSX in time.", 
      "enum": [
        "SUCCESS", 
        "CONNECTION_ERROR", 
        "TIMEOUT"
      ], 
      "readonly": true, 
      "required": true, 
      "title": "Request status of a runbook invocation", 
      "type": "string"
    }
  }, 
  "title": "Status of runbook invocation", 
  "type": "object"
}