System Administration > Configuration > Fabric > Nodes > NSX Edge > Services

Associated URIs:

API Description API Path

Get Edge maintenance mode


GET /api/v1/node/maintenance-mode
GET /api/v1/transport-nodes/<transport-node-id>/node/maintenance-mode
GET /api/v1/cluster/<cluster-node-id>/node/maintenance-mode

Set Edge maintenance mode


PUT /api/v1/node/maintenance-mode
PUT /api/v1/transport-nodes/<transport-node-id>/node/maintenance-mode
PUT /api/v1/cluster/<cluster-node-id>/node/maintenance-mode

Read NSX Edge DHCP service properties


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

Read NSX Edge DHCP service status


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

Read NSX Edge Ipsec VPN service properties


Read the IPsec VPN service process properties from Edge.
GET /api/v1/node/services/ipsecvpn
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn
GET /api/v1/cluster/<cluster-node-id>/node/services/ipsecvpn

Read NSX Edge Ipsec VPN service status


Checks the status of iked process on the Edge.
If iked process is running, returns "running",
returns "stopped" otherwise.
GET /api/v1/node/services/ipsecvpn/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/ipsecvpn/status
GET /api/v1/cluster/<cluster-node-id>/node/services/ipsecvpn/status

Read NSX Edge NSXA service properties


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

Restart, start or stop the NSX EdgeNSXA service


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

Read NSX EdgeNSXA service status


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

Read NSX EdgeMSR service properties


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

Read NSX EdgeMSRConfig service properties


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

Read NSX EdgeMSRConfig service status


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

Read NSX EdgeMSR service status


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