NSX-T Data Center REST API

OdsRunbookInvocationReport (type)

{
  "additionalProperties": false,
  "description": "The report of the Invocation of an Online Diagnostic System Runbook.",
  "id": "OdsRunbookInvocationReport",
  "module_id": "PolicyOds",
  "properties": {
    "error_detail": {
      "description": "The error detail of the invalid report.",
      "readonly": true,
      "required": false,
      "title": "The report error detail",
      "type": "string"
    },
    "invalid_reason": {
      "description": "The reason why this report is invalid.   TIMEOUT - The invocation is timeout.   CANCELLED - The invocation is cancelled.   INTERNAL_ERROR - The invocation ends up with error.",
      "enum": [
        "TIMEOUT",
        "CANCELLED",
        "INTERNAL_ERROR"
      ],
      "readonly": true,
      "required": false,
      "title": "Invalid report reason",
      "type": "string"
    },
    "invocation_id": {
      "description": "The universally unique identifier for invocation of an Online Diagnostic System Runbook.",
      "readonly": true,
      "required": true,
      "title": "UUID of Runbook Invocation",
      "type": "string"
    },
    "recommendation_code": {
      "description": "Online Diagnostic System recommendation code of the runbook invocation.",
      "readonly": true,
      "required": false,
      "title": "Online Diagnostic System recommendation code",
      "type": "integer"
    },
    "recommendation_message": {
      "description": "Online Diagnostic System recommendation message of the runbook invocation.",
      "readonly": true,
      "required": false,
      "title": "Online Diagnostic System recommendation message",
      "type": "string"
    },
    "result_code": {
      "description": "Online Diagnostic System result code of the runbook invocation.",
      "readonly": true,
      "required": false,
      "title": "Online Diagnostic System result code",
      "type": "integer"
    },
    "result_message": {
      "description": "Online Diagnostic System result message of the runbook invocation.",
      "readonly": true,
      "required": false,
      "title": "Online Diagnostic System result message",
      "type": "string"
    },
    "status": {
      "$ref": "OdsRunbookInvocationStatus",
      "description": "The runtime status of the invocation of an Online Diagnostic System runbook.",
      "readonly": true,
      "required": false,
      "title": "Status of the runbook invocation"
    },
    "step_details": {
      "description": "Details of performed steps in the invocation of an Online Diagnostic System Runbook.",
      "items": {
        "$ref": "OdsRunbookInvocationStepInfo"
      },
      "readonly": true,
      "required": false,
      "title": "Details of performed steps in the runbook invocation",
      "type": "array"
    },
    "sys_info": {
      "$ref": "OdsRunbookSysInfo",
      "description": "System information of the target node where the Online Diagnostic System Runbook is executed.",
      "readonly": true,
      "required": false,
      "title": "System information of the target node where the runbook is executed"
    },
    "target_node": {
      "description": "Identifier of an appliance node or transport node where the execution of an Online Diagnostic System Runbook happens.",
      "readonly": true,
      "required": true,
      "title": "Identifier of an appliance node or transport node",
      "type": "string"
    },
    "timestamp": {
      "$ref": "EpochMsTimestamp",
      "description": "The timestamp when the report of an Online Diagnostic System Runbook is generated in milliseconds epoch.",
      "readonly": true,
      "required": false,
      "title": "Timestamp of Runbook invocation report"
    }
  },
  "title": "Report of Runbook Invocation",
  "type": "object"
}