System Administration > Configuration > Fabric > Nodes > NSX Edge

Associated URIs:

API Description API Path

Current configuration for this node


 GET /api/v1/transport-nodes/{transport-node-id}/node/configuration

Read edge config diagnosis


 GET /api/v1/transport-nodes/{transport-node-id}/node/diagnosis

Read edge diagnosis inconsistency


 GET /api/v1/transport-nodes/{transport-node-id}/node/diagnosis/inconsistency

Get NSX Edge stateful flows


 GET /api/v1/transport-nodes/{transport-node-id}/node/flows

Get NSX Edge stateful flows by interface


 GET /api/v1/transport-nodes/{transport-node-id}/node/flows/interfaces/{iface-uuid}

Get NSX Edge stateful flows by router


 GET /api/v1/transport-nodes/{transport-node-id}/node/flows/logical-routers/{uuid}

Logical-router diagnosis


Returns information of specified logical-router configured on edge.
GET /api/v1/transport-nodes/{transport-node-id}/node/logical-routers/{logical-router-id}/diagnosis

Logical-routers diagnosis


Returns information of all logical-routers or specified type of
logical-routers configured on edge.
GET /api/v1/transport-nodes/{transport-node-id}/node/logical-routers/diagnosis

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 EdgeDatapath service properties


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane

Restart, start or stop the NSX EdgeDatapath service


 POST /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane?action=restart
POST /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane?action=stop

Update NSX Edge Datapath service properties


 PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane

Get NSX Edge dataplane cpu stats


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/cpu-stats

Update NSX Edge dataplane control packets prioritization setting


Enable or disable NSX Edge dataplane control packets prioritization.
Dataplane service must be restarted for the change to take effect.
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/ctrl-prio

Check dynamic core feature enabled status of NSX Edge dataplane


Check current status of NSX Edge dataplane dynamic core feature.
GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/dynamic-core

Update NSX Edge dataplane dynamic core feature enabled status


Enable or disable NSX Edge dataplane dynamic core feature. Dataplane service must be
restarted for the change to take effect.
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/dynamic-core

Get NSX Edge dataplane flow cache setting


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/flow-cache

Update NSX Edge dataplane flow cache setting


Enable or disable NSX Edge dataplane flow cache. Dataplane service must be
restarted for the change to take effect.
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/flow-cache

Return top 10 flows information


Run flow monitor for timeout seconds for all or certain CPU core(s)
and return top 10 flows.
GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/flow-mon

Start NSX Edge dataplane flow monitor


Starts NSX Edge dataplane flow monitor on all or certain CPU core(s) with a timeout.
Stops flow monitor after timeout and dumps the flow file on local file store
on edge. If top_10 argument is set to true top 10 flows are collected,
else all flows are collected.
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/flow-mon

Get NSX Edge dataplane firewall connections


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/fw-conns

Get NSX Edge dataplane firewall stats


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/fw-stats

Update NSX Edge dataplane interrupt mode setting


Enable or disable NSX Edge dataplane interrupt mode.
Dataplane service must be restarted for the change to take effect.
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/intr-mode

Get NSX Edge dataplane l2vpn pmtu message generation setting


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/l2vpn-pmtu

Update NSX Edge dataplane l2vpn pmtu message generation setting


Enable or disable NSX Edge dataplane pmtu cache in l2vpn.
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/l2vpn-pmtu

Depreciated. Please use /node/services/dataplane/pmtu-learning


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/l3vpn-pmtu (Deprecated)

Depreciated. Please use /node/services/dataplane/pmtu-learning


 PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/l3vpn-pmtu (Deprecated)

Get NSX Edge dataplane pmtu learning setting


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/pmtu-learning

Update NSX Edge dataplane pmtu learning setting


Enable or disable NSX Edge dataplane pmtu learning
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/pmtu-learning

Update NSX Edge dataplane QAT feature enabled status


Enable or disable NSX Edge dataplane QAT feature. Dataplane service must be
restarted for the change to take effect.
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/qat-enable

Get NSX Edge dataplane QAT setting


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/qat-status

Get NSX Edge rx and tx queue number per port per core


Get NSX Edge rx and tx queue number per port per core.
GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/queue-num-per-port-per-core

Set NSX Edge rx and tx queue number per port per core


Set NSX Edge rx and tx queue number per port per core.
Dataplane service must be restarted for the change to take effect.
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/queue-num-per-port-per-core

Return rx/tx ring size information


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/ring-size

Set NSX Edge rx ring size for physical ports


Set NSX Edge rx ring size for physical ports.
Dataplane service must be restarted for the change to take effect.
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/rx-ring-size

Read NSX EdgeDatapath service status


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/status

Set NSX Edge tx ring size for physical ports


Set NSX Edge tx ring size for physical ports.
Dataplane service must be restarted for the change to take effect.
PUT /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/tx-ring-size

Check UPT mode enabled status of NSX Edge dataplane


Check current status of NSX Edge dataplane UPT mode.
GET /api/v1/transport-nodes/{transport-node-id}/node/services/dataplane/upt-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
POST /api/v1/transport-nodes/{transport-node-id}/node/services/local-controller?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/local-controller?action=stop

Read NSX EdgeNSXA service status


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/local-controller/status

Read NSX Nestdb service properties


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/nestdb

Restart, start or stop the NSX Nestdb service


 POST /api/v1/transport-nodes/{transport-node-id}/node/services/nestdb?action=restart
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nestdb?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nestdb?action=stop

Read NSX Nestdb service status


 GET /api/v1/transport-nodes/{transport-node-id}/node/services/nestdb/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
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nsx-opsagent?action=start
POST /api/v1/transport-nodes/{transport-node-id}/node/services/nsx-opsagent?action=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