System Administration > Configuration > NSX Managers

Associated URIs:

API Description API Path

Register a Collection of API Calls at a Single End Point


Enables you to make multiple API requests using a single request. The batch
API takes in an array of logical HTTP requests represented as JSON arrays.
Each request has a method (GET, PUT, POST, or DELETE), a relative_url (the
portion of the URL after https://<nsx-mgr>/api/), optional headers
array (corresponding to HTTP headers) and an optional body (for POST and PUT
requests). The batch API returns an array of logical HTTP responses
represented as JSON arrays. Each response has a status code, an optional
headers array and an optional body (which is a JSON-encoded string).
POST /policy/api/v1/batch

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 API service properties


Read the configuration of the NSX API service.
GET /api/v1/cluster/api-service

Update API service properties


Read the configuration of the NSX API service. Changes are applied to all nodes in the cluster. The API service on each node will restart after it is updated using this API. There may be a delay of up to a minute or so between the time this API call completes and when the new configuration goes into effect.
PUT /api/v1/cluster/api-service

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

Read NSX Management nodes global configuration.


Returns the NSX Management nodes global configuration.
GET /policy/api/v1/configs/management

Update NSX Management nodes global configuration


Modifies the NSX Management nodes global configuration.
PUT /policy/api/v1/configs/management

Read Central Config properties


GET /api/v1/node/central-config
GET /api/v1/transport-nodes/<transport-node-id>/node/central-config
GET /api/v1/cluster/<cluster-node-id>/node/central-config

Update Central Config properties


PUT /api/v1/node/central-config
PUT /api/v1/transport-nodes/<transport-node-id>/node/central-config
PUT /api/v1/cluster/<cluster-node-id>/node/central-config

Gets the enable status for Mandatory Access Control


GET /api/v1/node/hardening-policy/mandatory-access-control
GET /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control
GET /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control

Enable or disable Mandatory Access Control


PUT /api/v1/node/hardening-policy/mandatory-access-control
PUT /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control
PUT /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control

Get the report for Mandatory Access Control


GET /api/v1/node/hardening-policy/mandatory-access-control/report
GET /api/v1/transport-nodes/<transport-node-id>/node/hardening-policy/mandatory-access-control/report
GET /api/v1/cluster/<cluster-node-id>/node/hardening-policy/mandatory-access-control/report

Delete RabbitMQ management port


DELETE /api/v1/node/rabbitmq-management-port
DELETE /api/v1/transport-nodes/<transport-node-id>/node/rabbitmq-management-port
DELETE /api/v1/cluster/<cluster-node-id>/node/rabbitmq-management-port

Check if RabbitMQ management port is enabled or not


Returns status as true if RabbitMQ management port is enabled else false
GET /api/v1/node/rabbitmq-management-port
GET /api/v1/transport-nodes/<transport-node-id>/node/rabbitmq-management-port
GET /api/v1/cluster/<cluster-node-id>/node/rabbitmq-management-port

Set RabbitMQ management port


POST /api/v1/node/rabbitmq-management-port
POST /api/v1/transport-nodes/<transport-node-id>/node/rabbitmq-management-port
POST /api/v1/cluster/<cluster-node-id>/node/rabbitmq-management-port

Read the Async Replicator service properties


GET /api/v1/node/services/async_replicator
GET /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator
GET /api/v1/cluster/<cluster-node-id>/node/services/async_replicator

Restart, start or stop the Async Replicator service


POST /api/v1/node/services/async_replicator?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/async_replicator?action=restart|start|stop

Read the Async Replicator service status


GET /api/v1/node/services/async_replicator/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/async_replicator/status
GET /api/v1/cluster/<cluster-node-id>/node/services/async_replicator/status

Read cluster boot manager service properties


GET /api/v1/node/services/cluster_manager
GET /api/v1/transport-nodes/<transport-node-id>/node/services/cluster_manager
GET /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager

Restart, start or stop the cluster boot manager service


POST /api/v1/node/services/cluster_manager?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/cluster_manager?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager?action=start|stop|restart

Read cluster boot manager service status


GET /api/v1/node/services/cluster_manager/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/cluster_manager/status
GET /api/v1/cluster/<cluster-node-id>/node/services/cluster_manager/status

Read service properties


GET /api/v1/node/services/global-manager
GET /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager
GET /api/v1/cluster/<cluster-node-id>/node/services/global-manager

Disable Global Manager service


POST /api/v1/node/services/global-manager?action=disable
POST /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager?action=disable
POST /api/v1/cluster/<cluster-node-id>/node/services/global-manager?action=disable

Enable Global Manager service


POST /api/v1/node/services/global-manager?action=enable
POST /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager?action=enable
POST /api/v1/cluster/<cluster-node-id>/node/services/global-manager?action=enable

Restart, start or stop the service


POST /api/v1/node/services/global-manager?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/global-manager?action=start|stop|restart

Reset the logging levels to default values


POST /api/v1/node/services/global-manager?action=reset-manager-logging-levels
POST /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager?action=reset-manager-logging-levels
POST /api/v1/cluster/<cluster-node-id>/node/services/global-manager?action=reset-manager-logging-levels

Update service properties


PUT /api/v1/node/services/global-manager
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager
PUT /api/v1/cluster/<cluster-node-id>/node/services/global-manager

Read service status


GET /api/v1/node/services/global-manager/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/global-manager/status
GET /api/v1/cluster/<cluster-node-id>/node/services/global-manager/status

Read http service properties


This API is deprecated. Read the configuration of the
http service by calling the GET /api/v1/cluster/api-service API.
GET /api/v1/node/services/http (Deprecated)
GET /api/v1/transport-nodes/<transport-node-id>/node/services/http (Deprecated)
GET /api/v1/cluster/<cluster-node-id>/node/services/http (Deprecated)

Start the http service


POST /api/v1/node/services/http?action=start
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=start
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=start

Update http service certificate


Applies a security certificate to the http service. In the POST request,
the CERTIFICATE_ID references a certificate created with the
/api/v1/trust-management APIs. 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/node/services/http?action=apply_certificate
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=apply_certificate
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=apply_certificate

Restart the http service


POST /api/v1/node/services/http?action=restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=restart
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=restart

Stop the http service


POST /api/v1/node/services/http?action=stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=stop
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=stop

Update http service properties


This API is deprecated. Make changes to the http service
configuration by calling the PUT /api/v1/cluster/api-service API.
PUT /api/v1/node/services/http (Deprecated)
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/http (Deprecated)
PUT /api/v1/cluster/<cluster-node-id>/node/services/http (Deprecated)

Read http service status


GET /api/v1/node/services/http/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/http/status
GET /api/v1/cluster/<cluster-node-id>/node/services/http/status

Read NSX install-upgrade service properties


GET /api/v1/node/services/install-upgrade
GET /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade
GET /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade

Restart, start or stop the NSX install-upgrade service


POST /api/v1/node/services/install-upgrade?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade?action=restart|start|stop

Update NSX install-upgrade service properties


PUT /api/v1/node/services/install-upgrade
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade
PUT /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade

Read NSX install-upgrade service status


GET /api/v1/node/services/install-upgrade/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade/status
GET /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade/status

Update UC state properties


PUT /api/v1/node/services/install-upgrade/uc-state
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/install-upgrade/uc-state
PUT /api/v1/cluster/<cluster-node-id>/node/services/install-upgrade/uc-state

Read service properties


GET /api/v1/node/services/manager
GET /api/v1/transport-nodes/<transport-node-id>/node/services/manager
GET /api/v1/cluster/<cluster-node-id>/node/services/manager

Reset the logging levels to default values


POST /api/v1/node/services/manager?action=reset-manager-logging-levels
POST /api/v1/transport-nodes/<transport-node-id>/node/services/manager?action=reset-manager-logging-levels
POST /api/v1/cluster/<cluster-node-id>/node/services/manager?action=reset-manager-logging-levels

Restart, start or stop the service


POST /api/v1/node/services/manager?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/manager?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/manager?action=start|stop|restart

Update service properties


PUT /api/v1/node/services/manager
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/manager
PUT /api/v1/cluster/<cluster-node-id>/node/services/manager

Read service status


GET /api/v1/node/services/manager/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/manager/status
GET /api/v1/cluster/<cluster-node-id>/node/services/manager/status

Read Rabbit MQ service properties


GET /api/v1/node/services/mgmt-plane-bus
GET /api/v1/transport-nodes/<transport-node-id>/node/services/mgmt-plane-bus
GET /api/v1/cluster/<cluster-node-id>/node/services/mgmt-plane-bus

Restart, start or stop the Rabbit MQ service


POST /api/v1/node/services/mgmt-plane-bus?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/mgmt-plane-bus?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/mgmt-plane-bus?action=restart|start|stop

Read Rabbit MQ service status


GET /api/v1/node/services/mgmt-plane-bus/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/mgmt-plane-bus/status
GET /api/v1/cluster/<cluster-node-id>/node/services/mgmt-plane-bus/status

Read NSX Message Bus service properties


GET /api/v1/node/services/nsx-message-bus
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-message-bus
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus

Restart, start or stop the NSX Message Bus service


POST /api/v1/node/services/nsx-message-bus?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-message-bus?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus?action=restart|start|stop

Read NSX Message Bus service status


GET /api/v1/node/services/nsx-message-bus/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-message-bus/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-message-bus/status

Read NSX Search service properties


GET /api/v1/node/services/search
GET /api/v1/transport-nodes/<transport-node-id>/node/services/search
GET /api/v1/cluster/<cluster-node-id>/node/services/search

Restart, start or stop the NSX Search service


POST /api/v1/node/services/search?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/search?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/search?action=restart|start|stop

Read NSX Search service status


GET /api/v1/node/services/search/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/search/status
GET /api/v1/cluster/<cluster-node-id>/node/services/search/status

Read Telemetry service properties


GET /api/v1/node/services/telemetry
GET /api/v1/transport-nodes/<transport-node-id>/node/services/telemetry
GET /api/v1/cluster/<cluster-node-id>/node/services/telemetry

Restart, start or stop Telemetry service


POST /api/v1/node/services/telemetry?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/telemetry?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/telemetry?action=restart|start|stop

Read Telemetry service status


GET /api/v1/node/services/telemetry/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/telemetry/status
GET /api/v1/cluster/<cluster-node-id>/node/services/telemetry/status

Read ui service properties


GET /api/v1/node/services/ui-service
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ui-service
GET /api/v1/cluster/<cluster-node-id>/node/services/ui-service

Restart, Start and Stop the ui service


POST /api/v1/node/services/ui-service?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ui-service?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/ui-service?action=restart|start|stop

Read ui service status


GET /api/v1/node/services/ui-service/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ui-service/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ui-service/status