NSX-T Data Center REST API

# *************************************************************************** # Copyright 2020-2024 VMware, Inc. All rights reserved. VMware Confidential. # ***************************************************************************

ZoneBasedSpan (schema)

Span based on zones

Defines the TransitGateway/DistributedVlanConnection Zone configurations. Zone is a vCenter managed object discovered through NSX inventory. Zone is a collection of one or more clusters.

Name Description Type Notes
type Must be set to the value ZoneBasedSpan string Required
Enum: ClusterBasedSpan, ZoneBasedSpan
use_default_zones Flag to indicate that TransitGateway is associated with default project zones.

This field is system-generated. This field applicable only to TransitGateway created in user project and not applicable to default project.
If true, this indicates that TransitGateway is automatically associated with default zones shared with the project.
If TransitGateway configured without any span type and project is configured with zones,
then System will set the TransitGateway span type as 'ZoneBased" and
set flag 'use_default_zones' to true to indicates that TGW will be associated with project default zones.
If the user specifies zones during TransitGateway configuration, this field remains unpopulated.
boolean Readonly
zone_external_ids An array of Zone object's external IDs

An array of Zone objects identified by their external IDs. Zone object is a vCenter managed object and discovered through NSX inventory.
Each Zone object is identified by a "external_id" in the inventory.
Please refer NSX Zone APIs -
GET /fabric/zones - to list all discovered zones
GET /fabric/zones/{zone-id} - to view a specific zone configuration.
array of string Minimum items: 0
Maximum items: 10