NSX-T Data Center REST API

OdsRunbookInvocationStatus (schema)

Status of runbook invocation

The runtime status of the invocation of an Online Diagnostic System Runbook.

Name Description Type Notes
operation_state Operation state of a runbook invocation on the target node

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.
string Required
Readonly
Enum: NONE, RUNBOOK_NOT_FOUND, QUEUED, BUSY_REJECTED, THROTTLED, ARG_INVALID, RUNNING, FINISHED, GENERAL_ERROR, RUNBOOK_NOT_ENABLED, ABORTED
request_status Request status of a runbook invocation

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.
string Required
Readonly
Enum: SUCCESS, CONNECTION_ERROR, TIMEOUT