NSX API Guide 6 - VMware

1 NSX API Guide Update 13. Modified JULY 2020. VMware NSX Data Center for vSphere Page 1. Table of Contents Introduction 14. Endpoints 18. Working With vSphere Distributed Switches 18. Working With vSphere Distributed Switches in a Datacenter .. 19. Working With a Specific vSphere Distributed Switch .. 20. Working With Latency Configuration of a Specific vSphere Distributed Switch .. 21. Working With Latency Configuration of a Specific Host .. 23. Working With Segment ID Pools and Multicast Ranges 25. Working With Segment ID Pools.

2 25. Working With a Specific Segment ID Pool .. 26. Working With Multicast Address Ranges .. 27. Working With a Specific Multicast Address Range .. 28. Working With the VXLAN Port Configuration .. 29. Update the VXLAN Port Configuration .. 30. VXLAN Port Configuration Update Status .. 30. Resume VXLAN Port Configuration Update .. 31. Working With Allocated Resources .. 31. Resolving Missing VXLAN VMKernel Adapters .. 31. Working With Controller Disconnected Operation (CDO) Mode 33. Working With Transport Zones 35.

3 Working With a Specific Transport Zone .. 38. Working With Transport Zone Attributes .. 41. Working With Transport Zone CDO Mode .. 42. Testing Multicast Group Connectivity .. 42. Working With Logical Switches in a Specific Transport Zone 44. Working With Traceflow 45. Working With a Specific Traceflow .. 45. Traceflow Observations .. 46. Working With Logical Switches in All Transport Zones 50. Working Virtual Machine Connections to Logical Switches .. 52. Working With a Specific Logical Switch .. 52. Resolving Missing Port Groups for a Logical Switch.

4 54. Testing Host Connectivity .. 55. Testing Point-to-Point Connectivity .. 55. Working With Hardware Gateway Bindings for a Specific Logical Switch .. 56. Working With Connections Between Hardware Gateways and Logical Switches .. 57. Working With IP Discovery and MAC Learning for Logical Switches 59. Working With NSX Controllers 61. Working With Controller Upgrade Availability .. 62. Working With of Controller Job Status .. 62. NSX API Guide Version: Page 2. Working With a Specific Controller .. 62. Working With NSX Controller System Statistics.

5 64. Working With Controller Tech Support Logs .. 66. Working With Controller Syslog Configuration .. 66. Working With Controller Cluster Snapshots .. 68. Working With the NSX Controller Cluster Configuration .. 68. Working With Controller Cluster NTP Settings .. 69. Working With Controller Cluster DNS Settings .. 70. Working With Controller Cluster Syslog Configuration .. 71. Working With Controller Cluster Upgrade .. 73. Working With the NSX Controller Password .. 73. Working With Controller Synchronization.

6 73. Working with Controller Synchronization Status .. 74. Working With Host Health Status Using BFD 75. Working with overall information about host health status .. 75. Working with health status for a specific host .. 76. Working with tunnel connections for a specific host .. 77. Working with remote host status .. 78. Working With BFD Global Configuration 81. Working With pNIC Configuration Information 83. Working With Services Grouping Objects 85. Retrieve Services from a Specific Scope .. 85. Create a Service on a Specific Scope.

7 85. Working With a Specified Service .. 85. Working With Service Groups Grouping Objects 88. Creating Service Groups on a Specific Scope .. 88. Working With Service Groups on a Specific Scope .. 88. Working With a Specific Service Group .. 88. Working With a Specific Service Group Member .. 90. Working With Service Group Members on a Specific Scope .. 90. Working With IP Pool Grouping Objects 91. Working With IP Pools on a Specific Scope .. 91. Working With a Specific IP Pool .. 92. Working With IP Pool Address Allocations.

8 94. Working With Specific IPs Allocated to an IP Pool .. 95. Working With Licensing 96. Working With Licensing Capacity .. 96. Working With Licensing Status .. 97. Working With Security Tags 98. Managing Security Tags .. 98. Delete a Security Tag .. 100. Working With Virtual Machines on a Specific Security Tag .. 100. Manage a Security Tag on a Virtual Machine .. 101. Working With Virtual Machine Details for a Specific Security Tag .. 102. NSX API Guide Version: Page 3. Working With Security Tags on a Specific Virtual Machine.

9 103. Working With Security Tags Unique ID Selection Criteria .. 104. Working With NSX Manager SSO Registration 106. Working With SSO Configuration Status .. 106. Working With User Management 107. Manage Users on NSX Manager .. 107. Working With User Account State .. 107. Manage NSX Roles for Users .. 107. Working With NSX Manager Role Assignment .. 109. Working With Available NSX Manager Roles .. 109. Working With Scoping Objects .. 110. Working with API Authentication 111. Working with Basic Authentication.

10 111. Working with API Tokens .. 112. Working With API Token Expiration .. 112. Working With Token Invalidation .. 113. Working with API Authentication 115. Working With Security Group Grouping Objects 116. Creating New Security Groups With Members .. 116. Creating New Security Groups Without Members .. 118. Updating a Specific Security Group Including Membership .. 119. Working With a Specific Security Group .. 120. Working With Members of a Specific Security Group .. 121. Working With Virtual Machines in a Security Group.