System Administration > Configuration > NSX Managers > Nodes > Services > NSX Control Plane Agent Service

Associated URIs:

API Description API Path

Read NSX Control Plane Agent service properties


GET /api/v1/node/services/nsx-control-plane-agent
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-control-plane-agent

Restart, start or stop the NSX Control Plane Agent service


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

Read NSX Control Plane Agent service status


GET /api/v1/node/services/nsx-control-plane-agent/status
GET /api/v1/transport-nodes/<transport-node-id>/node/services/nsx-control-plane-agent/status
GET /api/v1/cluster/<cluster-node-id>/node/services/nsx-control-plane-agent/status