1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getTransportZone
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

nsxt.getTransportZone

Explore with Pulumi AI

nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware

This data source provides information about Transport Zones (TZ) configured in NSX. A Transport Zone defines the scope to which a network can extend in NSX. For example an overlay based Transport Zone is associated with both hypervisors and logical switches and defines which hypervisors will be able to serve the defined logical switch. Virtual machines on the hypervisor associated with a Transport Zone can be attached to logical switches in that same Transport Zone.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";

const overlayTransportZone = nsxt.getTransportZone({
    displayName: "1-transportzone-87",
});
Copy
import pulumi
import pulumi_nsxt as nsxt

overlay_transport_zone = nsxt.get_transport_zone(display_name="1-transportzone-87")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/nsxt/v3/nsxt"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := nsxt.GetTransportZone(ctx, &nsxt.GetTransportZoneArgs{
			DisplayName: pulumi.StringRef("1-transportzone-87"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;

return await Deployment.RunAsync(() => 
{
    var overlayTransportZone = Nsxt.GetTransportZone.Invoke(new()
    {
        DisplayName = "1-transportzone-87",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.nsxt.NsxtFunctions;
import com.pulumi.nsxt.inputs.GetTransportZoneArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var overlayTransportZone = NsxtFunctions.getTransportZone(GetTransportZoneArgs.builder()
            .displayName("1-transportzone-87")
            .build());

    }
}
Copy
variables:
  overlayTransportZone:
    fn::invoke:
      function: nsxt:getTransportZone
      arguments:
        displayName: 1-transportzone-87
Copy

Using getTransportZone

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getTransportZone(args: GetTransportZoneArgs, opts?: InvokeOptions): Promise<GetTransportZoneResult>
function getTransportZoneOutput(args: GetTransportZoneOutputArgs, opts?: InvokeOptions): Output<GetTransportZoneResult>
Copy
def get_transport_zone(description: Optional[str] = None,
                       display_name: Optional[str] = None,
                       host_switch_name: Optional[str] = None,
                       id: Optional[str] = None,
                       transport_type: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetTransportZoneResult
def get_transport_zone_output(description: Optional[pulumi.Input[str]] = None,
                       display_name: Optional[pulumi.Input[str]] = None,
                       host_switch_name: Optional[pulumi.Input[str]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       transport_type: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetTransportZoneResult]
Copy
func GetTransportZone(ctx *Context, args *GetTransportZoneArgs, opts ...InvokeOption) (*GetTransportZoneResult, error)
func GetTransportZoneOutput(ctx *Context, args *GetTransportZoneOutputArgs, opts ...InvokeOption) GetTransportZoneResultOutput
Copy

> Note: This function is named GetTransportZone in the Go SDK.

public static class GetTransportZone 
{
    public static Task<GetTransportZoneResult> InvokeAsync(GetTransportZoneArgs args, InvokeOptions? opts = null)
    public static Output<GetTransportZoneResult> Invoke(GetTransportZoneInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetTransportZoneResult> getTransportZone(GetTransportZoneArgs args, InvokeOptions options)
public static Output<GetTransportZoneResult> getTransportZone(GetTransportZoneArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: nsxt:index/getTransportZone:getTransportZone
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Description string
The description of the Transport Zone.
DisplayName string
The Display Name prefix of the Transport Zone to retrieve.
HostSwitchName string
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
Id string
The ID of Transport Zone to retrieve.
TransportType string
The transport type of this transport zone (OVERLAY or VLAN).
Description string
The description of the Transport Zone.
DisplayName string
The Display Name prefix of the Transport Zone to retrieve.
HostSwitchName string
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
Id string
The ID of Transport Zone to retrieve.
TransportType string
The transport type of this transport zone (OVERLAY or VLAN).
description String
The description of the Transport Zone.
displayName String
The Display Name prefix of the Transport Zone to retrieve.
hostSwitchName String
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
id String
The ID of Transport Zone to retrieve.
transportType String
The transport type of this transport zone (OVERLAY or VLAN).
description string
The description of the Transport Zone.
displayName string
The Display Name prefix of the Transport Zone to retrieve.
hostSwitchName string
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
id string
The ID of Transport Zone to retrieve.
transportType string
The transport type of this transport zone (OVERLAY or VLAN).
description str
The description of the Transport Zone.
display_name str
The Display Name prefix of the Transport Zone to retrieve.
host_switch_name str
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
id str
The ID of Transport Zone to retrieve.
transport_type str
The transport type of this transport zone (OVERLAY or VLAN).
description String
The description of the Transport Zone.
displayName String
The Display Name prefix of the Transport Zone to retrieve.
hostSwitchName String
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
id String
The ID of Transport Zone to retrieve.
transportType String
The transport type of this transport zone (OVERLAY or VLAN).

getTransportZone Result

The following output properties are available:

Description string
The description of the Transport Zone.
DisplayName string
HostSwitchName string
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
Id string
TransportType string
The transport type of this transport zone (OVERLAY or VLAN).
Description string
The description of the Transport Zone.
DisplayName string
HostSwitchName string
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
Id string
TransportType string
The transport type of this transport zone (OVERLAY or VLAN).
description String
The description of the Transport Zone.
displayName String
hostSwitchName String
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
id String
transportType String
The transport type of this transport zone (OVERLAY or VLAN).
description string
The description of the Transport Zone.
displayName string
hostSwitchName string
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
id string
transportType string
The transport type of this transport zone (OVERLAY or VLAN).
description str
The description of the Transport Zone.
display_name str
host_switch_name str
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
id str
transport_type str
The transport type of this transport zone (OVERLAY or VLAN).
description String
The description of the Transport Zone.
displayName String
hostSwitchName String
The name of the N-VDS (host switch) on all Transport Nodes in this Transport Zone that will be used to run NSX network traffic.
id String
transportType String
The transport type of this transport zone (OVERLAY or VLAN).

Package Details

Repository
nsxt vmware/terraform-provider-nsxt
License
Notes
This Pulumi package is based on the nsxt Terraform Provider.
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware