1. Packages
  2. Vcd Provider
  3. API Docs
  4. getNsxtTier0Router
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getNsxtTier0Router

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Provides a data source for available NSX-T Tier-0 routers.

    Supported in provider v3.0+

    Note: This resource uses new VMware Cloud Director OpenAPI and requires at least VCD 10.1.1+ and NSX-T 3.0+.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const main = vcd.getNsxtManager({
        name: "nsxt-manager-one",
    });
    const router = main.then(main => vcd.getNsxtTier0Router({
        name: "nsxt-tier0-router",
        nsxtManagerId: main.id,
    }));
    
    import pulumi
    import pulumi_vcd as vcd
    
    main = vcd.get_nsxt_manager(name="nsxt-manager-one")
    router = vcd.get_nsxt_tier0_router(name="nsxt-tier0-router",
        nsxt_manager_id=main.id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		main, err := vcd.GetNsxtManager(ctx, &vcd.GetNsxtManagerArgs{
    			Name: "nsxt-manager-one",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = vcd.GetNsxtTier0Router(ctx, &vcd.GetNsxtTier0RouterArgs{
    			Name:          "nsxt-tier0-router",
    			NsxtManagerId: main.Id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Vcd = Pulumi.Vcd;
    
    return await Deployment.RunAsync(() => 
    {
        var main = Vcd.GetNsxtManager.Invoke(new()
        {
            Name = "nsxt-manager-one",
        });
    
        var router = Vcd.GetNsxtTier0Router.Invoke(new()
        {
            Name = "nsxt-tier0-router",
            NsxtManagerId = main.Apply(getNsxtManagerResult => getNsxtManagerResult.Id),
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.vcd.VcdFunctions;
    import com.pulumi.vcd.inputs.GetNsxtManagerArgs;
    import com.pulumi.vcd.inputs.GetNsxtTier0RouterArgs;
    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 main = VcdFunctions.getNsxtManager(GetNsxtManagerArgs.builder()
                .name("nsxt-manager-one")
                .build());
    
            final var router = VcdFunctions.getNsxtTier0Router(GetNsxtTier0RouterArgs.builder()
                .name("nsxt-tier0-router")
                .nsxtManagerId(main.applyValue(getNsxtManagerResult -> getNsxtManagerResult.id()))
                .build());
    
        }
    }
    
    variables:
      main:
        fn::invoke:
          function: vcd:getNsxtManager
          arguments:
            name: nsxt-manager-one
      router:
        fn::invoke:
          function: vcd:getNsxtTier0Router
          arguments:
            name: nsxt-tier0-router
            nsxtManagerId: ${main.id}
    

    Using getNsxtTier0Router

    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 getNsxtTier0Router(args: GetNsxtTier0RouterArgs, opts?: InvokeOptions): Promise<GetNsxtTier0RouterResult>
    function getNsxtTier0RouterOutput(args: GetNsxtTier0RouterOutputArgs, opts?: InvokeOptions): Output<GetNsxtTier0RouterResult>
    def get_nsxt_tier0_router(id: Optional[str] = None,
                              name: Optional[str] = None,
                              nsxt_manager_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetNsxtTier0RouterResult
    def get_nsxt_tier0_router_output(id: Optional[pulumi.Input[str]] = None,
                              name: Optional[pulumi.Input[str]] = None,
                              nsxt_manager_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetNsxtTier0RouterResult]
    func GetNsxtTier0Router(ctx *Context, args *GetNsxtTier0RouterArgs, opts ...InvokeOption) (*GetNsxtTier0RouterResult, error)
    func GetNsxtTier0RouterOutput(ctx *Context, args *GetNsxtTier0RouterOutputArgs, opts ...InvokeOption) GetNsxtTier0RouterResultOutput

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

    public static class GetNsxtTier0Router 
    {
        public static Task<GetNsxtTier0RouterResult> InvokeAsync(GetNsxtTier0RouterArgs args, InvokeOptions? opts = null)
        public static Output<GetNsxtTier0RouterResult> Invoke(GetNsxtTier0RouterInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNsxtTier0RouterResult> getNsxtTier0Router(GetNsxtTier0RouterArgs args, InvokeOptions options)
    public static Output<GetNsxtTier0RouterResult> getNsxtTier0Router(GetNsxtTier0RouterArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getNsxtTier0Router:getNsxtTier0Router
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    NSX-T Tier-0 router name. Note. Tier-0 router name must be unique inside NSX-T manager because API does not allow to filter by other fields.
    NsxtManagerId string
    NSX-T manager should be referenced.
    Id string
    Name string
    NSX-T Tier-0 router name. Note. Tier-0 router name must be unique inside NSX-T manager because API does not allow to filter by other fields.
    NsxtManagerId string
    NSX-T manager should be referenced.
    Id string
    name String
    NSX-T Tier-0 router name. Note. Tier-0 router name must be unique inside NSX-T manager because API does not allow to filter by other fields.
    nsxtManagerId String
    NSX-T manager should be referenced.
    id String
    name string
    NSX-T Tier-0 router name. Note. Tier-0 router name must be unique inside NSX-T manager because API does not allow to filter by other fields.
    nsxtManagerId string
    NSX-T manager should be referenced.
    id string
    name str
    NSX-T Tier-0 router name. Note. Tier-0 router name must be unique inside NSX-T manager because API does not allow to filter by other fields.
    nsxt_manager_id str
    NSX-T manager should be referenced.
    id str
    name String
    NSX-T Tier-0 router name. Note. Tier-0 router name must be unique inside NSX-T manager because API does not allow to filter by other fields.
    nsxtManagerId String
    NSX-T manager should be referenced.
    id String

    getNsxtTier0Router Result

    The following output properties are available:

    Id string
    IsAssigned bool
    Boolean value reflecting if Tier-0 router is already consumed by external network.
    Name string
    NsxtManagerId string
    Id string
    IsAssigned bool
    Boolean value reflecting if Tier-0 router is already consumed by external network.
    Name string
    NsxtManagerId string
    id String
    isAssigned Boolean
    Boolean value reflecting if Tier-0 router is already consumed by external network.
    name String
    nsxtManagerId String
    id string
    isAssigned boolean
    Boolean value reflecting if Tier-0 router is already consumed by external network.
    name string
    nsxtManagerId string
    id str
    is_assigned bool
    Boolean value reflecting if Tier-0 router is already consumed by external network.
    name str
    nsxt_manager_id str
    id String
    isAssigned Boolean
    Boolean value reflecting if Tier-0 router is already consumed by external network.
    name String
    nsxtManagerId String

    Package Details

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