System Administration >
Configuration
>
NSX Managers
>
Clusters
>
Cluster Virtual IP
Read cluster virtual IP addresses
Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.
Request:
Method:
GET
URI Path(s):
/api/v1/cluster/api-virtual-ip
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
n/a
Example Request:
GET https://<nsx-mgr>/api/v1/cluster/api-virtual-ip
Successful Response:
Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ClusterVirtualIpProperties
+
ClusterVirtualIpProperties
(
schema
)
Name
Description
Type
Notes
force
On enable it ignores duplicate address detection and DNS lookup validation check
string
Enum: true, false
Default: "false"
ip6_address
Virtual IPv6 address, :: if not configured
string
ip_address
Virtual IP address, 0.0.0.0 if not configured
string
Example Response:
{ "_schema": "ClusterVirtualIpProperties", "_self": { "href": "/cluster/api-virtual-ip", "rel": "self" }, "ip_address": 0.0.0.0, "ip6_address": fd01:1:2:2918:250:56ff:fe8b:7e4d }
Required Permissions:
read
Feature:
cluster_management
Additional Errors:
301 Moved Permanently
307 Temporary Redirect
400 Bad Request
403 Forbidden
409 Conflict
412 Precondition Failed
500 Internal Server Error
503 Service Unavailable