NSX-T Data Center REST API

ZoneBasedSpan (type)

{
  "additionalProperties": false,
  "description": "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.",
  "extends": {
    "$ref": "BaseSpan"
  },
  "id": "ZoneBasedSpan",
  "module_id": "PolicyOrg",
  "polymorphic-type-descriptor": {
    "type-identifier": "ZoneBasedSpan"
  },
  "properties": {
    "type": {
      "description": "Span type",
      "enum": [
        "ClusterBasedSpan",
        "ZoneBasedSpan"
      ],
      "required": true,
      "title": "Span type",
      "type": "string"
    },
    "use_default_zones": {
      "description": "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.",
      "readonly": true,
      "required": false,
      "title": "Flag to indicate that TransitGateway is associated with default project zones.",
      "type": "boolean"
    },
    "zone_external_ids": {
      "description": "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.",
      "items": {
        "type": "string"
      },
      "maxItems": 10,
      "minItems": 0,
      "required": false,
      "title": "An array of Zone object's external IDs",
      "type": "array"
    }
  },
  "title": "Span based on zones",
  "type": "object"
}