NSX-T Data Center Global Manager REST API

Associated URIs:

API Description API Path

List all segments under infra


Paginated list of all segments under infra.
GET /global-manager/api/v1/global-infra/segments

Delete infra segment


Delete infra segment 		DELETE /global-manager/api/v1/global-infra/segments/{segment-id}

Force delete infra segment


Force delete bypasses validations during segment deletion. This may result in an inconsistent connectivity. 		DELETE /global-manager/api/v1/global-infra/segments/{segment-id}?force=true

Read a network segment by ID


Returns the configuration of a specific NSX network segment (logical switch) identified
by segment ID. Segments provide Layer 2 connectivity for workloads and are connected to
a Tier-0 or Tier-1 gateway for Layer 3 routing.
Note: Extended Segment (L2VPN) — if an old vpn path was specified in the l2_extension
object in a previous PATCH request, the GET response may return the new canonicalized
path instead of the original path that was submitted.
instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.
Also note that l2vpn path included in the error messages returned from validation may include the new VPN path
instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.
GET /global-manager/api/v1/global-infra/segments/{segment-id}

Create or update a segment


If segment with the segment-id is not already present, create a new segment.
If it already exists, update the segment with specified attributes.
PATCH /global-manager/api/v1/global-infra/segments/{segment-id}

Create or update a segment


If segment with the segment-id is not already present, create a new segment.
If it already exists, update the segment with specified attributes.

Force parameter is required when workload connectivity is indirectly impacted
with the current update.
PATCH /global-manager/api/v1/global-infra/segments/{segment-id}?force=true

Create or update a infra segment


If segment with the segment-id is not already present, create a new segment.
If it already exists, replace the segment with this object.

Force parameter is required when workload connectivity is indirectly impacted
with the current replacement.
Note:
Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the
"l2_extension" object in the PATCH API payload, the path returned in the GET response payload may include the new path
instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.
Also note that l2vpn path included in the Alarm, GPRR, error messages returned from validation may include the new VPN path
instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.
PUT /global-manager/api/v1/global-infra/segments/{segment-id}?force=true

Create or update a infra segment


If segment with the segment-id is not already present, create a new segment.
If it already exists, replace the segment with this object.
Note:
Extended Segment: Please note that old vpn path deprecated. If user specify old l2vpn path in the
"l2_extension" object in the PATCH API payload, the path returned in the GET response payload may include the new path
instead of the deprecated l2vpn path. Both old and new l2vpn path refer to same resource. there is no functional impact.
Also note that l2vpn path included in the Alarm, GPRR, error messages returned from validation may include the new VPN path
instead of the deprecated l2vpn path. Both new path and old vpn path refer to same resource.
PUT /global-manager/api/v1/global-infra/segments/{segment-id}

List all effective profiles for infra segment


List all effective profiles for this segment on given enforcement point. 		GET /global-manager/api/v1/global-infra/segments/{segment-id}/effective-profiles