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

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.

Request:

Method:
POST
URI Path(s):
/api/v1/cluster/api-virtual-ip?action=set_virtual_ip
Request Headers:
n/a
Query Parameters:
ClusterVirtualIpProperties+
Request Body:
n/a

Example Request:

POST https://<nsx-mgr>/api/v1/cluster/api-virtual-ip?action=set_virtual_ip&ip_address=10.0.0.251

Successful Response:

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

Example Response:

{ "_schema": "ClusterVirtualIpProperties", "_self": { "href": "/cluster/api-virtual-ip", "rel": "self" }, "ip_address": "10.0.0.251", "ip6_address": "fd01:1:2:2918:250:56ff:fe8b:7e4d" }

Required Permissions:

crud

Feature:

cluster_management

Additional Errors: