| API Description |
API Path |
Read edge config diagnosis
|
GET /api/v1/node/diagnosis
GET /api/v1/transport-nodes/<transport-node-id>/node/diagnosis
GET /api/v1/cluster/<cluster-node-id>/node/diagnosis
|
List node services
Returns a list of all services available on the NSX Manager applicance.
|
GET /api/v1/node/services
GET /api/v1/transport-nodes/<transport-node-id>/node/services
GET /api/v1/cluster/<cluster-node-id>/node/services
|
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 cm inventory service properties
|
GET /api/v1/node/services/cm-inventory
GET /api/v1/transport-nodes/<transport-node-id>/node/services/cm-inventory
GET /api/v1/cluster/<cluster-node-id>/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/transport-nodes/<transport-node-id>/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/node/services/cm-inventory/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/cm-inventory/status
GET /api/v1/cluster/<cluster-node-id>/node/services/cm-inventory/status
|
Read controller service properties
|
GET /api/v1/node/services/controller
GET /api/v1/transport-nodes/<transport-node-id>/node/services/controller
GET /api/v1/cluster/<cluster-node-id>/node/services/controller
|
Restart, start or stop the controller service
|
POST /api/v1/node/services/controller?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/controller?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/controller?action=restart|start|stop
|
Read controller server certificate properties
|
GET /api/v1/node/services/controller/controller-certificate
GET /api/v1/transport-nodes/<transport-node-id>/node/services/controller/controller-certificate
GET /api/v1/cluster/<cluster-node-id>/node/services/controller/controller-certificate
|
Get the status (Enabled/Disabled) of controller profiler
|
GET /api/v1/node/services/controller/profiler
GET /api/v1/transport-nodes/<transport-node-id>/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/transport-nodes/<transport-node-id>/node/services/controller/profiler
PUT /api/v1/cluster/<cluster-node-id>/node/services/controller/profiler
|
Read controller service status
|
GET /api/v1/node/services/controller/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/controller/status
GET /api/v1/cluster/<cluster-node-id>/node/services/controller/status
|
Read NSX EdgeDatapath service properties
|
GET /api/v1/node/services/dataplane
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane
GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane
|
Restart, start or stop the NSX EdgeDatapath service
|
POST /api/v1/node/services/dataplane?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/dataplane?action=restart|start|stop
|
Read NSX EdgeDatapath service status
|
GET /api/v1/node/services/dataplane/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/status
GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/status
|
Read NSX Edge DHCP service properties
|
GET /api/v1/node/services/dhcp
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dhcp
GET /api/v1/cluster/<cluster-node-id>/node/services/dhcp
|
Read NSX Edge DHCP service status
|
GET /api/v1/node/services/dhcp/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dhcp/status
GET /api/v1/cluster/<cluster-node-id>/node/services/dhcp/status
|
Read NSX Edge Dispatcher service properties
|
GET /api/v1/node/services/dispatcher
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dispatcher
GET /api/v1/cluster/<cluster-node-id>/node/services/dispatcher
|
Restart, start or stop the NSX Edge Dispatcher service
|
POST /api/v1/node/services/dispatcher?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/dispatcher?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/dispatcher?action=restart|start|stop
|
Read NSX Edge Dispatcher service status
|
GET /api/v1/node/services/dispatcher/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dispatcher/status
GET /api/v1/cluster/<cluster-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/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)
|
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
|
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
|
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
|
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
|
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 the idps-reporting service properties
|
GET /api/v1/node/services/idps-reporting
GET /api/v1/transport-nodes/<transport-node-id>/node/services/idps-reporting
GET /api/v1/cluster/<cluster-node-id>/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/transport-nodes/<transport-node-id>/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/transport-nodes/<transport-node-id>/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/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 NSX Edge Ipsec VPN service properties
|
GET /api/v1/node/services/ipsecvpn
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn
GET /api/v1/cluster/<cluster-node-id>/node/services/ipsecvpn
|
Read NSX Edge Ipsec VPN service status
|
GET /api/v1/node/services/ipsecvpn/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ipsecvpn/status
|
Read liagent service properties
|
GET /api/v1/node/services/liagent
GET /api/v1/transport-nodes/<transport-node-id>/node/services/liagent
GET /api/v1/cluster/<cluster-node-id>/node/services/liagent
|
Restart, start or stop the liagent service
|
POST /api/v1/node/services/liagent?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/liagent?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/liagent?action=restart|start|stop
|
Read liagent service status
|
GET /api/v1/node/services/liagent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/liagent/status
GET /api/v1/cluster/<cluster-node-id>/node/services/liagent/status
|
Read NSX EdgeNSXA service properties
|
GET /api/v1/node/services/local-controller
GET /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller
GET /api/v1/cluster/<cluster-node-id>/node/services/local-controller
|
Restart, start or stop the NSX EdgeNSXA service
|
POST /api/v1/node/services/local-controller?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/local-controller?action=restart|start|stop
|
Read NSX EdgeNSXA service status
|
GET /api/v1/node/services/local-controller/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/local-controller/status
GET /api/v1/cluster/<cluster-node-id>/node/services/local-controller/status
|
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 Metadata-proxy service properties
|
GET /api/v1/node/services/metadata-proxy
GET /api/v1/transport-nodes/<transport-node-id>/node/services/metadata-proxy
GET /api/v1/cluster/<cluster-node-id>/node/services/metadata-proxy
|
Read Metadata-proxy service status
|
GET /api/v1/node/services/metadata-proxy/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/metadata-proxy/status
GET /api/v1/cluster/<cluster-node-id>/node/services/metadata-proxy/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 migration coordinator service properties
|
GET /api/v1/node/services/migration-coordinator
GET /api/v1/transport-nodes/<transport-node-id>/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/transport-nodes/<transport-node-id>/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/transport-nodes/<transport-node-id>/node/services/migration-coordinator/status
GET /api/v1/cluster/<cluster-node-id>/node/services/migration-coordinator/status
|
Read NSX Nestdb service properties
|
GET /api/v1/node/services/nestdb
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nestdb
GET /api/v1/cluster/<cluster-node-id>/node/services/nestdb
|
Restart, start or stop the NSX Nestdb service
|
POST /api/v1/node/services/nestdb?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nestdb?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nestdb?action=restart|start|stop
|
Read NSX Nestdb service status
|
GET /api/v1/node/services/nestdb/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nestdb/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nestdb/status
|
Read appliance management service properties
|
GET /api/v1/node/services/node-mgmt
GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt
GET /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt
|
Restart the node management service
|
POST /api/v1/node/services/node-mgmt?action=restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt?action=restart
POST /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt?action=restart
|
Read appliance management service status
|
GET /api/v1/node/services/node-mgmt/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-mgmt/status
GET /api/v1/cluster/<cluster-node-id>/node/services/node-mgmt/status
|
Read NSX node-stats service properties
|
GET /api/v1/node/services/node-stats
GET /api/v1/transport-nodes/<transport-node-id>/node/services/node-stats
GET /api/v1/cluster/<cluster-node-id>/node/services/node-stats
|
Restart, start or stop the NSX node-stats service
|
POST /api/v1/node/services/node-stats?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/node-stats?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/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/transport-nodes/<transport-node-id>/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/node/services/nsx-control-plane-agent
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-control-plane-agent
|
Restart, start or stop the NSX Control Plane Agent service
|
POST /api/v1/node/services/nsx-control-plane-agent?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-control-plane-agent?action=restart|start|stop
|
Read NSX Control Plane Agent service status
|
GET /api/v1/node/services/nsx-control-plane-agent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-control-plane-agent/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 OpsAgent service properties
|
GET /api/v1/node/services/nsx-opsagent
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-opsagent
|
Restart, start or stop the NSX OpsAgent service
|
POST /api/v1/node/services/nsx-opsagent?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-opsagent?action=restart|start|stop
|
Read NSX OpsAgent service status
|
GET /api/v1/node/services/nsx-opsagent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-opsagent/status
|
Read NSX Platform Client service properties
|
GET /api/v1/node/services/nsx-platform-client
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client
|
Restart, start or stop the NSX Platform Client service
|
POST /api/v1/node/services/nsx-platform-client?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client?action=restart|start|stop
|
Read NSX Platform Client service status
|
GET /api/v1/node/services/nsx-platform-client/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-platform-client/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-platform-client/status
|
Read NSX upgrade Agent service properties
|
GET /api/v1/node/services/nsx-upgrade-agent
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent
|
Restart, start or stop the NSX upgrade agent service
|
POST /api/v1/node/services/nsx-upgrade-agent?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent?action=restart|start|stop
|
Read Nsx upgrade agent service status
|
GET /api/v1/node/services/nsx-upgrade-agent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-upgrade-agent/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-upgrade-agent/status
|
Read NTP service properties
|
GET /api/v1/node/services/ntp
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ntp
GET /api/v1/cluster/<cluster-node-id>/node/services/ntp
|
Restart, start or stop the NTP service
|
POST /api/v1/node/services/ntp?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ntp?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/ntp?action=restart|start|stop
|
Update NTP service properties
|
PUT /api/v1/node/services/ntp
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/ntp
PUT /api/v1/cluster/<cluster-node-id>/node/services/ntp
|
Read NTP service status
|
GET /api/v1/node/services/ntp/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ntp/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ntp/status
|
Read service properties
|
GET /api/v1/node/services/policy
GET /api/v1/transport-nodes/<transport-node-id>/node/services/policy
GET /api/v1/cluster/<cluster-node-id>/node/services/policy
|
Restart, start or stop the service
|
POST /api/v1/node/services/policy?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/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/node/services/policy?action=reset-manager-logging-levels
POST /api/v1/transport-nodes/<transport-node-id>/node/services/policy?action=reset-manager-logging-levels
POST /api/v1/cluster/<cluster-node-id>/node/services/policy?action=reset-manager-logging-levels
|
Update service properties
|
PUT /api/v1/node/services/policy
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/policy
PUT /api/v1/cluster/<cluster-node-id>/node/services/policy
|
Read service status
|
GET /api/v1/node/services/policy/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/policy/status
GET /api/v1/cluster/<cluster-node-id>/node/services/policy/status
|
Read NSX EdgeMSR service properties
|
GET /api/v1/node/services/router
GET /api/v1/transport-nodes/<transport-node-id>/node/services/router
GET /api/v1/cluster/<cluster-node-id>/node/services/router
|
Read NSX EdgeMSRConfig service properties
|
GET /api/v1/node/services/router-config
GET /api/v1/transport-nodes/<transport-node-id>/node/services/router-config
GET /api/v1/cluster/<cluster-node-id>/node/services/router-config
|
Read NSX EdgeMSRConfig service status
|
GET /api/v1/node/services/router-config/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/router-config/status
GET /api/v1/cluster/<cluster-node-id>/node/services/router-config/status
|
Read NSX EdgeMSR service status
|
GET /api/v1/node/services/router/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/router/status
GET /api/v1/cluster/<cluster-node-id>/node/services/router/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 SNMP service properties
Read SNMP service properties.
|
GET /api/v1/node/services/snmp
GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp
GET /api/v1/cluster/<cluster-node-id>/node/services/snmp
|
Restart, start or stop the SNMP service
|
POST /api/v1/node/services/snmp?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/snmp?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/snmp?action=restart|start|stop
|
Update SNMP service properties
Update SNMP service properties.
|
PUT /api/v1/node/services/snmp
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/snmp
PUT /api/v1/cluster/<cluster-node-id>/node/services/snmp
|
Read SNMP service status
|
GET /api/v1/node/services/snmp/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/status
GET /api/v1/cluster/<cluster-node-id>/node/services/snmp/status
|
Read SNMP V3 Engine ID
|
GET /api/v1/node/services/snmp/v3-engine-id
GET /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/v3-engine-id
GET /api/v1/cluster/<cluster-node-id>/node/services/snmp/v3-engine-id
|
Update SNMP V3 Engine ID
|
PUT /api/v1/node/services/snmp/v3-engine-id
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/snmp/v3-engine-id
PUT /api/v1/cluster/<cluster-node-id>/node/services/snmp/v3-engine-id
|
Read ssh service properties
|
GET /api/v1/node/services/ssh
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ssh
GET /api/v1/cluster/<cluster-node-id>/node/services/ssh
|
Restart, start or stop the ssh service
|
POST /api/v1/node/services/ssh?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/ssh?action=start|stop|restart
|
Remove a host's fingerprint from known hosts file
|
POST /api/v1/node/services/ssh?action=remove_host_fingerprint
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh?action=remove_host_fingerprint
POST /api/v1/cluster/<cluster-node-id>/node/services/ssh?action=remove_host_fingerprint
|
Update ssh service properties
Update ssh service properties. If the start_on_boot property is updated to true, existing ssh sessions if any are stopped and the ssh service is restarted.
|
PUT /api/v1/node/services/ssh
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/ssh
PUT /api/v1/cluster/<cluster-node-id>/node/services/ssh
|
Read NSX SSH service inside Tier0 logical router properties
|
GET /api/v1/node/services/ssh-in-lr
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ssh-in-lr
GET /api/v1/cluster/<cluster-node-id>/node/services/ssh-in-lr
|
Restart, start or stop the NSX Edge SSH inside Tier0 logical router service
|
POST /api/v1/node/services/ssh-in-lr?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh-in-lr?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/ssh-in-lr?action=restart|start|stop
|
Read NSX Edge SSH service status inside Tier0 logical router
|
GET /api/v1/node/services/ssh-in-lr/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ssh-in-lr/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ssh-in-lr/status
|
Restart, start or stop the ssh service
|
POST /api/v1/node/services/ssh/notify_mpa?action=start|stop|restart
POST /api/v1/transport-nodes/<transport-node-id>/node/services/ssh/notify_mpa?action=start|stop|restart
POST /api/v1/cluster/<cluster-node-id>/node/services/ssh/notify_mpa?action=start|stop|restart
|
Read ssh service status
|
GET /api/v1/node/services/ssh/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ssh/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ssh/status
|
Read syslog service properties
|
GET /api/v1/node/services/syslog
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog
|
Restart, start or stop the syslog service
|
POST /api/v1/node/services/syslog?action=restart|start|stop
POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog?action=restart|start|stop
POST /api/v1/cluster/<cluster-node-id>/node/services/syslog?action=restart|start|stop
|
List node syslog exporters
Returns the collection of registered syslog exporter rules, if any. The
rules specify the collector IP address and port, and the protocol to use.
|
GET /api/v1/node/services/syslog/exporters
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
|
Verify node syslog exporter
Collect iptables rules needed for all existing syslog exporters and verify
if the existing iptables rules are the same. If not, remove the stale rules
and add the new rules to make sure all exporters work properly.
|
POST /api/v1/node/services/syslog/exporters?action=verify
POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters?action=verify
POST /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters?action=verify
|
Add node syslog exporter
Adds a rule for exporting syslog information to a specified server. The
required parameters are the rule name (exporter_name); severity level
(emerg, alert, crit, and so on); transmission protocol (TCP or UDP); and
server IP address or hostname. The optional parameters are the syslog port
number, which can be 1 through 65,535 (514, by default); facility level to
use when logging messages to syslog (kern, user, mail, and so on); and
message IDs (msgids), which identify the types of messages to export.
|
POST /api/v1/node/services/syslog/exporters
POST /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters
POST /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters
|
Delete node syslog exporter
Removes a specified rule from the collection of syslog exporter rules.
|
DELETE /api/v1/node/services/syslog/exporters/<exporter-name>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters/<exporter-name>
DELETE /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters/<exporter-name>
|
Read node syslog exporter
Returns information about a specific syslog collection point.
|
GET /api/v1/node/services/syslog/exporters/<exporter-name>
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters/<exporter-name>
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters/<exporter-name>
|
Read syslog service status
|
GET /api/v1/node/services/syslog/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/status
GET /api/v1/cluster/<cluster-node-id>/node/services/syslog/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
|
List appliance management tasks
|
GET /api/v1/node/tasks
GET /api/v1/transport-nodes/<transport-node-id>/node/tasks
GET /api/v1/cluster/<cluster-node-id>/node/tasks
|
Delete task
|
DELETE /api/v1/node/tasks/<task-id>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>
DELETE /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>
|
Read task properties
|
GET /api/v1/node/tasks/<task-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>
GET /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>
|
Cancel specified task
|
POST /api/v1/node/tasks/<task-id>?action=cancel
POST /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>?action=cancel
POST /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>?action=cancel
|
Read asynchronous task response
|
GET /api/v1/node/tasks/<task-id>/response
GET /api/v1/transport-nodes/<transport-node-id>/node/tasks/<task-id>/response
GET /api/v1/cluster/<cluster-node-id>/node/tasks/<task-id>/response
|