| 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 /api/v1/batch
|
Read Cluster Configuration
Returns 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 configuration
Returns 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>
|
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
|
Clear cluster virtual IP address
Clears the cluster virtual IP address.
|
POST /api/v1/cluster/api-virtual-ip?action=clear_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
|
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
|
Synchronizes the repository data between nsx managers.
Attempts to synchronize the repository partition on nsx manager. Repository partition contains packages required for the
install and upgrade of nsx components.Normally there is no need to call this API explicitely by the user.
|
POST /api/v1/cluster/node?action=repo_sync
|
List Cluster Node Configurations
Returns 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 cluster
Add 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 cluster
Removes 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/?action=remove_node
to detach a node from cluster. The controller is removed with the node.
|
DELETE /api/v1/cluster/nodes/<node-id>
(Deprecated)
|
Read Cluster Node Configuration
Returns information about the specified NSX cluster node.
Deprecated. Use GET /cluster/ to get cluster node configuration.
|
GET /api/v1/cluster/nodes/<node-id>
(Deprecated)
|
List the specified node's Network Interfaces
Returns the number of interfaces on the node and detailed
information about each interface. Interface information includes MTU,
broadcast and host IP addresses, link and admin status, MAC address, network
mask, and the IP configuration method (static or DHCP).
|
GET /api/v1/cluster/nodes/<node-id>/network/interfaces
|
Read the node's Network Interface
Returns detailed information about the specified interface. Interface
information includes MTU, broadcast and host IP addresses, link and admin
status, MAC address, network mask, and the IP configuration method (static
or DHCP).
|
GET /api/v1/cluster/nodes/<node-id>/network/interfaces/<interface-id>
|
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
|
Synchronizes the repository data between nsx managers.
Returns the synchronization status for the manager represented by given .
|
GET /api/v1/cluster/nodes/<node-id>/repo_sync/status
|
Read cluster node runtime status
Read aggregated runtime status of cluster node.
|
GET /api/v1/cluster/nodes/<node-id>/status
|
Returns info for all cluster node VM auto-deployment attempts
Returns request information for every attempted deployment of a cluster
node VM.
|
GET /api/v1/cluster/nodes/deployments
|
Deploy and register a cluster node VM
Deploys a cluster node VM as specified by the deployment config.
Once the VM is deployed and powered on, it will automatically join the
existing cluster.
|
POST /api/v1/cluster/nodes/deployments
|
Returns info for a cluster-node VM auto-deployment attempt
Returns deployment request information for a specific attempted
deployment of a cluster node VM.
|
GET /api/v1/cluster/nodes/deployments/<node-id>
|
Attempt to delete an auto-deployed cluster node VM
Attempts to unregister and undeploy a specified auto-deployed cluster
node VM. If it is a member of a cluster, then the VM will be automatically
detached from the cluster before being unregistered and undeployed.
Alternatively, if the original deployment attempt failed or the VM is
not found, cleans up the deployment information associated with the
deployment attempt.
Note: If a VM has been successfully auto-deployed, then the associated
deployment information will not be deleted unless and until the VM is
successfully deleted.
|
POST /api/v1/cluster/nodes/deployments/<node-id>?action=delete
|
Returns the status of the VM creation/deletion
Returns the current deployment or undeployment status for a VM along with
any other relevant current information, such as error messages.
|
GET /api/v1/cluster/nodes/deployments/<node-id>/status
|
Read cluster runtime status
Read aggregated runtime status of all cluster nodes.
Deprecated. Use GET /cluster/status instead.
|
GET /api/v1/cluster/nodes/status
(Deprecated)
|
Read Cluster Status
Returns status information for the NSX cluster control role and management
role.
|
GET /api/v1/cluster/status
|
Read NSX Management nodes global configuration.
Returns the NSX Management nodes global configuration.
|
GET /api/v1/configs/management
|
Update NSX Management nodes global configuration
Modifies the NSX Management nodes global configuration.
|
PUT /api/v1/configs/management
|
NodeMode
Currently only a switch from "VMC_LOCAL" to "VMC" is supported.
Returns a new Node Mode, if the request successfuly changed it.
|
POST /api/v1/configs/node/mode
|
Read the NSX Manager'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.
This api is deprecated as part of FN+TN unification. Please use
/transport-nodes//network/interfaces//stats to
read network interface statistics with contraint FN is converted to TN.
|
GET /api/v1/fabric/nodes/<node-id>/network/interfaces/<interface-id>/stats
(Deprecated)
|
Read node properties
Returns information about the NSX appliance. Information includes
release number, time zone, system time, kernel version, message of the day
(motd), and host name.
|
GET /api/v1/node
GET /api/v1/transport-nodes/<transport-node-id>/node
GET /api/v1/cluster/<cluster-node-id>/node
|
Restart or shutdown node
Restarts or shuts down the NSX appliance.
|
POST /api/v1/node?action=restart|shutdown
POST /api/v1/transport-nodes/<transport-node-id>/node?action=restart|shutdown
POST /api/v1/cluster/<cluster-node-id>/node?action=restart|shutdown
|
Set the node system time
Set the node system time to the given time in UTC in the RFC3339 format
'yyyy-mm-ddThh:mm:ssZ'.
|
POST /api/v1/node?action=set_system_time
POST /api/v1/transport-nodes/<transport-node-id>/node?action=set_system_time
POST /api/v1/cluster/<cluster-node-id>/node?action=set_system_time
|
Update node properties
Modifies NSX appliance properties. Modifiable properties include the
timezone, message of the day (motd), and hostname. The NSX appliance
node_version, system_time, and kernel_version are read only and cannot be
modified with this method.
|
PUT /api/v1/node
PUT /api/v1/transport-nodes/<transport-node-id>/node
PUT /api/v1/cluster/<cluster-node-id>/node
|
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
|
Current configuration for this node
|
GET /api/v1/node/configuration
GET /api/v1/transport-nodes/<transport-node-id>/node/configuration
GET /api/v1/cluster/<cluster-node-id>/node/configuration
|
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
|
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 management plane configuration for this node
Delete the management plane configuration for this node.
|
DELETE /api/v1/node/management-plane
DELETE /api/v1/transport-nodes/<transport-node-id>/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/transport-nodes/<transport-node-id>/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/transport-nodes/<transport-node-id>/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/transport-nodes/<transport-node-id>/node/mode
GET /api/v1/cluster/<cluster-node-id>/node/mode
|
Read network configuration properties
|
GET /api/v1/node/network
GET /api/v1/transport-nodes/<transport-node-id>/node/network
GET /api/v1/cluster/<cluster-node-id>/node/network
|
List the NSX Manager's Network Interfaces
Returns the number of interfaces on the NSX Manager appliance and detailed
information about each interface. Interface information includes MTU,
broadcast and host IP addresses, link and admin status, MAC address, network
mask, and the IP configuration method (static or DHCP).
|
GET /api/v1/node/network/interfaces
GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces
GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces
|
Read the NSX Manager's Network Interface
Returns detailed information about the specified interface. Interface
information includes MTU, broadcast and host IP addresses, link and admin
status, MAC address, network mask, and the IP configuration method.
|
GET /api/v1/node/network/interfaces/<interface-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>
GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>
|
Update the NSX Manager's Network Interface
Updates the specified interface properties. You cannot change
the properties ip_configuration,
ip_addresses, or plane. NSX
Manager must have a static IP address.
You must use NSX CLI to configure a controller or an edge node.
|
PUT /api/v1/node/network/interfaces/<interface-id>
PUT /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>
PUT /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>
|
Read the NSX Manager'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/node/network/interfaces/<interface-id>/stats
GET /api/v1/transport-nodes/<transport-node-id>/node/network/interfaces/<interface-id>/stats
GET /api/v1/cluster/<cluster-node-id>/node/network/interfaces/<interface-id>/stats
|
Read the NSX Manager's Name Servers
Returns the list of servers that the NSX Manager node uses to look up IP
addresses associated with given domain names.
|
GET /api/v1/node/network/name-servers
GET /api/v1/transport-nodes/<transport-node-id>/node/network/name-servers
GET /api/v1/cluster/<cluster-node-id>/node/network/name-servers
|
Update the NSX Manager's Name Servers
Modifies the list of servers that the NSX Manager node uses to look up IP
addresses associated with given domain names. If DHCP is configured, this
method returns a 409 CONFLICT error, because DHCP manages the list of name
servers.
|
PUT /api/v1/node/network/name-servers
PUT /api/v1/transport-nodes/<transport-node-id>/node/network/name-servers
PUT /api/v1/cluster/<cluster-node-id>/node/network/name-servers
|
List node network routes
Returns detailed information about each route in the NSX Manager routing
table. Route information includes the route type (default, static, and so
on), a unique route identifier, the route metric, the protocol from which
the route was learned, the route source (which is the preferred egress
interface), the route destination, and the route scope. The route scope
refers to the distance to the destination network: The "host" scope leads to
a destination address on the NSX Manager, such as a loopback address;
the "link" scope leads to a destination on the local network; and the
"global" scope leads to addresses that are more than one hop away.
|
GET /api/v1/node/network/routes
GET /api/v1/transport-nodes/<transport-node-id>/node/network/routes
GET /api/v1/cluster/<cluster-node-id>/node/network/routes
|
Create node network route
Add a route to the NSX Manager routing table. For static routes, the
route_type, interface_id, netmask, and destination are required parameters.
For default routes, the route_type, gateway address, and interface_id
are required. For blackhole routes, the route_type and destination are
required. All other parameters are optional. When you add a static route,
the scope and route_id are created automatically. When you add a default or
blackhole route, the route_id is created automatically. The route_id is
read-only, meaning that it cannot be modified. All other properties can be
modified by deleting and readding the route.
|
POST /api/v1/node/network/routes
POST /api/v1/transport-nodes/<transport-node-id>/node/network/routes
POST /api/v1/cluster/<cluster-node-id>/node/network/routes
|
Delete node network route
Delete a route from the NSX Manager routing table. You can modify an
existing route by deleting it and then posting the modified version of the
route. To verify, remove the route ID from the URI, issue a GET request, and
note the absense of the deleted route.
|
DELETE /api/v1/node/network/routes/<route-id>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/network/routes/<route-id>
DELETE /api/v1/cluster/<cluster-node-id>/node/network/routes/<route-id>
|
Read node network route
Returns detailed information about a specified route in the NSX Manager
routing table.
|
GET /api/v1/node/network/routes/<route-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/network/routes/<route-id>
GET /api/v1/cluster/<cluster-node-id>/node/network/routes/<route-id>
|
Read the NSX Manager's Search Domains
Returns the domain list that the NSX Manager node uses to complete
unqualified host names. When a host name does not include a fully
qualified domain name (FQDN), the NSX Management node appends the
first-listed domain name to the host name before the host name is looked
up. The NSX Management node continues this for each entry in the domain
list until it finds a match.
|
GET /api/v1/node/network/search-domains
GET /api/v1/transport-nodes/<transport-node-id>/node/network/search-domains
GET /api/v1/cluster/<cluster-node-id>/node/network/search-domains
|
Update the NSX Manager's Search Domains
Modifies the list of domain names that the NSX Manager node uses to complete
unqualified host names. If DHCP is configured, this method returns
a 409 CONFLICT error, because DHCP manages the list of name servers.
|
PUT /api/v1/node/network/search-domains
PUT /api/v1/transport-nodes/<transport-node-id>/node/network/search-domains
PUT /api/v1/cluster/<cluster-node-id>/node/network/search-domains
|
List node processes
Returns the number of processes and information about each
process. Process information includes 1) mem_resident, which is roughly
equivalent to the amount of RAM, in bytes, currently used by the process,
2) parent process ID (ppid), 3) process name, 4) process up time in milliseconds,
5) mem_used, wich is the amount of virtual memory used by the process, in
bytes, 6) process start time, in milliseconds since epoch, 7) process ID
(pid), 8) CPU time, both user and the system, consumed by the process in
milliseconds.
|
GET /api/v1/node/processes
GET /api/v1/transport-nodes/<transport-node-id>/node/processes
GET /api/v1/cluster/<cluster-node-id>/node/processes
|
Read node process
Returns information for a specified process ID (pid).
|
GET /api/v1/node/processes/<process-id>
GET /api/v1/transport-nodes/<transport-node-id>/node/processes/<process-id>
GET /api/v1/cluster/<cluster-node-id>/node/processes/<process-id>
|
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
|
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
|
Read node status
Returns information about the NSX Manager appliance's file system, CPU,
memory, disk usage, and uptime.
|
GET /api/v1/node/status
GET /api/v1/transport-nodes/<transport-node-id>/node/status
GET /api/v1/cluster/<cluster-node-id>/node/status
|
Update node status
Clear node bootup status
|
POST /api/v1/node/status?action=clear_bootup_error
POST /api/v1/transport-nodes/<transport-node-id>/node/status?action=clear_bootup_error
POST /api/v1/cluster/<cluster-node-id>/node/status?action=clear_bootup_error
|
Read node support bundle
|
GET /api/v1/node/support-bundle
GET /api/v1/transport-nodes/<transport-node-id>/node/support-bundle
GET /api/v1/cluster/<cluster-node-id>/node/support-bundle
|
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
|
Read node version
|
GET /api/v1/node/version
GET /api/v1/transport-nodes/<transport-node-id>/node/version
GET /api/v1/cluster/<cluster-node-id>/node/version
|
Get information about all tasks
|
GET /api/v1/tasks
|
Get information about the specified task
|
GET /api/v1/tasks/<task-id>
|
Get the response of a task
|
GET /api/v1/tasks/<task-id>/response
|