NSX-T Data Center REST API

Read a Dynamic Runbook Instance state

Read Online Diagnostic System Dynamic Runbook Instance state
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/sha/dynamic-runbook-instances/{instance-id}/state
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
OdsDynamicRunbookInstanceState+

Example Response:

{ "runbook_name": "debug_runbook", "management_state": "INSTALL_FINISHED", "install_state": [ { "node_id": "a257b981-1a1c-4b95-b16c-8646e85ce8f0", "version": 4.2, "status": "INSTALL_FINISHED" } ] }

Required Permissions:

read

Feature:

policy_ops

Additional Errors: