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

URI

GET

https://nsxmanager.your.domain/api/v1/transport-zones

COPY

Query Parameters

string

cursor

Optional

Opaque cursor to be used for getting next page of records (supplied by current result page)

boolean

sort_ascending

Optional

sort_ascending

string

included_fields

Optional

Comma separated list of fields that should be included to result of query

integer

page_size

Optional

Maximum number of results to return in this page (server may return fewer)

string

sort_by

Optional

Field by which records are sorted

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

200

Success

Returns TransportZoneListResult of type(s) application/json

This response body class contains all of the following: ListResult , InlineTransportZoneListResult1

{
    "_self": {
        "rel": "string"
    },
    "cursor": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "sort_ascending": false,
    "result_count": 0,
    "_schema": "string",
    "sort_by": "string",
    "results": [
        {
            "_self": {
                "rel": "string"
            },
            "_system_owned": false,
            "display_name": "string",
            "description": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ],
            "_revision": 0,
            "_create_user": "string",
            "_schema": "string",
            "_create_time": 0,
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "id": "string",
            "resource_type": "string",
            "host_switch_name": "string",
            "transport_type": "string",
            "transport_zone_profile_ids": [
                {
                    "profile_id": "string",
                    "resource_type": "string"
                }
            ]
        }
    ]
}

default

Unexpected error

Returns ApiError of type(s) application/json

{
    "module_name": "string",
    "error_message": "string",
    "error_code": 0
}

string

module_name

Optional

module_name

string

error_message

Optional

error_message

integer As int64 As int64

error_code

Optional

error_code

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Network Transport Operations

POST

Create Bridge Cluster

POST

Create Bridge Endpoint

POST

Create Cluster Profile

POST

Create Edge Cluster

POST

Create Host Switch Profile

POST

Create Transport Node

POST

Create Transport Zone

POST

Create Transport Zone Profile

DELETE

Delete Bridge Cluster

DELETE

Delete Bridge Endpoint

DELETE

Delete Cluster Profile

DELETE

Delete Edge Cluster

DELETE

Delete Host Switch Profile

DELETE

Delete Transport Node