System Administration > Monitoring > Dashboards > Capacity Dashboard

Updates the warning threshold(s) for NSX Objects.

Updates the warning threshold(s) for NSX Objects specified, and returns
new threshold(s). Threshold list in the request must contain value for GLOBAL_DEFAULT
threshold_type which represents global thresholds.

Request:

Method:
PUT
URI Path(s):
/api/v1/capacity/threshold
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
CapacityThresholdList+

Example Request:

PUT https://<nsx-mgr>/api/v1/capacity/threshold { "capacity_thresholds": [ { "threshold_type": "NUMBER_OF_PREFIX_LIST", "min_threshold_percentage": 50, "max_threshold_percentage": 90 }, { "threshold_type": "NUMBER_OF_VCENTER_CLUSTERS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_NAT_RULES", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_EDGE_CLUSTERS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_DHCP_IP_POOLS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_IPSETS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_EDGE_NODES", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "GLOBAL_DEFAULT", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_TIER1_ROUTERS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_PREPARED_HOSTS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_ACTIVE_DIRECTORY_GROUPS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_LOGICAL_SWITCHES", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_DFW_SECTIONS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_FIREWALL_RULES", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_LOGICAL_PORTS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_DFW_RULES", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_TIER1_WITH_NAT_RULE", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_ACTIVE_DIRECTORY_DOMAINS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_GI_PROTECTED_HOSTS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_DHCP_SERVERS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_NSGROUP", "min_threshold_percentage": 10, "max_threshold_percentage": 20 }, { "threshold_type": "NUMBER_OF_FIREWALL_SECTIONS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_GROUPS_BASED_ON_IP_SETS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_TIER0_ROUTERS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_GI_PROTECTED_VMS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 } ], "resource_type": "CapacityThresholdList", "id": "CapacityThresholdIdentifier", "display_name": "CapacityThresholdIdentifier", "_create_user": "system", "_create_time": 1553595058401, "_last_modified_user": "admin", "_last_modified_time": 1553636408045, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 17 }

Successful Response:

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

Example Response:

{ "capacity_thresholds": [ { "threshold_type": "NUMBER_OF_PREFIX_LIST", "min_threshold_percentage": 50, "max_threshold_percentage": 90 }, { "threshold_type": "NUMBER_OF_VCENTER_CLUSTERS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_NAT_RULES", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_EDGE_CLUSTERS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_DHCP_IP_POOLS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_IPSETS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_EDGE_NODES", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "GLOBAL_DEFAULT", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_TIER1_ROUTERS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_PREPARED_HOSTS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_ACTIVE_DIRECTORY_GROUPS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_LOGICAL_SWITCHES", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_DFW_SECTIONS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_FIREWALL_RULES", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_LOGICAL_PORTS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_DFW_RULES", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_TIER1_WITH_NAT_RULE", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_ACTIVE_DIRECTORY_DOMAINS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_GI_PROTECTED_HOSTS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_DHCP_SERVERS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_NSGROUP", "min_threshold_percentage": 10, "max_threshold_percentage": 20 }, { "threshold_type": "NUMBER_OF_FIREWALL_SECTIONS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_GROUPS_BASED_ON_IP_SETS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_TIER0_ROUTERS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 }, { "threshold_type": "NUMBER_OF_GI_PROTECTED_VMS", "min_threshold_percentage": 50, "max_threshold_percentage": 80 } ], "resource_type": "CapacityThresholdList", "id": "CapacityThresholdIdentifier", "display_name": "CapacityThresholdIdentifier", "_create_user": "system", "_create_time": 1553595058401, "_last_modified_user": "admin", "_last_modified_time": 1554048374877, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 18 }

Required Permissions:

crud

Feature:

capacity_usage

Additional Errors: