NSX-T Data Center REST API

Create or update a runbook setting

Create an Online Diagnostic System runbook setting with the specified identifier
if not existed, or update an existing Online Diagnostic System runbook profle
otherwise.
This API is available when using VMware Cloud (AWS, Dell-EMC, Outpost, Hyperscalers) or VMware NSX.

Request:

Method:
PUT
URI Path(s):
/policy/api/v1/infra/sha/runbook-settings/{runbook-setting-id}
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
OdsRunbookSetting+

Example Request:

PUT https://<nsx-mgr>/policy/api/v1/infra/sha/runbook-settings/pp1 { "runbook_path":"/infra/sha/pre-defined-runbooks/00000000-0000-0050-6f72-74426c6f636b", "applied_to_group_path":"/infra/domains/default/groups/TNGroup", "config":{ "enabled":true, "timeout":120, "threshold_number":5, "throttle_cycle":5 }, "_revision":0 }

Successful Response:

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

Example Response:

{ "runbook_path" : "/infra/sha/pre-defined-runbooks/00000000-0000-0050-6f72-74426c6f636b", "applied_to_group_path" : "/infra/domains/default/groups/TNGroup", "config" : { "enabled" : true, "timeout" : 120, "threshold_number" : 5, "throttle_cycle" : 5 }, "resource_type" : "OdsRunbookSetting", "id" : "pp1", "display_name" : "pp1", "path" : "/infra/sha/runbook-settings/pp1", "relative_path" : "pp1", "parent_path" : "/infra", "unique_id" : "eba577fb-5363-4211-8ffc-924f1f233119", "realization_id" : "eba577fb-5363-4211-8ffc-924f1f233119", "marked_for_delete" : false, "overridden" : false, "_create_time" : 1655296424145, "_create_user" : "admin", "_last_modified_time" : 1655296424145, "_last_modified_user" : "admin", "_system_owned" : false, "_protection" : "NOT_PROTECTED", "_revision" : 1 }

Required Permissions:

crud

Feature:

policy_ops

Additional Errors: