System Administration > Configuration > NSX Managers > Clusters > Cluster Virtual IP

Associated URIs:

API Description API Path

Read cluster virtual IP addresses


Returns the configured cluster virtual IPv4 and IPv6 address or null if not configured.
GET /api/v1/cluster/api-virtual-ip

Clear cluster virtual IP address


Clears the cluster virtual IPv4 or IPv6 address.
Note, query parameter
?action=clear_virtual_ip clears virtual IPv4 address
and ?action=clear_virtual_ip6 clears virtual IPv6 address.
POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip|clear_virtual_ip6

Set cluster virtual IP addresses


Sets the cluster virtual IPv4 and IPv6 address. Note, all nodes in the management
cluster must be in the same subnet. If not, a 409 CONFLICT status is
returned.
Query parameter ip_address sets virtual IPv4 address
and ip6_address sets virtual IPv6 address; either or both of the parameters
can be specified to set virtual IP address(es).
When updating either of any one parameter
value this does not changes the value of other unspecified parameter.
POST /api/v1/cluster/api-virtual-ip?action=set_virtual_ip