NSX-T Data Center REST API

List runbook invocations

Get a paginated list of Online Diagnostic System runbook invocation entities.
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
Request Headers:
n/a
Query Parameters:
PolicyListRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/sha/runbook-invocations

Successful Response:

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

Example Response:

{ "results" : [ { "runbook_path" : "/infra/sha/pre-defined-runbooks/0000004f-7665-726c-6179-54756e6e656c", "by_force" : false, "queue_timeout" : 0, "target_node" : "80b79e1f-3027-45ef-9eb3-c704a8c947f8", "arguments" : [ { "key" : "dst", "value" : "192.168.0.10" }, { "key" : "src", "value" : "192.168.0.11" } ], "is_transient": true, "resource_type" : "OdsRunbookInvocation", "id" : "ink1", "display_name" : "ink1", "path" : "/infra/sha/runbook-invocations/ink1", "relative_path" : "ink1", "parent_path" : "/infra", "unique_id" : "61fe03f6-9eee-4c2d-bc03-ccb915aaf172", "realization_id" : "61fe03f6-9eee-4c2d-bc03-ccb915aaf172", "marked_for_delete" : false, "overridden" : false, "_create_time" : 1655360932757, "_create_user" : "admin", "_last_modified_time" : 1655360932757, "_last_modified_user" : "admin", "_system_owned" : false, "_protection" : "NOT_PROTECTED", "_revision" : 0 } ], "result_count" : 1, "sort_by" : "display_name", "sort_ascending" : true }

Required Permissions:

read

Feature:

policy_ops

Additional Errors: