System Administration > Configuration > NSX Managers > Clusters > Cluster 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.

Request:

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

Example Request:

POST https://<nsx-mgr>/api/v1/cluster/api-virtual-ip?action=clear_virtual_ip

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": 0.0.0.0, "ip6_address": "::" }

Required Permissions:

crud

Feature:

cluster_management

Additional Errors: