NSX-T Data Center Global Manager REST API

System Administration

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).
This API is deprecated. Instead, use the hierarchical API in the NSX-T
policy API.
POST /global-manager/api/v1/batch (Deprecated)

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

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 (Deprecated)

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)

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 addresses


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

Clear cluster virtual IP address


Clears the cluster virtual IPv4 or IPv6 address.
Note, query parameter
?action=clear_virtual_ip clears virtual IPv4 address
and ?action=clear_virtual_ip6 clears virtual IPv6 address.
POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip
POST /api/v1/cluster/api-virtual-ip?action=clear_virtual_ip6

Set cluster virtual IP addresses


Sets the cluster virtual IPv4 and IPv6 address. Note, all nodes in the management
cluster must be in the same subnet. If not, a 409 CONFLICT status is
returned.
Query parameter ip_address sets virtual IPv4 address
and ip6_address sets virtual IPv6 address; either or both of the parameters
can be specified to set virtual IP address(es).
When updating either of any one parameter
value this does not changes the value of other unspecified parameter.
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 /global-manager/api/v1/cluster/node?action=repo_sync

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). Note that if virtual
IP (VIP) addresses are configured, virtual interfaces will not be returned.
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 <node-id>.
GET /global-manager/api/v1/cluster/nodes/{node-id}/repo_sync/status

Returns info for all cluster node VM auto-deployment attempts


Returns request information for every attempted deployment of a cluster
node VM.
GET /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/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 /global-manager/api/v1/cluster/nodes/deployments/{node-id}/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

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

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

Restart or shutdown node


Restarts or shuts down the NSX appliance. 		POST /api/v1/node?action=restart
POST /api/v1/node?action=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

Read node authentication policy and password complexity configuration


Returns information about the currently configured authentication policies and password complexity
on the node.
GET /api/v1/node/aaa/auth-policy

Resets node authentication policy and password complexity configuration


Resets to default, currently configured authentication policy and password complexity on the node.
Administrators need to enforce password change for existing user accounts
in order to match newly configured complexity requirements in system.

reset-all: resets configured Authentication policy and Password complexity


reset-auth-policies: resets only configured Authentication policy

includes - {api_failed_auth_lockout_period, api_failed_auth_reset_period,
api_max_auth_failures, cli_failed_auth_lockout_period, cli_max_auth_failures}


reset-pwd-complexity: resets only configured Password complexity


 		POST /api/v1/node/aaa/auth-policy?action=reset-all
POST /api/v1/node/aaa/auth-policy?action=reset-auth-policies
POST /api/v1/node/aaa/auth-policy?action=reset-pwd-complexity

Update node authentication policy and password complexity configuration


Update the currently configured authentication policy and password complexity 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.
Whereas change in any password complexity will not be applicable on already configured
user passwords. Administrators need to enforce password change for existing user accounts
in order to match newly configured complexity requirements enforced in system.
All values from AuthenticationPolicyProperties are in sync among the management cluster nodes.
PUT /api/v1/node/aaa/auth-policy

Read Central Config properties


 GET /api/v1/node/central-config

Update Central Config properties


 PUT /api/v1/node/central-config

List node files


 GET /api/v1/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

Retrieve ssh fingerprint for given remote server


Retrieve ssh fingerprint for a given remote server and port.
POST /api/v1/node/file-store?action=retrieve_ssh_fingerprint

Delete file


 DELETE /api/v1/node/file-store/{file-name}

Read file properties


 GET /api/v1/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}

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

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

Read file contents


 GET /api/v1/node/file-store/{file-name}/data

Replace file contents


 PUT /api/v1/node/file-store/{file-name}/data

Read file thumbprint


 GET /api/v1/node/file-store/{file-name}/thumbprint

Return node GRUB properties


Return node GRUB properties. 		GET /api/v1/node/grub

Update node GRUB properties


Update node GRUB properties.
Note: To update user properties like password, user is expected to use
/node/grub/<grub-username>
PUT /api/v1/node/grub

Update node GRUB user properties


Updates the GRUB user properties. 		PUT /api/v1/node/grub/{grub-username}

Gets the enable status for Mandatory Access Control


 GET /api/v1/node/hardening-policy/mandatory-access-control

Enable or disable Mandatory Access Control


 PUT /api/v1/node/hardening-policy/mandatory-access-control

Get the report for Mandatory Access Control


 GET /api/v1/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

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}

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=<start>-<end>".
<end> 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

Read network configuration properties


 GET /api/v1/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

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}

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}

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

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

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

List node network routes


Returns detailed information about each route in the node routing table.
Routes can be of any type i.e. IPv4 or IPv6 or both. Route information
includes the route ipv6 flag (True or False), 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. If ipv6 flag is True
then route information is for IPv6 route else for IPv4 route. 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

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

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}

Read node network route


Returns detailed information about a specified route in the node
routing table.
GET /api/v1/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

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

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

Read node process


Returns information for a specified process ID (pid). 		GET /api/v1/node/processes/{process-id}

List node services


Returns a list of all services available on the node applicance.
GET /api/v1/node/services

Read the Async Replicator service properties


 GET /api/v1/node/services/async_replicator

Restart, start or stop the Async Replicator service


 POST /api/v1/node/services/async_replicator?action=restart
POST /api/v1/node/services/async_replicator?action=start
POST /api/v1/node/services/async_replicator?action=stop

Update the async_replicator service properties


 PUT /api/v1/node/services/async_replicator

Read the Async Replicator service status


 GET /api/v1/node/services/async_replicator/status

Read auth service properties


Read auth service properties. 		GET /api/v1/node/services/auth

Restart the auth service


 POST /api/v1/node/services/auth?action=restart

Stop the auth service


 POST /api/v1/node/services/auth?action=stop

Start the auth service


 POST /api/v1/node/services/auth?action=start

Update auth service properties


Update auth service properties. 		PUT /api/v1/node/services/auth

Read auth service status


 GET /api/v1/node/services/auth/status

Read cluster boot manager service properties


 GET /api/v1/node/services/cluster_manager

Restart, start or stop the cluster boot manager service


 POST /api/v1/node/services/cluster_manager?action=start
POST /api/v1/node/services/cluster_manager?action=stop
POST /api/v1/node/services/cluster_manager?action=restart

Read cluster boot manager service status


 GET /api/v1/node/services/cluster_manager/status

Read cm inventory service properties


 GET /api/v1/node/services/cm-inventory

Restart, start or stop the manager service


 POST /api/v1/node/services/cm-inventory?action=start
POST /api/v1/node/services/cm-inventory?action=stop
POST /api/v1/node/services/cm-inventory?action=restart

Read manager service status


 GET /api/v1/node/services/cm-inventory/status

Read service properties


 GET /api/v1/node/services/global-manager

Restart, start or stop the service


 POST /api/v1/node/services/global-manager?action=start
POST /api/v1/node/services/global-manager?action=stop
POST /api/v1/node/services/global-manager?action=restart

Disable Global Manager service


 POST /api/v1/node/services/global-manager?action=disable

Enable Global Manager service


 POST /api/v1/node/services/global-manager?action=enable

Reset the logging levels to default values


 POST /api/v1/node/services/global-manager?action=reset-manager-logging-levels

Update service properties


 PUT /api/v1/node/services/global-manager

Read service status


 GET /api/v1/node/services/global-manager/status

Read http service properties


Read http service properties. To read fields deprecated in this API,
checkout API GET /api/v1/cluster/api-service.
GET /api/v1/node/services/http

Start the http service


 POST /api/v1/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 (Deprecated)

Restart the http service


 POST /api/v1/node/services/http?action=restart

Stop the http service


 POST /api/v1/node/services/http?action=stop

Update http service properties


Update http service properties. To update fields deprecated in this API,
checkout API PUT /api/v1/cluster/api-service.
PUT /api/v1/node/services/http

Read http service status


 GET /api/v1/node/services/http/status

Read NSX install-upgrade service properties


 GET /api/v1/node/services/install-upgrade

Restart, start or stop the NSX install-upgrade service


 POST /api/v1/node/services/install-upgrade?action=restart
POST /api/v1/node/services/install-upgrade?action=start
POST /api/v1/node/services/install-upgrade?action=stop

Update NSX install-upgrade service properties


 PUT /api/v1/node/services/install-upgrade

Read NSX install-upgrade service status


 GET /api/v1/node/services/install-upgrade/status

Update UC state properties


 PUT /api/v1/node/services/install-upgrade/uc-state

Read liagent service properties


 GET /api/v1/node/services/liagent

Restart, start or stop the liagent service


 POST /api/v1/node/services/liagent?action=restart
POST /api/v1/node/services/liagent?action=start
POST /api/v1/node/services/liagent?action=stop

Read liagent service status


 GET /api/v1/node/services/liagent/status

Read service properties


 GET /api/v1/node/services/manager

Restart, start or stop the service


 POST /api/v1/node/services/manager?action=start
POST /api/v1/node/services/manager?action=stop
POST /api/v1/node/services/manager?action=restart

Reset the logging levels to default values


 POST /api/v1/node/services/manager?action=reset-manager-logging-levels

Update service properties


 PUT /api/v1/node/services/manager

Read service status


 GET /api/v1/node/services/manager/status

Read NSX Messaging Manager service properties


 GET /api/v1/node/services/messaging-manager

Restart, start or stop the NSX Messaging Manager service


 POST /api/v1/node/services/messaging-manager?action=restart
POST /api/v1/node/services/messaging-manager?action=start
POST /api/v1/node/services/messaging-manager?action=stop

Read NSX Messaging Manager service status


 GET /api/v1/node/services/messaging-manager/status

Read migration coordinator service properties


 GET /api/v1/node/services/migration-coordinator

Restart, start or stop the migration coordinator service


 POST /api/v1/node/services/migration-coordinator?action=start
POST /api/v1/node/services/migration-coordinator?action=stop
POST /api/v1/node/services/migration-coordinator?action=restart

Read migration coordinator service status


 GET /api/v1/node/services/migration-coordinator/status

Read appliance management service properties


 GET /api/v1/node/services/node-mgmt

Restart the node management service


 POST /api/v1/node/services/node-mgmt?action=restart

Retrieve Node Management loglevel


 GET /api/v1/node/services/node-mgmt/loglevel

Set Node Management loglevel


 PUT /api/v1/node/services/node-mgmt/loglevel

Read appliance management service status


 GET /api/v1/node/services/node-mgmt/status

Read NSX Message Bus service properties


 GET /api/v1/node/services/nsx-message-bus

Restart, start or stop the NSX Message Bus service


 POST /api/v1/node/services/nsx-message-bus?action=restart
POST /api/v1/node/services/nsx-message-bus?action=start
POST /api/v1/node/services/nsx-message-bus?action=stop

Read NSX Message Bus service status


 GET /api/v1/node/services/nsx-message-bus/status

Read NSX Platform Client service properties


 GET /api/v1/node/services/nsx-platform-client

Restart, start or stop the NSX Platform Client service


 POST /api/v1/node/services/nsx-platform-client?action=restart
POST /api/v1/node/services/nsx-platform-client?action=start
POST /api/v1/node/services/nsx-platform-client?action=stop

Read NSX Platform Client service status


 GET /api/v1/node/services/nsx-platform-client/status

Read NSX upgrade Agent service properties


 GET /api/v1/node/services/nsx-upgrade-agent

Restart, start or stop the NSX upgrade agent service


 POST /api/v1/node/services/nsx-upgrade-agent?action=restart
POST /api/v1/node/services/nsx-upgrade-agent?action=start
POST /api/v1/node/services/nsx-upgrade-agent?action=stop

Read Nsx upgrade agent service status


 GET /api/v1/node/services/nsx-upgrade-agent/status

Read NTP service properties


 GET /api/v1/node/services/ntp

Restart, start or stop the NTP service


 POST /api/v1/node/services/ntp?action=restart
POST /api/v1/node/services/ntp?action=start
POST /api/v1/node/services/ntp?action=stop

Update NTP service properties


 PUT /api/v1/node/services/ntp

Read NTP service status


 GET /api/v1/node/services/ntp/status

Read NSX Search service properties


 GET /api/v1/node/services/search

Restart, start or stop the NSX Search service


 POST /api/v1/node/services/search?action=restart
POST /api/v1/node/services/search?action=start
POST /api/v1/node/services/search?action=stop

Read NSX Search service status


 GET /api/v1/node/services/search/status

Read the Site Manager service properties


 GET /api/v1/node/services/site_manager

Restart, start or stop the Site Manager service


 POST /api/v1/node/services/site_manager?action=restart
POST /api/v1/node/services/site_manager?action=start
POST /api/v1/node/services/site_manager?action=stop

Read the Site Manager service status


 GET /api/v1/node/services/site_manager/status

Read SNMP service properties


Read SNMP service properties. 		GET /api/v1/node/services/snmp

Restart, start or stop the SNMP service


 POST /api/v1/node/services/snmp?action=restart
POST /api/v1/node/services/snmp?action=start
POST /api/v1/node/services/snmp?action=stop

Update SNMP service properties


Update SNMP service properties. 		PUT /api/v1/node/services/snmp

Read SNMP service status


 GET /api/v1/node/services/snmp/status

Read SNMP V3 Engine ID


 GET /api/v1/node/services/snmp/v3-engine-id

Update SNMP V3 Engine ID


 PUT /api/v1/node/services/snmp/v3-engine-id

Read ssh service properties


 GET /api/v1/node/services/ssh

Restart, start or stop the ssh service


 POST /api/v1/node/services/ssh?action=start
POST /api/v1/node/services/ssh?action=stop
POST /api/v1/node/services/ssh?action=restart

Remove a host's fingerprint from known hosts file


 POST /api/v1/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

Restart, start or stop the ssh service


 POST /api/v1/node/services/ssh/notify_mpa?action=start
POST /api/v1/node/services/ssh/notify_mpa?action=stop
POST /api/v1/node/services/ssh/notify_mpa?action=restart

Read ssh service status


 GET /api/v1/node/services/ssh/status

Read syslog service properties


 GET /api/v1/node/services/syslog

Restart, start or stop the syslog service


 POST /api/v1/node/services/syslog?action=restart
POST /api/v1/node/services/syslog?action=start
POST /api/v1/node/services/syslog?action=stop

Delete all node syslog exporters


Removes all syslog exporter rules.
DELETE /api/v1/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

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

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

Delete node syslog exporter


Removes a specified rule from the collection of syslog exporter rules.
DELETE /api/v1/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}

Read syslog service status


 GET /api/v1/node/services/syslog/status

Read Telemetry service properties


 GET /api/v1/node/services/telemetry

Reset the logging levels to default values


 POST /api/v1/node/services/telemetry?action=reset-telemetry-logging-levels

Restart, start or stop Telemetry service


 POST /api/v1/node/services/telemetry?action=restart
POST /api/v1/node/services/telemetry?action=start
POST /api/v1/node/services/telemetry?action=stop

Update Telemetry service properties


 PUT /api/v1/node/services/telemetry

Read Telemetry service status


 GET /api/v1/node/services/telemetry/status

Read ui service properties


 GET /api/v1/node/services/ui-service

Restart, Start and Stop the ui service


 POST /api/v1/node/services/ui-service?action=restart
POST /api/v1/node/services/ui-service?action=start
POST /api/v1/node/services/ui-service?action=stop

Read ui service status


 GET /api/v1/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

Update node status


Clear node bootup status
POST /api/v1/node/status?action=clear_bootup_error

Read node support bundle


 GET /api/v1/node/support-bundle

List appliance management tasks


 GET /api/v1/node/tasks

Delete task


 DELETE /api/v1/node/tasks/{task-id}

Read task properties


 GET /api/v1/node/tasks/{task-id}

Cancel specified task


 POST /api/v1/node/tasks/{task-id}?action=cancel

Read asynchronous task response


 GET /api/v1/node/tasks/{task-id}/response

List node users


Returns the list of users configured to log in to the NSX appliance.
GET /api/v1/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

Create node users


Create new user account to log in to the NSX web-based user interface or access API.
username is required field in case of creating new user, further following
usernames - root, admin, audit are reserved and can not be used
to create new user account unless for local audit user.
In case of local audit account when username not specified in request by default
account will be created with audit username, although administrators
are allowed to use any other non-duplicate usernames during creation.
POST /api/v1/node/users?action=create_user
POST /api/v1/node/users?action=create_audit_user

Delete node user


Delete specified user who is configured to log in to the NSX appliance.
Whereas local users root and administrator are not allowed to be deleted,
but local user audit is deletable on-demand.

Caution, users deleted from following node types cannot be recovered,
kindly plan the removal of user accounts accordingly.


  • Autonomous Edge

  • Cloud Service Manager

  • Edge

  • Public Cloud Gateway


 		DELETE /api/v1/node/users/{userid}

Read node user


Returns information about a specified user who is configured to log in to the
NSX appliance. The valid user IDs are: 0, 10000, 10002 or other users managed by administrators.
GET /api/v1/node/users/{userid}

Deactivate a user account


Deactivates the account for this user. Deactivating an account is
permanent, unlike an account that is temporarily locked because of
too many password failures. A deactivated account has to be explicitly
activated. When an account is successfully deactivated, the "status"
field in the response is "NOT_ACTIVATED".
This API is not supported for userid 0 and userid 10000.
POST /api/v1/node/users/{userid}?action=deactivate

Reset a user's password without requiring their current password


Unlike the PUT version of this call (PUT /node/users/<userid>), 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 is not supported for userid 0 and userid 10000.
POST /api/v1/node/users/{userid}?action=reset_password

Activate a user account with a password


Activates the account for this user. When an account is successfully
activated, the "status" field in the response is "ACTIVE".
This API is not supported for userid 0 and userid 10000.
POST /api/v1/node/users/{userid}?action=activate

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 (default) complexity requirements:
- minimum 12 characters in length
- minimum 128 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 configured password complexity may vary as per defined Authentication and Password policies,
which shall be available at: [GET]: /api/v1/node/aaa/auth-policy

The valid user IDs are: 0, 10000, 10002 or other users managed by administrators.
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}

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

Remove SSH public key from authorized_keys file for node user


 POST /api/v1/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

Read node version


 GET /api/v1/node/version

Get the site configuration, some attributes won't be shown based on version


 GET /api/v1/sites?version=3.0.2
GET /api/v1/sites?version=3.1.0
GET /api/v1/sites?version=latest

Get the site configuration


 GET /api/v1/sites

Get the compatibility list of the site


Returns the version of this site and list of compatible versions
GET /api/v1/sites/compatibility

Check whether the remote site version is compatible to this site


Returns the version of this site and list of compatible versions for both local and remote site,
also a boolean indicating whether the two are compatible, this value is true if one of the site
version is in the compatibility list of the other site
GET /api/v1/sites/compatibility/remote

Get the local site configuration


 GET /api/v1/sites/self

Get overall status of the federation, including stub status


 GET /api/v1/sites/status

Get the switchover status


 GET /api/v1/sites/switchover-status

Fetch the policy partial patch configuration value.


Get Configuration values for nsx-partial-patch.
By default partial patch is disabled (i.e false).
GET /global-manager/api/v1/system-config/nsx-partial-patch-config

Saves the configuration for policy partial patch


Update partial patch configuration values.
Only boolean value is allowed for enable_partial_patch
PATCH /global-manager/api/v1/system-config/nsx-partial-patch-config

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}

List the specified transport 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/transport-nodes/{transport-node-id}/network/interfaces

Read the transport 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/transport-nodes/{transport-node-id}/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/transport-nodes/{transport-node-id}/network/interfaces/{interface-id}/stats
Additional Links