System Administration > Configuration > NSX Managers > Clusters

Associated URIs:

API Description API Path

Join this node to a NSX Cluster


POST /api/v1/cluster?action=join_cluster

Detach a node from the Cluster


POST /api/v1/cluster/<node-id>?action=remove_node

Invoke DELETE request on target cluster node


DELETE /api/v1/cluster/<target-node-id>/<target-uri>

Invoke GET request on target cluster node


GET /api/v1/cluster/<target-node-id>/<target-uri>

Invoke POST request on target cluster node


POST /api/v1/cluster/<target-node-id>/<target-uri>

Invoke PUT request on target cluster node


PUT /api/v1/cluster/<target-node-id>/<target-uri>

Read cluster certificate ID


Returns the ID of the certificate that is used as the cluster certificate for MP
GET /api/v1/cluster/api-certificate

Clear the cluster certificate


Clears the certificate used for the MP cluster.
This does not affect the certificate itself.
This API is deprecated. Instead use the
/api/v1/cluster/api-certificate?action=set_cluster_certificate API to set
the cluster certificate to a different one.
It just means that from now on, individual certificates will be used on
each MP node. This affects all nodes in the cluster.
POST /api/v1/cluster/api-certificate?action=clear_cluster_certificate (Deprecated)

Set the cluster certificate


Sets the certificate used for the MP cluster.
This affects all nodes in the cluster. If the certificate used is a CA signed
certificate,the request fails if the whole chain(leaf, intermediate, root)
is not imported.
POST /api/v1/cluster/api-certificate?action=set_cluster_certificate

Read cluster virtual IP address


Returns the configured cluster virtual IP address or null if not configured.
GET /api/v1/cluster/api-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.
POST /api/v1/cluster/api-virtual-ip?action=set_virtual_ip

Clear cluster virtual IP address


Clears the cluster virtual IP address.
POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip

Get backup frames for UI


Returns list of backup frames and some metadata to be used by UI.
GET /api/v1/cluster/backups/ui_frames