| API Description |
API Path |
List node services
Returns a list of all services available on the node applicance.
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services
GET /api/v1/cluster/{cluster-node-id}/node/services
GET /api/v1/node/services
|
Read liagent service properties
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/liagent
GET /api/v1/cluster/{cluster-node-id}/node/services/liagent
GET /api/v1/node/services/liagent
|
Restart, start or stop the liagent service
|
POST /api/v1/transport-nodes/{transport-node-id}/node/services/liagent?action=restart
POST /api/v1/transport-nodes/{transport-node-id}/node/services/liagent?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/liagent?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/liagent?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/liagent?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/liagent?action=stop
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/transport-nodes/{transport-node-id}/node/services/liagent/status
GET /api/v1/cluster/{cluster-node-id}/node/services/liagent/status
GET /api/v1/node/services/liagent/status
|
Read appliance management service properties
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/node-mgmt
GET /api/v1/cluster/{cluster-node-id}/node/services/node-mgmt
GET /api/v1/node/services/node-mgmt
|
Restart the node management service
|
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
POST /api/v1/node/services/node-mgmt?action=restart
|
Retrieve Node Management loglevel
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/node-mgmt/loglevel
GET /api/v1/cluster/{cluster-node-id}/node/services/node-mgmt/loglevel
GET /api/v1/node/services/node-mgmt/loglevel
|
Set Node Management loglevel
|
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/node-mgmt/loglevel
PUT /api/v1/cluster/{cluster-node-id}/node/services/node-mgmt/loglevel
PUT /api/v1/node/services/node-mgmt/loglevel
|
Read appliance management service 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
GET /api/v1/node/services/node-mgmt/status
|
Read NSX Message Bus service properties
|
GET /api/v1/cluster/{cluster-node-id}/node/services/nsx-message-bus
GET /api/v1/node/services/nsx-message-bus
|
Restart, start or stop the NSX Message Bus service
|
POST /api/v1/cluster/{cluster-node-id}/node/services/nsx-message-bus?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/nsx-message-bus?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/nsx-message-bus?action=stop
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/cluster/{cluster-node-id}/node/services/nsx-message-bus/status
GET /api/v1/node/services/nsx-message-bus/status
|
Read NSX Platform Client service properties
|
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
GET /api/v1/node/services/nsx-platform-client
|
Restart, start or stop the NSX Platform Client service
|
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nsx-platform-client?action=restart
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nsx-platform-client?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nsx-platform-client?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/nsx-platform-client?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/nsx-platform-client?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/nsx-platform-client?action=stop
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/transport-nodes/{transport-node-id}/node/services/nsx-platform-client/status
GET /api/v1/cluster/{cluster-node-id}/node/services/nsx-platform-client/status
GET /api/v1/node/services/nsx-platform-client/status
|
Read NSX upgrade Agent service properties
|
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
GET /api/v1/node/services/nsx-upgrade-agent
|
Restart, start or stop the NSX upgrade agent service
|
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nsx-upgrade-agent?action=restart
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nsx-upgrade-agent?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nsx-upgrade-agent?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/nsx-upgrade-agent?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/nsx-upgrade-agent?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/nsx-upgrade-agent?action=stop
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/transport-nodes/{transport-node-id}/node/services/nsx-upgrade-agent/status
GET /api/v1/cluster/{cluster-node-id}/node/services/nsx-upgrade-agent/status
GET /api/v1/node/services/nsx-upgrade-agent/status
|
Read NTP service properties
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/ntp
GET /api/v1/cluster/{cluster-node-id}/node/services/ntp
GET /api/v1/node/services/ntp
|
Restart, start or stop the NTP service
|
POST /api/v1/transport-nodes/{transport-node-id}/node/services/ntp?action=restart
POST /api/v1/transport-nodes/{transport-node-id}/node/services/ntp?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/ntp?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/ntp?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/ntp?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/ntp?action=stop
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/transport-nodes/{transport-node-id}/node/services/ntp
PUT /api/v1/cluster/{cluster-node-id}/node/services/ntp
PUT /api/v1/node/services/ntp
|
Read NTP service status
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/ntp/status
GET /api/v1/cluster/{cluster-node-id}/node/services/ntp/status
GET /api/v1/node/services/ntp/status
|
Read SNMP service properties
Read SNMP service properties.
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/snmp
GET /api/v1/cluster/{cluster-node-id}/node/services/snmp
GET /api/v1/node/services/snmp
|
Restart, start or stop the SNMP service
|
POST /api/v1/transport-nodes/{transport-node-id}/node/services/snmp?action=restart
POST /api/v1/transport-nodes/{transport-node-id}/node/services/snmp?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/snmp?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/snmp?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/snmp?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/snmp?action=stop
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/transport-nodes/{transport-node-id}/node/services/snmp
PUT /api/v1/cluster/{cluster-node-id}/node/services/snmp
PUT /api/v1/node/services/snmp
|
Read SNMP service status
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/snmp/status
GET /api/v1/cluster/{cluster-node-id}/node/services/snmp/status
GET /api/v1/node/services/snmp/status
|
Read 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
GET /api/v1/node/services/snmp/v3-engine-id
|
Update 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
PUT /api/v1/node/services/snmp/v3-engine-id
|
Read ssh service properties
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/ssh
GET /api/v1/cluster/{cluster-node-id}/node/services/ssh
GET /api/v1/node/services/ssh
|
Restart, start or stop the ssh service
|
POST /api/v1/transport-nodes/{transport-node-id}/node/services/ssh?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/ssh?action=stop
POST /api/v1/transport-nodes/{transport-node-id}/node/services/ssh?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/ssh?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/ssh?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/ssh?action=restart
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/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
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/transport-nodes/{transport-node-id}/node/services/ssh
PUT /api/v1/cluster/{cluster-node-id}/node/services/ssh
PUT /api/v1/node/services/ssh
|
Restart, start or stop the ssh service
|
POST /api/v1/transport-nodes/{transport-node-id}/node/services/ssh/notify_mpa?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/ssh/notify_mpa?action=stop
POST /api/v1/transport-nodes/{transport-node-id}/node/services/ssh/notify_mpa?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/ssh/notify_mpa?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/ssh/notify_mpa?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/ssh/notify_mpa?action=restart
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/transport-nodes/{transport-node-id}/node/services/ssh/status
GET /api/v1/cluster/{cluster-node-id}/node/services/ssh/status
GET /api/v1/node/services/ssh/status
|
Read syslog service properties
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/syslog
GET /api/v1/cluster/{cluster-node-id}/node/services/syslog
GET /api/v1/node/services/syslog
|
Restart, start or stop the syslog service
|
POST /api/v1/transport-nodes/{transport-node-id}/node/services/syslog?action=restart
POST /api/v1/transport-nodes/{transport-node-id}/node/services/syslog?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/syslog?action=stop
POST /api/v1/cluster/{cluster-node-id}/node/services/syslog?action=restart
POST /api/v1/cluster/{cluster-node-id}/node/services/syslog?action=start
POST /api/v1/cluster/{cluster-node-id}/node/services/syslog?action=stop
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/transport-nodes/{transport-node-id}/node/services/syslog/exporters
DELETE /api/v1/cluster/{cluster-node-id}/node/services/syslog/exporters
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/transport-nodes/{transport-node-id}/node/services/syslog/exporters
GET /api/v1/cluster/{cluster-node-id}/node/services/syslog/exporters
GET /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/transport-nodes/{transport-node-id}/node/services/syslog/exporters?action=verify
POST /api/v1/cluster/{cluster-node-id}/node/services/syslog/exporters?action=verify
POST /api/v1/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/transport-nodes/{transport-node-id}/node/services/syslog/exporters
POST /api/v1/cluster/{cluster-node-id}/node/services/syslog/exporters
POST /api/v1/node/services/syslog/exporters
|
Delete node syslog exporter
Removes a specified rule from the collection of syslog exporter rules.
|
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}
DELETE /api/v1/node/services/syslog/exporters/{exporter-name}
|
Read node syslog exporter
Returns information about a specific syslog collection point.
|
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}
GET /api/v1/node/services/syslog/exporters/{exporter-name}
|
Read syslog service status
|
GET /api/v1/transport-nodes/{transport-node-id}/node/services/syslog/status
GET /api/v1/cluster/{cluster-node-id}/node/services/syslog/status
GET /api/v1/node/services/syslog/status
|
List appliance management tasks
|
GET /api/v1/transport-nodes/{transport-node-id}/node/tasks
GET /api/v1/cluster/{cluster-node-id}/node/tasks
GET /api/v1/node/tasks
|
Delete task
|
DELETE /api/v1/transport-nodes/{transport-node-id}/node/tasks/{task-id}
DELETE /api/v1/cluster/{cluster-node-id}/node/tasks/{task-id}
DELETE /api/v1/node/tasks/{task-id}
|
Read task properties
|
GET /api/v1/transport-nodes/{transport-node-id}/node/tasks/{task-id}
GET /api/v1/cluster/{cluster-node-id}/node/tasks/{task-id}
GET /api/v1/node/tasks/{task-id}
|
Cancel specified task
|
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
POST /api/v1/node/tasks/{task-id}?action=cancel
|
Read asynchronous task 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
GET /api/v1/node/tasks/{task-id}/response
|