NSX-T Data Center REST API

Sync the edge node configuration

This API synchronizes the Edge Transport Node intent with the latest configuration from external sources,
including vCenter Server and the Edge Node Command Line Interface (CLI). The API supports an optional operation_type
request parameter to control the synchronization scope.

Request Parameters:
operation_type (optional): Specifies the type of synchronization operation to perform. Valid values:
SYNC_VC_CONFIG: Synchronize with vCenter Server configuration only
SYNC_ALL: Synchronize with both vCenter Server and Edge Node CLI configuration

Default behavior (no operation_type specified):
When the Edge Transport Node intent differs from the VM configuration in vCenter, the API retrieves the latest VM details
from vCenter (including compute cluster ID, storage ID, reservation information, and other VM properties) and updates the
Edge Transport Node intent accordingly.

Behavior when operation_type = SYNC_VC_CONFIG:
Behaves same as default case, synchronizing only with the vCenter Server configuration.

Behavior when operation_type = SYNC_ALL:
When the Edge Transport Node intent differs from either the Edge Node CLI configuration or the VM configuration in vCenter,
the API retrieves configuration from both sources:
- CLI settings: Hostname, search domains, NTP servers, DNS servers, syslog servers, and other CLI-configured parameters
- VM details from vCenter: Compute cluster ID, storage ID, reservation information, and other VM properties
The Edge Transport Node intent is then updated with all retrieved values from both sources.

To view the updated data in Edge Transport Node intent, send a GET request to the following URL:
https://<nsx-mgr>/policy/api/v1/infra/sites/<>/enforcement-points/<>/edge-transport-nodes/<>

Request:

Method:
POST
URI Path(s):
/policy/api/v1/infra/sites/{site-id}/enforcement-points/{enforcement-point-id}/edge-transport-nodes/{edge-transport-node-id}/action/sync-edge-configuration
Request Headers:
n/a
Query Parameters:
PolicyEdgeTransportNodeRefreshRequestParameters+
Request Body:
n/a

Example Request:

POST https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-transport-nodes/action/sync-edge-configuration POST https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-transport-nodes/action/sync-edge-configuration?operation_type=SYNC_ALL POST https://<policy-mgr>/policy/api/v1/infra/sites/default/enforcement-points/default/edge-transport-nodes/action/sync-edge-configuration?operation_type=SYNC_VC_CONFIG

Successful Response:

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

Example Response:

# 200 OK

Required Permissions:

crud

Feature:

nodes_transport_nodes

Additional Errors: