| API Description |
API Path |
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/transport-nodes/{transport-node-id}/node
GET /api/v1/cluster/{cluster-node-id}/node
GET /api/v1/node
|
Restart or shutdown node
Restarts or shuts down the NSX appliance.
|
POST /api/v1/transport-nodes/{transport-node-id}/node?action=restart
POST /api/v1/transport-nodes/{transport-node-id}/node?action=shutdown
POST /api/v1/cluster/{cluster-node-id}/node?action=restart
POST /api/v1/cluster/{cluster-node-id}/node?action=shutdown
POST /api/v1/node?action=restart
POST /api/v1/node?action=shutdown
|
Set the node system time
Set the node system time to the given time in UTC in the RFC3339 format
'yyyy-mm-ddThh:mm:ssZ'.
|
POST /api/v1/transport-nodes/{transport-node-id}/node?action=set_system_time
POST /api/v1/cluster/{cluster-node-id}/node?action=set_system_time
POST /api/v1/node?action=set_system_time
|
Update node properties
Modifies NSX appliance properties. Modifiable properties include the
timezone, message of the day (motd), and hostname. The NSX appliance
node_version, system_time, and kernel_version are read only and cannot be
modified with this method.
|
PUT /api/v1/transport-nodes/{transport-node-id}/node
PUT /api/v1/cluster/{cluster-node-id}/node
PUT /api/v1/node
|
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/transport-nodes/{transport-node-id}/node/processes
GET /api/v1/cluster/{cluster-node-id}/node/processes
GET /api/v1/node/processes
|
Read node process
Returns information for a specified process ID (pid).
|
GET /api/v1/transport-nodes/{transport-node-id}/node/processes/{process-id}
GET /api/v1/cluster/{cluster-node-id}/node/processes/{process-id}
GET /api/v1/node/processes/{process-id}
|
Read node status
Returns information about the node appliance's file system, CPU,
memory, disk usage, and uptime.
|
GET /api/v1/transport-nodes/{transport-node-id}/node/status
GET /api/v1/cluster/{cluster-node-id}/node/status
GET /api/v1/node/status
|
Update node status
Clear node bootup status
|
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
POST /api/v1/node/status?action=clear_bootup_error
|
Read node version
|
GET /api/v1/transport-nodes/{transport-node-id}/node/version
GET /api/v1/cluster/{cluster-node-id}/node/version
GET /api/v1/node/version
|