List Transport Zones

Returns information about configured transport zones. NSX requires at
least one transport zone. NSX uses transport zones to provide connectivity
based on the topology of the underlying network, trust zones, or
organizational separations. For example, you might have hypervisors that
use one network for management traffic and a different network for VM
traffic. This architecture would require two transport zones. The
combination of transport zones plus transport connectors enables NSX to
form tunnels between hypervisors. Transport zones define which interfaces
on the hypervisors can communicate with which other interfaces on other
hypervisors to establish overlay tunnels or provide connectivity to a VLAN.
A logical switch can be in one (and only one) transport zone. This means
that all of a switch's interfaces must be in the same transport zone.
However, each hypervisor virtual switch (OVS or VDS) has multiple
interfaces (connectors), and each connector can be attached to a different
logical switch. For example, on a single hypervisor with two connectors,
connector A can be attached to logical switch 1 in transport zone A, while
connector B is attached to logical switch 2 in transport zone B. In this
way, a single hypervisor can participate in multiple transport zones. The
API for creating a transport zone requires that a single host switch be
specified for each transport zone, and multiple transport zones can share
the same host switch.

Request:

Method:

GET

URI Path(s):

/api/v1/transport-zones

Request Headers:

n/a

Query Parameters:

TransportZoneListParameters+

TransportZoneListParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
include_system_owned	Filter to indicate whether to include system owned Transport Zones.	boolean	Default: "False"
included_fields	Comma separated list of fields that should be included in query result	string
is_default	Filter to choose if default transport zones will be returned If set to true, only the default transport zones will be returned. If set to false, all transport zones except the default ones will be returned. If unset, all transport zones will be returned.	boolean
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
transport_type	Filter to choose the type of transport zones to return If set, only transport zones of the given type will be returned; otherwise transport zones of all types will be returned.	TransportType
uplink_teaming_policy_name	The transport zone's uplink teaming policy name All transport zone's with the specified uplink teaming policy name. Otherwise, transport zones with any uplink teaming policy will be returned.	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/transport-zones/

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TransportZoneListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Transport Zone Results	array of TransportZone	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results": [ { "_revision": 0, "id": "c08d57bf-247d-4a5e-9acd-c5f2860e2872", "resource_type": "TransportZone", "transport_type": "OVERLAY", "host_switch_name": "host2", "_last_modified_user": "admin", "_last_modified_time": 1412873095391, "_create_time": 1412873095391, "_create_user": "admin", "_schema": "/v1/schema/TransportZone" }, { "_revision": 0, "id": "7c57c5a7-c742-4ee2-8fae-a9ac6a01309c", "resource_type": "TransportZone", "transport_type": "OVERLAY", "host_switch_name": "host1", "_last_modified_user": "admin", "_last_modified_time": 1412873062407, "_create_time": 1412873062407, "_create_user": "admin", "_schema": "/v1/schema/TransportZone" }, { "_revision": 0, "id": "c55ec097-0b53-4103-9426-18e135250c29", "resource_type": "TransportZone", "transport_type": "OVERLAY", "host_switch_name": "host1", "_last_modified_user": "admin", "_last_modified_time": 1412877285032, "_create_time": 1412877285032, "_create_user": "admin", "_schema": "/v1/schema/TransportZone" } ] }

List Transport Zones

Request:

TransportZoneListParameters (schema)

Example Request:

Successful Response:

TransportZoneListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: