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

Associated URIs:

API Description API Path

Get Edge maintenance mode


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

Set Edge maintenance mode


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

Read NSX Edge DHCP service properties


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

Update NSX Edge DHCP service properties


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

Read NSX Edge DHCP service status


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

Read NSX Edge Docker service properties


Read the Docker service process properties from Edge.
GET /api/v1/transport-nodes/<transport-node-id>/node/services/docker

Read NSX Edge Docker service status


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

Read NSX Edge Ipsec VPN service properties


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

Update NSX Edge Ipsec VPN service properties


PUT /api/v1/transport-nodes/<transport-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/transport-nodes/<transport-node-id>/node/services/ipsecvpn/status

Read NSX Edge NSXA service properties


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

Restart, start or stop the NSX EdgeNSXA service


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

Read NSX EdgeNSXA service status


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

Read NSX OpsAgent service properties


GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent

Restart, start or stop the NSX OpsAgent service


POST /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent?action=restart|start|stop

Read NSX OpsAgent service status


GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-opsagent/status

Read NSX EdgeMSR service properties


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

Read NSX EdgeMSRConfig service properties


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

Read NSX EdgeMSRConfig service status


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

Read NSX EdgeMSR service status


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

Read NSX security-hub service properties


GET /api/v1/transport-nodes/<transport-node-id>/node/services/security-hub

Read NSX Edge security-hub service status


GET /api/v1/transport-nodes/<transport-node-id>/node/services/security-hub/status