NSX-T Data Center REST API

Read the report of a runbook invocation

Read the report of an Online Diagnostic System Runbook invocation.
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/runbook-invocations/{invocation-id}/report
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:
OdsRunbookInvocationReport+

Example Response:

{ "invocation_id" : "61fe03f6-9eee-4c2d-bc03-ccb915aaf172", "target_node" : "80b79e1f-3027-45ef-9eb3-c704a8c947f8", "timestamp" : 1655360964, "sys_info" : { "host_name" : "wdc-rdops-vm03-dhcp-7-223.eng.vmware.com", "os_name" : "VMkernel", "os_version" : "7.0.3" }, "result_message" : "Tunnel 192.168.0.11 -> 192.168.0.10 is in up state", "recommendation_message" : "Recommendation is not available.", "step_details" : [ { "step_id" : "1", "action_summary" : "Check the status of tunnel for the given source/destination VTEPs.", "action_result" : "Tunnel 192.168.0.11 -> 192.168.0.10 is in state up" } ], "status" : { "request_status" : "SUCCESS", "operation_state" : "FINISHED" } }

Required Permissions:

read

Feature:

policy_ops

Additional Errors: