| 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/node
GET /api/v1/transport-nodes/<transport-node-id>/node
GET /api/v1/cluster/<cluster-node-id>/node
|
Restart or shutdown node
Restarts or shuts down the NSX appliance.
|
POST /api/v1/node?action=restart|shutdown
POST /api/v1/transport-nodes/<transport-node-id>/node?action=restart|shutdown
POST /api/v1/cluster/<cluster-node-id>/node?action=restart|shutdown
|
Set the node system time
Set the node system time to the given time in UTC in the RFC3339 format
'yyyy-mm-ddThh:mm:ssZ'.
|
POST /api/v1/node?action=set_system_time
POST /api/v1/transport-nodes/<transport-node-id>/node?action=set_system_time
POST /api/v1/cluster/<cluster-node-id>/node?action=set_system_time
|
Update node properties
Modifies NSX appliance properties. Modifiable properties include the
timezone, message of the day (motd), and hostname. The NSX appliance
node_version, system_time, and kernel_version are read only and cannot be
modified with this method.
|
PUT /api/v1/node
PUT /api/v1/transport-nodes/<transport-node-id>/node
PUT /api/v1/cluster/<cluster-node-id>/node
|
Read Central Config properties
|
GET /api/v1/node/central-config
GET /api/v1/transport-nodes/<transport-node-id>/node/central-config
GET /api/v1/cluster/<cluster-node-id>/node/central-config
|
Update Central Config properties
|
PUT /api/v1/node/central-config
PUT /api/v1/transport-nodes/<transport-node-id>/node/central-config
PUT /api/v1/cluster/<cluster-node-id>/node/central-config
|
Current configuration for this node
|
GET /api/v1/node/configuration
GET /api/v1/transport-nodes/<transport-node-id>/node/configuration
GET /api/v1/cluster/<cluster-node-id>/node/configuration
|
NodeMode
Returns current Node Mode.
|
GET /api/v1/node/mode
GET /api/v1/transport-nodes/<transport-node-id>/node/mode
GET /api/v1/cluster/<cluster-node-id>/node/mode
|
Read node status
Returns information about the NSX Manager appliance's file system, CPU,
memory, disk usage, and uptime.
|
GET /api/v1/node/status
GET /api/v1/transport-nodes/<transport-node-id>/node/status
GET /api/v1/cluster/<cluster-node-id>/node/status
|
Update node status
Clear node bootup status
|
POST /api/v1/node/status?action=clear_bootup_error
POST /api/v1/transport-nodes/<transport-node-id>/node/status?action=clear_bootup_error
POST /api/v1/cluster/<cluster-node-id>/node/status?action=clear_bootup_error
|
Read node 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
|