NSX-T Data Center REST API

Read help information of a predefined runbook

Read help information of an Online Diagnostic System predefined runbook.
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/pre-defined-runbooks/{runbook-id}/help
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/policy/api/v1/infra/sha/pre-defined-runbooks/0000004f-7665-726c-6179-54756e6e656c/help

Successful Response:

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

Example Response:

{ "summary" : "Runbook to diagnose overlay tunnel issues.", "parameter_info" : [ { "summary" : "IP address of source VTEP", "parameter" : { "name" : "src", "optional" : false, "parameter_type" : "COMPOUND" } }, { "summary" : "IP address of destination VTEP", "parameter" : { "name" : "dst", "optional" : false, "parameter_type" : "COMPOUND" } } ] }

Required Permissions:

read

Feature:

policy_ops

Additional Errors: