Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getLogicalTier0Router
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.getLogicalTier0Router

Explore with Pulumi AI

nsxt logo
nsxt 3.8.0 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-nsxt

    This data source provides information about Tier 0 Logical Routers configured in NSX. A Tier 0 router is used to connect NSX networking with traditional physical networking. Tier 0 routers are placed on an Edge cluster and will exist on one or more Edge node depending on deployment settings (i.e. active/active or active/passive). A Tier 0 router forwards layer 3 IP packets and typically peers with a traditional physical router using BGP or can use static routing.

    Example Usage

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

const tier0Router = nsxt.getLogicalTier0Router({
    displayName: "PLR1",
});

    import pulumi
import pulumi_nsxt as nsxt

tier0_router = nsxt.get_logical_tier0_router(display_name="PLR1")

    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.LookupLogicalTier0Router(ctx, &nsxt.LookupLogicalTier0RouterArgs{
			DisplayName: pulumi.StringRef("PLR1"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Nsxt = Pulumi.Nsxt;

return await Deployment.RunAsync(() => 
{
    var tier0Router = Nsxt.GetLogicalTier0Router.Invoke(new()
    {
        DisplayName = "PLR1",
    });

});

    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.GetLogicalTier0RouterArgs;
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 tier0Router = NsxtFunctions.getLogicalTier0Router(GetLogicalTier0RouterArgs.builder()
            .displayName("PLR1")
            .build());

    }
}

    variables:
  tier0Router:
    fn::invoke:
      function: nsxt:getLogicalTier0Router
      arguments:
        displayName: PLR1

    Using getLogicalTier0Router

    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 getLogicalTier0Router(args: GetLogicalTier0RouterArgs, opts?: InvokeOptions): Promise<GetLogicalTier0RouterResult>
function getLogicalTier0RouterOutput(args: GetLogicalTier0RouterOutputArgs, opts?: InvokeOptions): Output<GetLogicalTier0RouterResult>
    def get_logical_tier0_router(description: Optional[str] = None,
                             display_name: Optional[str] = None,
                             edge_cluster_id: Optional[str] = None,
                             high_availability_mode: Optional[str] = None,
                             id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetLogicalTier0RouterResult
def get_logical_tier0_router_output(description: Optional[pulumi.Input[str]] = None,
                             display_name: Optional[pulumi.Input[str]] = None,
                             edge_cluster_id: Optional[pulumi.Input[str]] = None,
                             high_availability_mode: Optional[pulumi.Input[str]] = None,
                             id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetLogicalTier0RouterResult]
    func LookupLogicalTier0Router(ctx *Context, args *LookupLogicalTier0RouterArgs, opts ...InvokeOption) (*LookupLogicalTier0RouterResult, error)
func LookupLogicalTier0RouterOutput(ctx *Context, args *LookupLogicalTier0RouterOutputArgs, opts ...InvokeOption) LookupLogicalTier0RouterResultOutput

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

    public static class GetLogicalTier0Router 
{
    public static Task<GetLogicalTier0RouterResult> InvokeAsync(GetLogicalTier0RouterArgs args, InvokeOptions? opts = null)
    public static Output<GetLogicalTier0RouterResult> Invoke(GetLogicalTier0RouterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLogicalTier0RouterResult> getLogicalTier0Router(GetLogicalTier0RouterArgs args, InvokeOptions options)
public static Output<GetLogicalTier0RouterResult> getLogicalTier0Router(GetLogicalTier0RouterArgs args, InvokeOptions options)

    fn::invoke:
  function: nsxt:index/getLogicalTier0Router:getLogicalTier0Router
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Description string
    The description of the Logical Router.
    DisplayName string
    The Display Name prefix of Logical Router to retrieve.
    EdgeClusterId string
    The id of the Edge Cluster where this Logical Router is placed.
    HighAvailabilityMode string
    The high availability mode of this Logical Router.
    Id string
    The ID of Logical Router to retrieve.
    Description string
    The description of the Logical Router.
    DisplayName string
    The Display Name prefix of Logical Router to retrieve.
    EdgeClusterId string
    The id of the Edge Cluster where this Logical Router is placed.
    HighAvailabilityMode string
    The high availability mode of this Logical Router.
    Id string
    The ID of Logical Router to retrieve.
    description String
    The description of the Logical Router.
    displayName String
    The Display Name prefix of Logical Router to retrieve.
    edgeClusterId String
    The id of the Edge Cluster where this Logical Router is placed.
    highAvailabilityMode String
    The high availability mode of this Logical Router.
    id String
    The ID of Logical Router to retrieve.
    description string
    The description of the Logical Router.
    displayName string
    The Display Name prefix of Logical Router to retrieve.
    edgeClusterId string
    The id of the Edge Cluster where this Logical Router is placed.
    highAvailabilityMode string
    The high availability mode of this Logical Router.
    id string
    The ID of Logical Router to retrieve.
    description str
    The description of the Logical Router.
    display_name str
    The Display Name prefix of Logical Router to retrieve.
    edge_cluster_id str
    The id of the Edge Cluster where this Logical Router is placed.
    high_availability_mode str
    The high availability mode of this Logical Router.
    id str
    The ID of Logical Router to retrieve.
    description String
    The description of the Logical Router.
    displayName String
    The Display Name prefix of Logical Router to retrieve.
    edgeClusterId String
    The id of the Edge Cluster where this Logical Router is placed.
    highAvailabilityMode String
    The high availability mode of this Logical Router.
    id String
    The ID of Logical Router to retrieve.

    getLogicalTier0Router Result

    The following output properties are available:

    Description string
    The description of the Logical Router.
    DisplayName string
    EdgeClusterId string
    The id of the Edge Cluster where this Logical Router is placed.
    HighAvailabilityMode string
    The high availability mode of this Logical Router.
    Id string
    Description string
    The description of the Logical Router.
    DisplayName string
    EdgeClusterId string
    The id of the Edge Cluster where this Logical Router is placed.
    HighAvailabilityMode string
    The high availability mode of this Logical Router.
    Id string
    description String
    The description of the Logical Router.
    displayName String
    edgeClusterId String
    The id of the Edge Cluster where this Logical Router is placed.
    highAvailabilityMode String
    The high availability mode of this Logical Router.
    id String
    description string
    The description of the Logical Router.
    displayName string
    edgeClusterId string
    The id of the Edge Cluster where this Logical Router is placed.
    highAvailabilityMode string
    The high availability mode of this Logical Router.
    id string
    description str
    The description of the Logical Router.
    display_name str
    edge_cluster_id str
    The id of the Edge Cluster where this Logical Router is placed.
    high_availability_mode str
    The high availability mode of this Logical Router.
    id str
    description String
    The description of the Logical Router.
    displayName String
    edgeClusterId String
    The id of the Edge Cluster where this Logical Router is placed.
    highAvailabilityMode String
    The high availability mode of this Logical Router.
    id String

    Package Details

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