| API Description | API Path |
|---|---|
Read Cluster ConfigurationReturns information about the NSX cluster configuration. An NSX cluster has two functions or purposes, commonly referred to as "roles." These two roles are control and management. Each NSX installation has a single cluster. Separate NSX clusters do not share data. In other words, a given data-plane node is attached to only one cluster, not to multiple clusters. |
GET /api/v1/cluster
|
Join this node to a NSX Cluster |
POST /api/v1/cluster?action=join_cluster
|
Read cluster node configurationReturns information about the specified NSX cluster node. |
GET /api/v1/cluster/<node-id>
|
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>
|
Get backup frames for UIReturns list of backup frames and some metadata to be used by UI. |
GET /api/v1/cluster/backups/ui_frames
|
List Cluster Node ConfigurationsReturns information about all NSX cluster nodes. Deprecated. Use GET /cluster to get cluster configuration. |
GET /api/v1/cluster/nodes
(Deprecated)
|
Add a controller to the clusterAdd a new controller to the NSX cluster. Deprecated. Use POST /cluster?action=join_cluster to join a node to cluster. The controller comes with the new node. |
POST /api/v1/cluster/nodes
(Deprecated)
|
Remove a controller from the clusterRemoves the specified controller from the NSX cluster. Before you can remove a controller from the cluster, you must shut down the controller service with the "stop service controller" command. Deprecated. Use POST /cluster/ to detach a node from cluster. The controller is removed with the node. |
DELETE /api/v1/cluster/nodes/<node-id>
(Deprecated)
|
Read Cluster Node ConfigurationReturns information about the specified NSX cluster node. Deprecated. Use GET /cluster/ |
GET /api/v1/cluster/nodes/<node-id>
(Deprecated)
|