System Administration

System Administration > Configuration

Associated URIs:

API Description API Path

Register a Collection of API Calls at a Single End Point


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

Join this node to a NSX Cluster


POST /api/v1/cluster?action=join_cluster

Detach a node from the Cluster


POST /api/v1/cluster/<node-id>?action=remove_node

Invoke DELETE request on target cluster node


DELETE /api/v1/cluster/<target-node-id>/<target-uri>

Invoke GET request on target cluster node


GET /api/v1/cluster/<target-node-id>/<target-uri>

Invoke POST request on target cluster node


POST /api/v1/cluster/<target-node-id>/<target-uri>

Invoke PUT request on target cluster node


PUT /api/v1/cluster/<target-node-id>/<target-uri>

Read cluster certificate ID


Returns the ID of the certificate that is used as the cluster certificate for MP
GET /api/v1/cluster/api-certificate

Clear the cluster certificate


Clears the certificate used for the MP cluster.
This does not affect the certificate itself.
This API is deprecated. Instead use the
/api/v1/cluster/api-certificate?action=set_cluster_certificate API to set
the cluster certificate to a different one.
It just means that from now on, individual certificates will be used on
each MP node. This affects all nodes in the cluster.
POST /api/v1/cluster/api-certificate?action=clear_cluster_certificate (Deprecated)

Set the cluster certificate


Sets the certificate used for the MP cluster.
This affects all nodes in the cluster. If the certificate used is a CA signed
certificate,the request fails if the whole chain(leaf, intermediate, root)
is not imported.
POST /api/v1/cluster/api-certificate?action=set_cluster_certificate

Read API service properties


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

Update API service properties


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

Read cluster virtual IP address


Returns the configured cluster virtual IP address or null if not configured.
GET /api/v1/cluster/api-virtual-ip

Set cluster virtual IP address


Sets the cluster virtual IP address. Note, all nodes in the management
cluster must be in the same subnet. If not, a 409 CONFLICT status is
returned.
POST /api/v1/cluster/api-virtual-ip?action=set_virtual_ip

Clear cluster virtual IP address


Clears the cluster virtual IP address.
POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip

Get backup frames for UI


Returns list of backup frames and some metadata to be used by UI.
GET /api/v1/cluster/backups/ui_frames

Read NSX Management nodes global configuration.


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

Update NSX Management nodes global configuration


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

Invoke DELETE request on target fabric node


Invoke DELETE request on target fabric node. This api is deprecated
as part of FN+TN unification. Please use Transport Node API
DELETE /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>
DELETE /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)

Invoke GET request on target fabric node


Invoke GET request on target fabric node. This api is deprecated
as part of FN+TN unification. Please use Transport Node API
GET /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>
GET /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)

Invoke POST request on target fabric node


Invoke POST request on target fabric node. This api is deprecated
as part of FN+TN unification. Please use Transport Node API
POST /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>
POST /api/v1/fabric/nodes/<target-node-id>/<target-uri> (Deprecated)

Invoke PUT request on target fabric node


