NSX-T Data Center REST API

List Predefined Runbooks

List Online Diagnostic System Predefined Runbooks.
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
Request Headers:
n/a
Query Parameters:
PolicyListRequestParameters+
Request Body:
n/a

Successful Response:

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

Example Response:

{ "results" : [ { "version" : { "major" : 1, "minor" : 0 }, "default_config" : { "enabled" : true, "timeout" : 120, "threshold_number" : 5, "throttle_cycle" : 5, "timeout_range": { "min_value": 300, "max_value": 1200 }, "throttle_cycle_range": { "min_value": 5, "max_value": 60 }, "threshold_number_range": { "min_value": 1, "max_value": 10 } }, "supported_node_types" : [ "nsx-esx" ], "parameters" : [ { "name" : "src", "optional" : false, "parameter_type" : "COMPOUND" }, { "name" : "dst", "optional" : false, "parameter_type" : "COMPOUND" } ], "resource_type" : "OdsPredefinedRunbook", "id" : "0000004f-7665-726c-6179-54756e6e656c", "display_name" : "OverlayTunnel", "path" : "/infra/sha/pre-defined-runbooks/0000004f-7665-726c-6179-54756e6e656c", "relative_path" : "0000004f-7665-726c-6179-54756e6e656c", "parent_path" : "/infra", "unique_id" : "529f3c41-92f1-41d6-8387-f8caa2604794", "realization_id" : "529f3c41-92f1-41d6-8387-f8caa2604794", "marked_for_delete" : false, "overridden" : false, "_create_time" : 1655123260960, "_create_user" : "system", "_last_modified_time" : 1655123260960, "_last_modified_user" : "system", "_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: