System Administration >
Configuration
>
NSX Managers
>
Clusters
>
Cluster Virtual IP
Set cluster virtual IP address
Sets the cluster virtual IP address. Note, all nodes in the management
cluster must be in the same subnet. If not, a 409 CONFLICT status is
returned.
Request:
Method:
POST
URI Path(s):
/api/v1/cluster/api-virtual-ip?action=set_virtual_ip
Request Headers:
n/a
Query Parameters:
ClusterVirtualIpProperties
+
ClusterVirtualIpProperties
(
schema
)
Name
Description
Type
Notes
ip_address
Virtual IP address, 0.0.0.0 if not configured
string
Required
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
+
ClusterVirtualIpProperties
(
schema
)
Name
Description
Type
Notes
ip_address
Virtual IP address, 0.0.0.0 if not configured
string
Required
Example Response:
{ "_schema": "ClusterVirtualIpProperties", "_self": { "href": "/cluster/api-virtual-ip", "rel": "self" }, "ip_address": "10.0.0.251" }
Required Permissions:
crud
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