NSX-T Data Center REST API

Manual failover of the active-standby centralized transit gateway to the preferred edge node

The API is only supported if gateway high availability mode is active/standby and using non-preemptive failover mode.
The preferred edge node must be one of the two node paths where a gateway already exists.
To check existing edge nodes and their high availability status, refer to the transit gateway state API.

Request:

Method:
POST
URI Path(s):
/policy/api/v1/orgs/{org-id}/projects/{project-id}/transit-gateways/{transit-gateway-id}/actions/failover
Request Headers:
n/a
Query Parameters:
n/a
Request Body:
GatewayFailoverRequestParameters+

Example Request:

POST https://<policy-mgr>/policy/api/v1/orgs/default/projects/default/transit-gateways/default/actions/failover { "preferred_active_edge_path": "/infra/sites/default/enforcement-points/default/edge-clusters/8bd470cd-f932-4ec0-8836-910ddd9954ee/edge-nodes/0", }

Successful Response:

Response Code:
200 OK
Response Headers:
n/a
Response Body:
n/a

Example Response:

200 OK

Required Permissions:

crud

Feature:

policy_transit_gateway

Additional Errors: