NSX-T Data Center Global Manager REST API

Associated URIs:

API Description	API Path
List DHCP relay config instances Paginated list of all DHCP relay config instances	GET /global-manager/api/v1/global-infra/dhcp-relay-configs
Delete DHCP relay configuration Delete DHCP relay configuration	DELETE /global-manager/api/v1/global-infra/dhcp-relay-configs/{dhcp-relay-config-id}
Read DHCP relay configuration Read DHCP relay configuration	GET /global-manager/api/v1/global-infra/dhcp-relay-configs/{dhcp-relay-config-id}
Create or update DHCP relay configuration If DHCP relay config with the dhcp-relay-config-id is not already present, create a new DHCP relay config instance. If it already exists, update the DHCP relay config instance with specified attributes.	PATCH /global-manager/api/v1/global-infra/dhcp-relay-configs/{dhcp-relay-config-id}
Create or update DHCP relay configuration If DHCP relay config with the dhcp-relay-config-id is not already present, create a new DHCP relay config instance. If it already exists, replace the DHCP relay config instance with this object.	PUT /global-manager/api/v1/global-infra/dhcp-relay-configs/{dhcp-relay-config-id}
List DHCP server config instances Paginated list of all DHCP server config instances	GET /global-manager/api/v1/global-infra/dhcp-server-configs
Read DHCP server leases Read DHCP server leases	GET /global-manager/api/v1/global-infra/dhcp-server-configs/{config-id}/leases
Read DHCP server state Read DHCP server state	GET /global-manager/api/v1/global-infra/dhcp-server-configs/{config-id}/state
Read DHCP server statistics Read DHCP server statistics	GET /global-manager/api/v1/global-infra/dhcp-server-configs/{config-id}/stats
Reset DHCP server statistics counters Reset DHCP statistics counters of a DHCP server represented by the connectivity_path and the enforecement_point_path where the dhcp-server-config was applied to. The connectivity_path can be the Tier0 path, Tier1 path or a segment path. If the given Tier0/1 or Segment has DHCP server applied, the resetting will succeed and the DHCP statistics counters will be reset to 0. But if it has no DHCP server applied, the reseting will fail with proper error message.	POST /global-manager/api/v1/global-infra/dhcp-server-configs/{config-id}/stats?action=reset
Read DHCP server status Read DHCP server status	GET /global-manager/api/v1/global-infra/dhcp-server-configs/{config-id}/status
Delete DHCP server configuration Delete DHCP server configuration	DELETE /global-manager/api/v1/global-infra/dhcp-server-configs/{dhcp-server-config-id}
Read DHCP server configuration Read DHCP server configuration	GET /global-manager/api/v1/global-infra/dhcp-server-configs/{dhcp-server-config-id}
Create or update DHCP server configuration If DHCP server config with the dhcp-server-config-id is not already present, create a new DHCP server config instance. If it already exists, update the DHCP server config instance with specified attributes. Realized entities of this API can be found using the path of Tier-0, Tier1, or Segment where this config is applied on. Modification of edge_cluster_path in DhcpServerConfig will lose all existing DHCP leases. If both the preferred_edge_paths in the DhcpServerConfig are changed in a same PATCH API, e.g. change from [a,b] to [x,y], the current DHCP server leases will be lost, which could cause network connectivity issues. It is recommended to change only one member index in an update call, e.g. from [a, b] to [a,y]. Clearing preferred_edge_paths will not reassign edge nodes from the edge cluster. Instead, the previously-allocated edge nodes will be retained to avoid loss of leases.	PATCH /global-manager/api/v1/global-infra/dhcp-server-configs/{dhcp-server-config-id}
Create or update DHCP server configuration If DHCP server config with the dhcp-server-config-id is not already present, create a new DHCP server config instance. If it already exists, replace the DHCP server config instance with this object. Realized entities of this API can be found using the path of Tier-0, Tier1, or Segment where this config is applied on. Modification of edge_cluster_path in DhcpServerConfig will lose all existing DHCP leases. If both the preferred_edge_paths in the DhcpServerConfig are changed in a same PUT API, e.g. change from [a,b] to [x,y], the current DHCP server leases will be lost, which could cause network connectivity issues. It is recommended to change only one member index in an update call, e.g. from [a, b] to [a,y]. Clearing preferred_edge_paths will not reassign edge nodes from the edge cluster. Instead, the previously-allocated edge nodes will be retained to avoid loss of leases.	PUT /global-manager/api/v1/global-infra/dhcp-server-configs/{dhcp-server-config-id}
List Dns Forwarder Zones Paginated list of all Dns Forwarder Zones	GET /global-manager/api/v1/global-infra/dns-forwarder-zones
Delete the DNS Forwarder Zone Delete the DNS Forwarder Zone	DELETE /global-manager/api/v1/global-infra/dns-forwarder-zones/{dns-forwarder-zone-id}
Read the DNS Forwarder Zone Read the DNS Forwarder Zone	GET /global-manager/api/v1/global-infra/dns-forwarder-zones/{dns-forwarder-zone-id}
Create or update the DNS Forwarder Zone Create or update the DNS Forwarder Zone	PATCH /global-manager/api/v1/global-infra/dns-forwarder-zones/{dns-forwarder-zone-id}
Create or update the DNS Forwarder Zone Create or update the DNS Forwarder Zone	PUT /global-manager/api/v1/global-infra/dns-forwarder-zones/{dns-forwarder-zone-id}
Delete DHCP lease(s) specified by IP and MAC Delete one or multiple DHCP lease(s) specified by IP and MAC. If there is a DHCP server running upon the given segment, or this segment is using a DHCP server running in its connected Tier-0 or Tier-1, the DHCP lease(s) which match exactly the IP address and the MAC address will be deleted. If no such lease matches, the deletion for this lease will be ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.	POST /global-manager/api/v1/global-infra/segments/{segment-id}?action=delete_dhcp_leases
List all DHCP static bindings Paginated list of all DHCP static binding instances	GET /global-manager/api/v1/global-infra/segments/{segment-id}/dhcp-static-binding-configs
Delete DHCP static binding Delete DHCP static binding	DELETE /global-manager/api/v1/global-infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
Read DHCP static binding Read DHCP static binding	GET /global-manager/api/v1/global-infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
Create or update DHCP static binding If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with specified attributes.	PATCH /global-manager/api/v1/global-infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
Create or update DHCP static binding If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with this object.	PUT /global-manager/api/v1/global-infra/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
Read DHCP static binding state Read DHCP static binding state	GET /global-manager/api/v1/global-infra/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state
Delete DNS configuration for tier-0 instance Delete DNS configuration for tier-0 instance	DELETE /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder
Read the DNS Forwarder for the given tier-0 instance Read the DNS Forwarder for the given tier-0 instance	GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder
Update the DNS Forwarder Update the DNS Forwarder	PATCH /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder
Perform the specified DNS forwarder action Perform the specified action for Tier0 DNS forwarder on specified enforcement point.	POST /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder
Update the DNS Forwarder Update the DNS Forwarder	PUT /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder
Get the recent failed DNS queries Return the given count of recent failed DNS queries from DNS forwarder. Since the DNS forwarder is running in Active/Standby HA mode on transport nodes, the given count of queries will be returned from each nodes. Hence the total queries returned could be doubled. If no count is specified, 100 recent failed queries are returned. If the recent failures is less than the given count, all the failures will be returned. The maximum count is 1,000.	GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder/failed-queries
Resolve a given address via the dns forwarder at Tier0 Query the nameserver for an ip-address or a FQDN of the given an address optionally using an specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it. If the address is an ip-address, do a reverse lookup and answer fqdn(s). If enforcement point is specified, then DNS forwarder nslookup answer will get fetched from specified enforcement point. Otherwise from all enforcement points.	GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder/nslookup
Get tier-0 DNS forwarder statistics Get statistics of tier-0 DNS forwarder. - no enforcement point path specified: Statistics will be evaluated on each enforcement point. - {enforcement_point_path}: Statistics are evaluated only on the given enforcement point.	GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder/statistics
Get current status of tier-0 DNS forwarder Get current status of tier-0 DNS forwarder. - no enforcement point path specified: Status will be evaluated on each enforcement point. - {enforcement_point_path}: Status will be evaluated only on the given enforcement point.	GET /global-manager/api/v1/global-infra/tier-0s/{tier-0-id}/dns-forwarder/status
Delete DNS configuration for tier-1 instance Delete DNS configuration for tier-1 instance	DELETE /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder
Read the DNS Forwarder for the given tier-1 instance Read the DNS Forwarder for the given tier-1 instance	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder
Create or update the DNS Forwarder Create or update the DNS Forwarder	PATCH /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder
Perform the specified DNS forwarder action Perform the specified action for Tier0 DNS forwarder on specified enforcement point.	POST /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder
Create or update the DNS Forwarder Create or update the DNS Forwarder	PUT /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder
Get the recent failed DNS queries Return the given count of recent failed DNS queries from DNS forwarder. Since the DNS forwarder is running in Active/Standby HA mode on transport nodes, the given count of queries will be returned from each nodes. Hence the total queries returned could be doubled. If no count is specified, 100 recent failed queries are returned. If the recent failures is less than the given count, all the failures will be returned. The maximum count is 1,000.	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/failed-queries
Resolve a given address via the dns forwarder at Tier1 Query the nameserver for an ip-address or a FQDN of the given an address optionally using an specified DNS server. If the address is a fqdn, nslookup will resolve ip-address with it. If the address is an ip-address, do a reverse lookup and answer fqdn(s). If enforcement point is specified, then DNS forwarder nslookup answer will get fetched from specified enforcement point. Otherwise from all enforcement points.	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/nslookup
Get tier-1 DNS forwarder statistics Get statistics of tier-1 DNS forwarder. - no enforcement point path specified: Statistics will be evaluated on each enforcement point. - {enforcement_point_path}: Statistics are evaluated only on the given enforcement point.	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/statistics
Get current status of tier-1 DNS forwarder Get current status of tier-1 DNS forwarder. - no enforcement point path specified: Status will be evaluated on each enforcement point. - {enforcement_point_path}: Status will be evaluated only on the given enforcement point.	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/dns-forwarder/status
List all DHCP static bindings Paginated list of all DHCP static binding instances	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs
Delete DHCP static binding Delete DHCP static binding	DELETE /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
Read DHCP static binding Read DHCP static binding	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
Create or update DHCP static binding If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with specified attributes.	PATCH /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
Create or update DHCP static binding If binding with the binding-id is not already present, create a new DHCP static binding instance. If it already exists, replace the existing DHCP static binding instance with this object.	PUT /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-binding-configs/{binding-id}
Read DHCP static binding state Read DHCP static binding state	GET /global-manager/api/v1/global-infra/tier-1s/{tier-1-id}/segments/{segment-id}/dhcp-static-bindings/{binding-id}/state
Delete DHCP lease(s) specified by IP and MAC Delete one or multiple DHCP lease(s) specified by IP and MAC under a Tier-1. If there is a DHCP server running upon the given segment, or this segment is using a DHCP server running in its connected Tier-1, the DHCP lease(s) which match exactly the IP address and the MAC address will be deleted. If no such lease matches, the deletion for this lease will be ignored. The DHCP lease to be deleted will be removed by the system from both active and standby node. The system will report error if the DHCP lease could not be removed from both nodes. If the DHCP lease could not be removed on either node, please check the DHCP server status. Once the DHCP server status is UP, please invoke the deletion API again to ensure the lease gets deleted from both nodes.	POST /global-manager/api/v1/global-infra/tier-1s/{tier1-id}/segments/{segment-id}?action=delete_dhcp_leases