| 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/cluster/{cluster-node-id}/node/management-plane
DELETE /api/v1/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/cluster/{cluster-node-id}/node/management-plane
(Experimental)
GET /api/v1/node/management-plane
(Experimental)
|
Update management plane configuration for this node
Update the management plane configuration for this node.
|
PUT /api/v1/cluster/{cluster-node-id}/node/management-plane
(Experimental)
PUT /api/v1/node/management-plane
(Experimental)
|
NodeMode
Returns current Node Mode.
|
GET /api/v1/cluster/{cluster-node-id}/node/mode
GET /api/v1/node/mode
|
Read the Async Replicator service properties
|
GET /api/v1/cluster/{cluster-node-id}/node/services/async_replicator
GET /api/v1/node/services/async_replicator
|
Restart, start or stop the Async Replicator service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/async_replicator?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/async_replicator?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/async_replicator?action=stop
POST /api/v1/node/services/async_replicator?action=restart
POST /api/v1/node/services/async_replicator?action=start
POST /api/v1/node/services/async_replicator?action=stop
|
Read the Async Replicator service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/async_replicator/status
GET /api/v1/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
POST /api/v1/cluster/{cluster-node-id}/node/services/cluster_manager?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/cluster_manager?action=restart
POST /api/v1/node/services/cluster_manager?action=start
POST /api/v1/node/services/cluster_manager?action=stop
POST /api/v1/node/services/cluster_manager?action=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/cluster/{cluster-node-id}/node/services/cm-inventory?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/cm-inventory?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/cm-inventory?action=restart
POST /api/v1/node/services/cm-inventory?action=start
POST /api/v1/node/services/cm-inventory?action=stop
POST /api/v1/node/services/cm-inventory?action=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/cluster/{cluster-node-id}/node/services/controller
GET /api/v1/node/services/controller
|
Restart, start or stop the controller service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/controller?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/controller?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/controller?action=stop
POST /api/v1/node/services/controller?action=restart
POST /api/v1/node/services/controller?action=start
POST /api/v1/node/services/controller?action=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/cluster/{cluster-node-id}/node/services/controller/profiler
GET /api/v1/node/services/controller/profiler
|
Enable or disable controller profiler
|
PUT /api/v1/cluster/{cluster-node-id}/node/services/controller/profiler
PUT /api/v1/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 the Corfu Server service properties
|
GET /api/v1/cluster/{cluster-node-id}/node/services/datastore
GET /api/v1/node/services/datastore
|
Restart, start or stop the Corfu Server service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore?action=stop
POST /api/v1/node/services/datastore?action=restart
POST /api/v1/node/services/datastore?action=start
POST /api/v1/node/services/datastore?action=stop
|
Get the status of Corfu Certificate Expiry Check. Enabled or disabled
|
GET /api/v1/cluster/{cluster-node-id}/node/services/datastore/corfu_cert_expiry_check
GET /api/v1/node/services/datastore/corfu_cert_expiry_check
|
Enable or Disable Corfu Certificate Expiry Check. Default is enabled
|
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore/corfu_cert_expiry_check?action=enable
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore/corfu_cert_expiry_check?action=disable
POST /api/v1/node/services/datastore/corfu_cert_expiry_check?action=enable
POST /api/v1/node/services/datastore/corfu_cert_expiry_check?action=disable
|
Read the Corfu Server service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/datastore/status
GET /api/v1/node/services/datastore/status
|
Read the Corfu Log Replication Server service properties
|
GET /api/v1/cluster/{cluster-node-id}/node/services/datastore_log_replication
GET /api/v1/node/services/datastore_log_replication
|
Restart, start or stop the Corfu Log Replication Server service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore_log_replication?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore_log_replication?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore_log_replication?action=stop
POST /api/v1/node/services/datastore_log_replication?action=restart
POST /api/v1/node/services/datastore_log_replication?action=start
POST /api/v1/node/services/datastore_log_replication?action=stop
|
Read the Corfu Log Replication Server service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/datastore_log_replication/status
GET /api/v1/node/services/datastore_log_replication/status
|
Read the Corfu Nonconfig Server service properties
|
GET /api/v1/cluster/{cluster-node-id}/node/services/datastore_nonconfig
GET /api/v1/node/services/datastore_nonconfig
|
Restart, start or stop the Corfu Nonconfig Server service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore_nonconfig?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore_nonconfig?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/datastore_nonconfig?action=stop
POST /api/v1/node/services/datastore_nonconfig?action=restart
POST /api/v1/node/services/datastore_nonconfig?action=start
POST /api/v1/node/services/datastore_nonconfig?action=stop
|
Read the Corfu Nonconfig Server service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/datastore_nonconfig/status
GET /api/v1/node/services/datastore_nonconfig/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
POST /api/v1/transport-nodes/{transport-node-id}/node/services/dispatcher?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/dispatcher?action=stop
|
Read NSX Edge Dispatcher service status
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/dispatcher/status
|
Read http service properties
Read http service properties. To read fields deprecated in this API,
checkout API GET /api/v1/cluster/api-service.
|
GET /api/v1/cluster/{cluster-node-id}/node/services/http
GET /api/v1/node/services/http
|
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
(Deprecated)
POST /api/v1/node/services/http?action=apply_certificate
(Deprecated)
|
Stop the http service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/http?action=stop
POST /api/v1/node/services/http?action=stop
|
Start the http service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/http?action=start
POST /api/v1/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
Update http service properties. To update fields deprecated in this API,
checkout API PUT /api/v1/cluster/api-service.
|
PUT /api/v1/cluster/{cluster-node-id}/node/services/http
PUT /api/v1/node/services/http
|
Read http service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/http/status
GET /api/v1/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/cluster/{cluster-node-id}/node/services/idps-reporting?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/idps-reporting?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/idps-reporting?action=stop
POST /api/v1/node/services/idps-reporting?action=restart
POST /api/v1/node/services/idps-reporting?action=start
POST /api/v1/node/services/idps-reporting?action=stop
|
Read the idps-reporting service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/idps-reporting/status
GET /api/v1/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
POST /api/v1/cluster/{cluster-node-id}/node/services/install-upgrade?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/install-upgrade?action=stop
POST /api/v1/node/services/install-upgrade?action=restart
POST /api/v1/node/services/install-upgrade?action=start
POST /api/v1/node/services/install-upgrade?action=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/cluster/{cluster-node-id}/node/services/manager?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/manager?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/manager?action=restart
POST /api/v1/node/services/manager?action=start
POST /api/v1/node/services/manager?action=stop
POST /api/v1/node/services/manager?action=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/cluster/{cluster-node-id}/node/services/manager/status
GET /api/v1/node/services/manager/status
|
Read NSX Messaging Manager service properties
|
GET /api/v1/cluster/{cluster-node-id}/node/services/messaging-manager
GET /api/v1/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
POST /api/v1/cluster/{cluster-node-id}/node/services/messaging-manager?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/messaging-manager?action=stop
POST /api/v1/node/services/messaging-manager?action=restart
POST /api/v1/node/services/messaging-manager?action=start
POST /api/v1/node/services/messaging-manager?action=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/cluster/{cluster-node-id}/node/services/migration-coordinator
GET /api/v1/node/services/migration-coordinator
|
Restart, start or stop the migration coordinator service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/migration-coordinator?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/migration-coordinator?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/migration-coordinator?action=restart
POST /api/v1/node/services/migration-coordinator?action=start
POST /api/v1/node/services/migration-coordinator?action=stop
POST /api/v1/node/services/migration-coordinator?action=restart
|
Read migration coordinator service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/migration-coordinator/status
GET /api/v1/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
POST /api/v1/cluster/{cluster-node-id}/node/services/node-stats?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/node-stats?action=stop
POST /api/v1/node/services/node-stats?action=restart
POST /api/v1/node/services/node-stats?action=start
POST /api/v1/node/services/node-stats?action=stop
|
Read NSX node-stats service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/node-stats/status
GET /api/v1/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
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nsx-control-plane-agent?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nsx-control-plane-agent?action=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
(Deprecated)
GET /api/v1/node/services/policy
(Deprecated)
|
Reset the logging levels to default values
|
POST /api/v1/cluster/{cluster-node-id}/node/services/policy?action=reset-manager-logging-levels
(Deprecated)
POST /api/v1/node/services/policy?action=reset-manager-logging-levels
(Deprecated)
|
Restart, start or stop the service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/policy?action=start
(Deprecated)
POST /api/v1/cluster/{cluster-node-id}/node/services/policy?action=stop
(Deprecated)
POST /api/v1/cluster/{cluster-node-id}/node/services/policy?action=restart
(Deprecated)
POST /api/v1/node/services/policy?action=start
(Deprecated)
POST /api/v1/node/services/policy?action=stop
(Deprecated)
POST /api/v1/node/services/policy?action=restart
(Deprecated)
|
Update service properties
|
PUT /api/v1/cluster/{cluster-node-id}/node/services/policy
(Deprecated)
PUT /api/v1/node/services/policy
(Deprecated)
|
Read service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/policy/status
(Deprecated)
GET /api/v1/node/services/policy/status
(Deprecated)
|
Read NSX Search service properties
|
GET /api/v1/cluster/{cluster-node-id}/node/services/search
GET /api/v1/node/services/search
|
Restart, start or stop the NSX Search service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/search?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/search?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/search?action=stop
POST /api/v1/node/services/search?action=restart
POST /api/v1/node/services/search?action=start
POST /api/v1/node/services/search?action=stop
|
Read NSX Search service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/search/status
GET /api/v1/node/services/search/status
|
Read the Site Manager service properties
|
GET /api/v1/cluster/{cluster-node-id}/node/services/site_manager
GET /api/v1/node/services/site_manager
|
Restart, start or stop the Site Manager service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/site_manager?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/site_manager?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/site_manager?action=stop
POST /api/v1/node/services/site_manager?action=restart
POST /api/v1/node/services/site_manager?action=start
POST /api/v1/node/services/site_manager?action=stop
|
Read the Site Manager service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/site_manager/status
GET /api/v1/node/services/site_manager/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/cluster/{cluster-node-id}/node/services/telemetry?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/telemetry?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/telemetry?action=stop
POST /api/v1/node/services/telemetry?action=restart
POST /api/v1/node/services/telemetry?action=start
POST /api/v1/node/services/telemetry?action=stop
|
Reset the logging levels to default values
|
POST /api/v1/cluster/{cluster-node-id}/node/services/telemetry?action=reset-telemetry-logging-levels
POST /api/v1/node/services/telemetry?action=reset-telemetry-logging-levels
|
Update Telemetry service properties
|
PUT /api/v1/cluster/{cluster-node-id}/node/services/telemetry
PUT /api/v1/node/services/telemetry
|
Read Telemetry service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/telemetry/status
GET /api/v1/node/services/telemetry/status
|
Read ui service properties
|
GET /api/v1/cluster/{cluster-node-id}/node/services/ui-service
GET /api/v1/node/services/ui-service
|
Restart, Start and Stop the ui service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/ui-service?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/ui-service?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/ui-service?action=stop
POST /api/v1/node/services/ui-service?action=restart
POST /api/v1/node/services/ui-service?action=start
POST /api/v1/node/services/ui-service?action=stop
|
Read ui service status
|
GET /api/v1/cluster/{cluster-node-id}/node/services/ui-service/status
GET /api/v1/node/services/ui-service/status
|