System Administration > Configuration > Fabric > Nodes > NSX Edge

Associated URIs:

API Description API Path

Read edge config diagnosis


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

Get NSX Edge stateful flows


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

Get NSX Edge stateful flows by interface


 GET /api/v1/node/flows/interfaces/<iface-uuid>
GET /api/v1/transport-nodes/<transport-node-id>/node/flows/interfaces/<iface-uuid>
GET /api/v1/cluster/<cluster-node-id>/node/flows/interfaces/<iface-uuid>

Get NSX Edge stateful flows by router


 GET /api/v1/node/flows/logical-routers/<uuid>
GET /api/v1/transport-nodes/<transport-node-id>/node/flows/logical-routers/<uuid>
GET /api/v1/cluster/<cluster-node-id>/node/flows/logical-routers/<uuid>

Logical-router diagnosis


Returns information of specified logical-router configured on edge.
GET /api/v1/node/logical-routers/<logical-router-id>/diagnosis
GET /api/v1/transport-nodes/<transport-node-id>/node/logical-routers/<logical-router-id>/diagnosis
GET /api/v1/cluster/<cluster-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/node/logical-routers/diagnosis
GET /api/v1/transport-nodes/<transport-node-id>/node/logical-routers/diagnosis
GET /api/v1/cluster/<cluster-node-id>/node/logical-routers/diagnosis

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


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

Restart, start or stop the NSX EdgeDatapath service


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

Get NSX Edge dataplane cpu stats


 GET /api/v1/node/services/dataplane/cpu-stats
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/cpu-stats
GET /api/v1/cluster/<cluster-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/node/services/dataplane/ctrl-prio
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/ctrl-prio
PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/ctrl-prio

Get NSX Edge dataplane flow cache setting


 GET /api/v1/node/services/dataplane/flow-cache
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-cache
GET /api/v1/cluster/<cluster-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/node/services/dataplane/flow-cache
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-cache
PUT /api/v1/cluster/<cluster-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/node/services/dataplane/flow-mon
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-mon
GET /api/v1/cluster/<cluster-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/node/services/dataplane/flow-mon
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/flow-mon
PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/flow-mon

Get NSX Edge dataplane firewall connections


 GET /api/v1/node/services/dataplane/fw-conns
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/fw-conns
GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/fw-conns

Get NSX Edge dataplane firewall stats


 GET /api/v1/node/services/dataplane/fw-stats
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/fw-stats
GET /api/v1/cluster/<cluster-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/node/services/dataplane/intr-mode
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/intr-mode
PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/intr-mode

Get NSX Edge dataplane l2vpn pmtu setting


 GET /api/v1/node/services/dataplane/l2vpn-pmtu
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l2vpn-pmtu
GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/l2vpn-pmtu

Update NSX Edge dataplane l2vpn pmtu setting


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

Get NSX Edge dataplane l3vpn pmtu setting


 GET /api/v1/node/services/dataplane/l3vpn-pmtu
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l3vpn-pmtu
GET /api/v1/cluster/<cluster-node-id>/node/services/dataplane/l3vpn-pmtu

Update NSX Edge dataplane l3vpn pmtu setting


Enable or disable NSX Edge dataplane pmtu cache in l3vpn.
PUT /api/v1/node/services/dataplane/l3vpn-pmtu
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/l3vpn-pmtu
PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/l3vpn-pmtu

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/node/services/dataplane/qat-enable
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/qat-enable
PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/qat-enable

Get NSX Edge dataplane QAT setting


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

Return rx/tx ring size information


 GET /api/v1/node/services/dataplane/ring-size
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/ring-size
GET /api/v1/cluster/<cluster-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/node/services/dataplane/rx-ring-size
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/rx-ring-size
PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/rx-ring-size

Read NSX EdgeDatapath service status


 GET /api/v1/node/services/dataplane/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/status
GET /api/v1/cluster/<cluster-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/node/services/dataplane/tx-ring-size
PUT /api/v1/transport-nodes/<transport-node-id>/node/services/dataplane/tx-ring-size
PUT /api/v1/cluster/<cluster-node-id>/node/services/dataplane/tx-ring-size

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


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

Restart, start or stop the NSX Nestdb service


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

Read NSX Nestdb service status


 GET /api/v1/node/services/nestdb/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nestdb/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nestdb/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

Reset IPSec VPN session statistics


Reset IPSec VPN session statistics 		POST /api/v1/vpn/ipsec/sessions/<sessionid>/statistics?action=reset