System Administration > Configuration > Fabric > Nodes > NSX Manager

Associated URIs:

API Description API Path

Read the NSX Manager/Controller's Network Interface Statistics


On the specified interface, returns the number of received (rx), transmitted
(tx), and dropped packets; the number of bytes and errors received and
transmitted on the interface; and the number of detected collisions.
GET /api/v1/cluster/nodes/<node-id>/network/interfaces/<interface-id>/stats

Delete management plane configuration for this node


Delete the management plane configuration for this node.
DELETE /api/v1/node/management-plane
DELETE /api/v1/cluster/<cluster-node-id>/node/management-plane

Get management plane configuration for this node


Retrieve the management plane configuration for this node to identify the Manager node with which the controller service is communicating.
GET /api/v1/node/management-plane (Experimental)
GET /api/v1/cluster/<cluster-node-id>/node/management-plane (Experimental)

Update management plane configuration for this node


Update the management plane configuration for this node.
PUT /api/v1/node/management-plane (Experimental)
PUT /api/v1/cluster/<cluster-node-id>/node/management-plane (Experimental)

NodeMode


Returns current Node Mode.
GET /api/v1/node/mode
GET /api/v1/cluster/<cluster-node-id>/node/mode

Read the Async Replicator service properties


GET /api/v1/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/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/cluster/<cluster-node-id>/node/services/async_replicator/status

Read cluster boot manager service properties


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

Restart, start or stop the cluster boot manager service


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

Read cluster boot manager service status


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

Read cm inventory service properties


GET /api/v1/cluster/<cluster-node-id>/node/services/cm-inventory
GET /api/v1/node/services/cm-inventory

Restart, start or stop the manager service


POST /api/v1/node/services/cm-inventory?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/cm-inventory?action=start|stop|restart

Read manager service status


GET /api/v1/cluster/<cluster-node-id>/node/services/cm-inventory/status
GET /api/v1/node/services/cm-inventory/status

Read controller service properties


GET /api/v1/node/services/controller
GET /api/v1/cluster/<cluster-node-id>/node/services/controller

Restart, start or stop the controller service


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

Read controller server certificate properties


GET /api/v1/cluster/<cluster-node-id>/node/services/controller/controller-certificate
GET /api/v1/node/services/controller/controller-certificate

Get the status (Enabled/Disabled) of controller profiler


GET /api/v1/node/services/controller/profiler
GET /api/v1/cluster/<cluster-node-id>/node/services/controller/profiler

Enable or disable controller profiler


PUT /api/v1/node/services/controller/profiler
PUT /api/v1/cluster/<cluster-node-id>/node/services/controller/profiler

Read controller service status


GET /api/v1/cluster/<cluster-node-id>/node/services/controller/status
GET /api/v1/node/services/controller/status

Read NSX Edge Dispatcher service properties


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

Restart, start or stop the NSX Edge Dispatcher service


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

Read NSX Edge Dispatcher service status


GET /api/v1/transport-nodes/<transport-node-id>/node/services/dispatcher/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/cluster/<cluster-node-id>/node/services/http (Deprecated)
GET /api/v1/node/services/http (Deprecated)

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/cluster/<cluster-node-id>/node/services/http?action=apply_certificate
POST /api/v1/node/services/http?action=apply_certificate

Stop the http service


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

Start the http service


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

Restart the http service


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

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/cluster/<cluster-node-id>/node/services/http (Deprecated)
PUT /api/v1/node/services/http (Deprecated)

Read http service status


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

Read the idps-reporting service properties


GET /api/v1/cluster/<cluster-node-id>/node/services/idps-reporting
GET /api/v1/node/services/idps-reporting

Restart, start or stop the idps-reporting service


POST /api/v1/node/services/idps-reporting?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/idps-reporting?action=restart|start|stop

Read the idps-reporting service status


GET /api/v1/node/services/idps-reporting/status
GET /api/v1/cluster/<cluster-node-id>/node/services/idps-reporting/status

Read NSX install-upgrade service properties


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

Restart, start or stop the NSX install-upgrade service


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

Update NSX install-upgrade service properties


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

Read NSX install-upgrade service status


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

Update UC state properties


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

Update NSX Edge NSXA service properties


PUT /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller

Read service properties


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

Reset the logging levels to default values


POST /api/v1/cluster/<cluster-node-id>/node/services/manager?action=reset-manager-logging-levels
POST /api/v1/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/cluster/<cluster-node-id>/node/services/manager?action=start|stop|restart

Update service properties


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

Read service status


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

Read NSX Messaging Manager service properties


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

Restart, start or stop the NSX Messaging Manager service


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

Read NSX Messaging Manager service status


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

Read Metadata-proxy service properties


GET /api/v1/transport-nodes/<transport-node-id>/node/services/metadata-proxy

Read Metadata-proxy service status


GET /api/v1/transport-nodes/<transport-node-id>/node/services/metadata-proxy/status

Read migration coordinator service properties


GET /api/v1/node/services/migration-coordinator
GET /api/v1/cluster/<cluster-node-id>/node/services/migration-coordinator

Restart, start or stop the migration coordinator service


POST /api/v1/node/services/migration-coordinator?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/migration-coordinator?action=start|stop|restart

Read migration coordinator service status


GET /api/v1/node/services/migration-coordinator/status
GET /api/v1/cluster/<cluster-node-id>/node/services/migration-coordinator/status

Read NSX node-stats service properties


GET /api/v1/cluster/<cluster-node-id>/node/services/node-stats
GET /api/v1/node/services/node-stats

Restart, start or stop the NSX node-stats service


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

Read NSX node-stats service status


GET /api/v1/node/services/node-stats/status
GET /api/v1/cluster/<cluster-node-id>/node/services/node-stats/status

Read NSX Control Plane Agent service properties


GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent

Restart, start or stop the NSX Control Plane Agent service


POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent?action=restart|start|stop

Read NSX Control Plane Agent service status


GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent/status

Read service properties


GET /api/v1/cluster/<cluster-node-id>/node/services/policy
GET /api/v1/node/services/policy

Restart, start or stop the service


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

Reset the logging levels to default values


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

Update service properties


PUT /api/v1/cluster/<cluster-node-id>/node/services/policy
PUT /api/v1/node/services/policy

Read service status


GET /api/v1/node/services/policy/status
GET /api/v1/cluster/<cluster-node-id>/node/services/policy/status

Read NSX Search service properties


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

Restart, start or stop the NSX Search service


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

Read NSX Search service status


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

Read Telemetry service properties


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

Restart, start or stop Telemetry service


POST /api/v1/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/cluster/<cluster-node-id>/node/services/telemetry/status

Read ui service properties


GET /api/v1/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/cluster/<cluster-node-id>/node/services/ui-service?action=restart|start|stop
POST /api/v1/node/services/ui-service?action=restart|start|stop

Read ui service status


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