Invoke PUT request on target fabric node. This api is deprecated
as part of FN+TN unification. Please use Transport Node API
PUT /transport-nodes/<transport-node-id>/<target-node-id>/<target-uri>
PUT /api/v1/fabric/nodes/<target-node-id>/<target-uri> (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

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

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

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 node authentication policy configuration


Returns information about the currently configured authentication
policies on the node.
GET /api/v1/node/aaa/auth-policy
GET /api/v1/transport-nodes/<transport-node-id>/node/aaa/auth-policy
GET /api/v1/cluster/<cluster-node-id>/node/aaa/auth-policy

Update node authentication policy configuration


Update the currently configured authentication policy on the node.
If any of api_max_auth_failures, api_failed_auth_reset_period, or
api_failed_auth_lockout_period are modified, the http service is
automatically restarted.
PUT /api/v1/node/aaa/auth-policy
PUT /api/v1/transport-nodes/<transport-node-id>/node/aaa/auth-policy
PUT /api/v1/cluster/<cluster-node-id>/node/aaa/auth-policy

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

List node files


GET /api/v1/node/file-store
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store
GET /api/v1/cluster/<cluster-node-id>/node/file-store

Create directory in remote file server


Create a directory on the remote remote server. Supports only SFTP.
You must provide the remote server's SSH fingerprint. See the
NSX Administration Guide for information and instructions
about finding the SSH fingerprint.
POST /api/v1/node/file-store?action=create_remote_directory
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store?action=create_remote_directory
POST /api/v1/cluster/<cluster-node-id>/node/file-store?action=create_remote_directory

Delete file


DELETE /api/v1/node/file-store/<file-name>
DELETE /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
DELETE /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>

Read file properties


GET /api/v1/node/file-store/<file-name>
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>

Upload a file to the file store


When you issue this API, the client must specify:
- HTTP header Content-Type:application/octet-stream.
- Request body with the contents of the file in the filestore.
In the CLI, you can view the filestore with the get files command.
POST /api/v1/node/file-store/<file-name>
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>

Copy file in the file store to a remote file store


Copy a file in the file store to a remote server. If you use scp or
sftp, you must provide the remote server's SSH fingerprint. See the
NSX-T Administration Guide for information and instructions
about finding the SSH fingerprint.
POST /api/v1/node/file-store/<file-name>?action=copy_to_remote_file
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_to_remote_file
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_to_remote_file

Copy a remote file to the file store


Copy a remote file to the file store. If you use scp or sftp,
you must provide the remote server's SSH fingerprint. See the
NSX-T Administration Guide for information and instructions
about finding the SSH fingerprint.
POST /api/v1/node/file-store/<file-name>?action=copy_from_remote_file
POST /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>?action=copy_from_remote_file
POST /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>?action=copy_from_remote_file

Read file contents


GET /api/v1/node/file-store/<file-name>/data
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/data
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/data

Replace file contents


PUT /api/v1/node/file-store/<file-name>/data
PUT /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/data
PUT /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/data

Read file thumbprint


GET /api/v1/node/file-store/<file-name>/thumbprint
GET /api/v1/transport-nodes/<transport-node-id>/node/file-store/<file-name>/thumbprint
GET /api/v1/cluster/<cluster-node-id>/node/file-store/<file-name>/thumbprint

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

List available node logs


Returns the number of log files and lists the log files that reside on the
NSX virtual appliance. The list includes the filename, file size,
and last-modified time in milliseconds since epoch (1 January 1970) for each
log file. Knowing the last-modified time with millisecond accuracy since
epoch is helpful when you are comparing two times, such as the time of a
POST request and the end time on a server.
GET /api/v1/node/logs
GET /api/v1/transport-nodes/<transport-node-id>/node/logs
GET /api/v1/cluster/<cluster-node-id>/node/logs

Read node log properties


For a single specified log file, lists the filename, file size, and
last-modified time.
GET /api/v1/node/logs/<log-name>
GET /api/v1/transport-nodes/<transport-node-id>/node/logs/<log-name>
GET /api/v1/cluster/<cluster-node-id>/node/logs/<log-name>

Read node log contents


For a single specified log file, returns the content of the log file.
This method supports byte-range requests. To request just a portion of a
log file, supply an HTTP Range header, e.g. "Range: bytes=-".
is optional, and, if omitted, the file contents from start to the
end of the file are returned.'
GET /api/v1/node/logs/<log-name>/data
GET /api/v1/transport-nodes/<transport-node-id>/node/logs/<log-name>/data
GET /api/v1/cluster/<cluster-node-id>/node/logs/<log-name>/data

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 Node's Network Interfaces


Returns the number of interfaces on the node 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 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.
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 Node'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 Node'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 Node's Name Servers


Returns the list of servers that the 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 Node's Name Servers


Modifies the list of servers that the 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 node 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 node, 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 node 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 node 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 node
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 Node's Search Domains


Returns the domain list that the 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 Node's Search Domains


Modifies the list of domain names that the 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 node 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

Update the async_replicator service properties


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

Read the Async Replicator service status


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

Read cluster boot manager service properties


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

Restart, start or stop the cluster boot manager service


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

Read cluster boot manager service status


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

Read service properties


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

Disable Global Manager service


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

Enable Global Manager service


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

Restart, start or stop the service


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

Reset the logging levels to default values


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

Update service properties


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

Read service status


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

Read http service properties


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

Start the http service


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

Update http service certificate


Applies a security certificate to the http service. In the POST request,
the CERTIFICATE_ID references a certificate created with the
/api/v1/trust-management APIs. If the certificate used is a CA signed
certificate,the request fails if the whole chain(leaf, intermediate, root)
is not imported.
POST /api/v1/node/services/http?action=apply_certificate
POST /api/v1/transport-nodes/<transport-node-id>/node/services/http?action=apply_certificate
POST /api/v1/cluster/<cluster-node-id>/node/services/http?action=apply_certificate

Restart the http service


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

Stop the http service


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

Update http service properties


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

Read http service status


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

Read NSX install-upgrade service properties


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

Restart, start or stop the NSX install-upgrade service


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

Update NSX install-upgrade service properties


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

Read NSX install-upgrade service status


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

Update UC state properties


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

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


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

Reset the logging levels to default values


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

Restart, start or stop the service


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

Update service properties


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

Read service status


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

Read Rabbit MQ service properties


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

Restart, start or stop the Rabbit MQ service


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

Read Rabbit MQ service status


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

Read 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 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 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 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

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

Delete all node syslog exporters


Removes all syslog exporter rules.
DELETE /api/v1/node/services/syslog/exporters
DELETE /api/v1/transport-nodes/<transport-node-id>/node/services/syslog/exporters
DELETE /api/v1/cluster/<cluster-node-id>/node/services/syslog/exporters

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

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

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

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 node 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

List node users


Returns the list of users configued to log in to the NSX appliance.
GET /api/v1/node/users
GET /api/v1/transport-nodes/<transport-node-id>/node/users
GET /api/v1/cluster/<cluster-node-id>/node/users

Reset a user's own password. Requires current password


Enables a user to reset their own password.
POST /api/v1/node/users?action=reset_own_password
POST /api/v1/transport-nodes/<transport-node-id>/node/users?action=reset_own_password
POST /api/v1/cluster/<cluster-node-id>/node/users?action=reset_own_password

Read node user


Returns information about a specified user who is configued to log in to the
NSX appliance. The valid user IDs are: 0, 10000, 10002.
GET /api/v1/node/users/<userid>
GET /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>
GET /api/v1/cluster/<cluster-node-id>/node/users/<userid>

Reset a user's password without requiring their current password


Unlike the PUT version of this call (PUT /node/users/), this API
does not require that the current password for the user be provided. The
account of the target user must be "ACTIVE" for the call to succeed.
This API only supports user ID 10002.
POST /api/v1/node/users/<userid>?action=reset_password
POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>?action=reset_password
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>?action=reset_password

Update node user


Updates attributes of an existing NSX appliance user. This method
cannot be used to add a new user. Modifiable attributes include the
username, full name of the user, and password. If you specify a password in
a PUT request, it is not returned in the response. Nor is it returned in a
GET request.
The specified password does not meet the following complexity requirements:
- minimum 12 characters in length
- minimum 1 uppercase character
- minimum 1 lowercase character
- minimum 1 numeric character
- minimum 1 special character
- minimum 5 unique characters
- default password complexity rules as enforced by the Linux PAM module
The valid user IDs are: 0, 10000, 10002.
Note that invoking this API does not update any user-related properties of
existing objects in the system and does not modify the username field in existing
audit log entries.
PUT /api/v1/node/users/<userid>
PUT /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>
PUT /api/v1/cluster/<cluster-node-id>/node/users/<userid>

List SSH keys from authorized_keys file for node user


Returns a list of all SSH keys from authorized_keys file for node user
GET /api/v1/node/users/<userid>/ssh-keys
GET /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys
GET /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys

Remove SSH public key from authorized_keys file for node user


POST /api/v1/node/users/<userid>/ssh-keys?action=remove_ssh_key
POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys?action=remove_ssh_key
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys?action=remove_ssh_key

Add SSH public key to authorized_keys file for node user


POST /api/v1/node/users/<userid>/ssh-keys?action=add_ssh_key
POST /api/v1/transport-nodes/<transport-node-id>/node/users/<userid>/ssh-keys?action=add_ssh_key
POST /api/v1/cluster/<cluster-node-id>/node/users/<userid>/ssh-keys?action=add_ssh_key

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

Invoke DELETE request on target transport node


DELETE /api/v1/transport-nodes/<target-node-id>/<target-uri>

Invoke GET request on target transport node


GET /api/v1/transport-nodes/<target-node-id>/<target-uri>

Invoke POST request on target transport node


POST /api/v1/transport-nodes/<target-node-id>/<target-uri>

Invoke PUT request on target transport node


PUT /api/v1/transport-nodes/<target-node-id>/<target-uri>