NSX-T Data Center REST API

Returns capacity usage data for NSX objects (Deprecated)

Deprecated:
This API is no longer been used by UI, please use below policy api instead.
GET https://<nsx-mgr>/policy/api/v1/infra/capacity/dashboard/usage

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/capacity/usage
Request Headers:
n/a
Query Parameters:
PolicyCapacityUsageRequestParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/infra/capacity/usage?category=All

Successful Response:

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

Example Response:

{ "capacity_usage": [ { "usage_type": "NUMBER_OF_EDGE_CLUSTERS", "display_name": "Edge Clusters", "current_usage_count": 0, "max_supported_count": 16, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_EDGE_NODES", "display_name": "System Wide Edge Nodes", "current_usage_count": 0, "max_supported_count": 160, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_TIER0_ROUTERS", "display_name": "Tier 0 Logical Routers", "current_usage_count": 0, "max_supported_count": 80, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_TIER1_ROUTERS", "display_name": "Tier 1 Logical Routers", "current_usage_count": 0, "max_supported_count": 2000, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_PREFIX_LIST", "display_name": "Prefix Lists", "current_usage_count": 0, "max_supported_count": 500, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_NAT_RULES", "display_name": "System wide NAT rules", "current_usage_count": 0, "max_supported_count": 25000, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_DHCP_IP_POOLS", "display_name": "System-wide DHCP Ranges/Pools", "current_usage_count": 0, "max_supported_count": 20000, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_TIER1_WITH_NAT_RULE", "display_name": "Tier 1 Logical Routers with NAT enabled", "current_usage_count": 0, "max_supported_count": 2000, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_GROUP", "display_name": "Network and Security Groups", "current_usage_count": 2004, "max_supported_count": 10000, "current_usage_percentage": 20.04, }, { "usage_type": "NUMBER_OF_PREPARED_HOSTS", "display_name": "Hypervisor Hosts", "current_usage_count": 0, "max_supported_count": 1024, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_ACTIVE_DIRECTORY_GROUPS", "display_name": "Active Directory Groups", "current_usage_count": 0, "max_supported_count": 100000, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_ACTIVE_DIRECTORY_DOMAINS", "display_name": "Active Directory Domains", "current_usage_count": 0, "max_supported_count": 15, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_FIREWALL_SECTIONS", "display_name": "System Wide Firewall Sections", "current_usage_count": 2, "max_supported_count": 10000, "current_usage_percentage": 0.02, }, { "usage_type": "NUMBER_OF_FIREWALL_RULES", "display_name": "System Wide Firewall Rules", "current_usage_count": 2, "max_supported_count": 100000, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_SECURITY_POLICY", "display_name": "Distributed Firewall Sections", "current_usage_count": 2, "max_supported_count": 10000, "current_usage_percentage": 0.02, }, { "usage_type": "NUMBER_OF_SECURITY_POLICY_RULES", "display_name": "Distributed Firewall Rules", "current_usage_count": 2, "max_supported_count": 100000, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_SEGMENT", "display_name": "Logical Switches", "current_usage_count": 0, "max_supported_count": 10000, "current_usage_percentage": 0, }, { "usage_type": "NUMBER_OF_SEGMENT_PORT", "display_name": "System Wide Logical Switch Ports", "current_usage_count": 0, "max_supported_count": 20000, "current_usage_percentage": 0, } { "usage_type": "NUMBER_OF_PROTECTION_ENABLED_HOST", "display_name": "System Wide Endpoint Protection Enabled Hosts", "current_usage_count": 0, "max_supported_count": 20000, "current_usage_percentage": 0, } { "usage_type": "NUMBER_OF_PROTECTION_ENABLED_VIRTUAL_MACHINES", "display_name": "System Wide Endpoint Protection Enabled Virtual Machines", "current_usage_count": 0, "max_supported_count": 20000, "current_usage_percentage": 0, } { "usage_type": "NUMBER_OF_VSPHERE_CLUSTERS", "display_name": "vSphere Clusters", "current_usage_count": 0, "max_supported_count": 20000, "current_usage_percentage": 0, } ], }

Required Permissions:

read

Feature:

infra_admin

Additional Errors: