System Administration > Configuration > System Properties

Associated URIs:

API Description API Path

Delete MPA configuration for this node


Delete the MPA configuration for this node. 		DELETE /api/v1/node/mpa-config
DELETE /api/v1/transport-nodes/<transport-node-id>/node/mpa-config
DELETE /api/v1/cluster/<cluster-node-id>/node/mpa-config

Get MPA configuration for this node


Retrieve the MPA configuration for this node to identify the Manager nodes with which this node is communicating. 		GET /api/v1/node/mpa-config (Experimental)
GET /api/v1/transport-nodes/<transport-node-id>/node/mpa-config (Experimental)
GET /api/v1/cluster/<cluster-node-id>/node/mpa-config (Experimental)

Update management plane agent configuration and restart MPA


PUT /api/v1/node/mpa-config?action=restart (Experimental)
PUT /api/v1/transport-nodes/<transport-node-id>/node/mpa-config?action=restart (Experimental)
PUT /api/v1/cluster/<cluster-node-id>/node/mpa-config?action=restart (Experimental)

Update MPA configuration for this node


Update the MPA configuration for this node. 		PUT /api/v1/node/mpa-config (Experimental)
PUT /api/v1/transport-nodes/<transport-node-id>/node/mpa-config (Experimental)
PUT /api/v1/cluster/<cluster-node-id>/node/mpa-config (Experimental)

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

Start NSX Edge dataplane flow monitor


Start NSX Edge dataplane flow monitor on certain core with a timeout.
Monitor stop after timeout and dump the flow file on local file store
on edge.
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

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

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

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

Get Edge VMC migration mode


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

Set Edge VMC migration mode


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

Get PCG registration payload


 GET /api/v1/pcg-registration-payload

Gets the realization state barrier configuration


Returns the current barrier configuration
GET /api/v1/realization-state-barrier/config

Updates the barrier configuration


Updates the barrier configuration having interval set in milliseconds
The new interval that automatically increments the global realization number
PUT /api/v1/realization-state-barrier/config

Gets the current barrier number


Returns the current global realization barrier number for NSX.
This method has been deprecated. To track realization state, use
X-NSX-REQUESTID request header instead.
GET /api/v1/realization-state-barrier/current (Deprecated)

Increments the barrier count by 1


Increment the current barrier number by 1 for NSX.
This method has been deprecated. To track realization state, use
X-NSX-REQUESTID request header instead.
POST /api/v1/realization-state-barrier/current?action=increment (Deprecated)