nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
nsxt.getLogicalTier1Router
Explore with Pulumi AI
This data source provides information about Tier1 Logical Routers configured on NSX.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as nsxt from "@pulumi/nsxt";
const tier1Router = nsxt.getLogicalTier1Router({
displayName: "router1",
});
import pulumi
import pulumi_nsxt as nsxt
tier1_router = nsxt.get_logical_tier1_router(display_name="router1")
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.LookupLogicalTier1Router(ctx, &nsxt.LookupLogicalTier1RouterArgs{
DisplayName: pulumi.StringRef("router1"),
}, 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 tier1Router = Nsxt.GetLogicalTier1Router.Invoke(new()
{
DisplayName = "router1",
});
});
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.GetLogicalTier1RouterArgs;
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 tier1Router = NsxtFunctions.getLogicalTier1Router(GetLogicalTier1RouterArgs.builder()
.displayName("router1")
.build());
}
}
variables:
tier1Router:
fn::invoke:
function: nsxt:getLogicalTier1Router
arguments:
displayName: router1
Using getLogicalTier1Router
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 getLogicalTier1Router(args: GetLogicalTier1RouterArgs, opts?: InvokeOptions): Promise<GetLogicalTier1RouterResult>
function getLogicalTier1RouterOutput(args: GetLogicalTier1RouterOutputArgs, opts?: InvokeOptions): Output<GetLogicalTier1RouterResult>
def get_logical_tier1_router(description: Optional[str] = None,
display_name: Optional[str] = None,
edge_cluster_id: Optional[str] = None,
id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetLogicalTier1RouterResult
def get_logical_tier1_router_output(description: Optional[pulumi.Input[str]] = None,
display_name: Optional[pulumi.Input[str]] = None,
edge_cluster_id: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetLogicalTier1RouterResult]
func LookupLogicalTier1Router(ctx *Context, args *LookupLogicalTier1RouterArgs, opts ...InvokeOption) (*LookupLogicalTier1RouterResult, error)
func LookupLogicalTier1RouterOutput(ctx *Context, args *LookupLogicalTier1RouterOutputArgs, opts ...InvokeOption) LookupLogicalTier1RouterResultOutput
> Note: This function is named LookupLogicalTier1Router
in the Go SDK.
public static class GetLogicalTier1Router
{
public static Task<GetLogicalTier1RouterResult> InvokeAsync(GetLogicalTier1RouterArgs args, InvokeOptions? opts = null)
public static Output<GetLogicalTier1RouterResult> Invoke(GetLogicalTier1RouterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLogicalTier1RouterResult> getLogicalTier1Router(GetLogicalTier1RouterArgs args, InvokeOptions options)
public static Output<GetLogicalTier1RouterResult> getLogicalTier1Router(GetLogicalTier1RouterArgs args, InvokeOptions options)
fn::invoke:
function: nsxt:index/getLogicalTier1Router:getLogicalTier1Router
arguments:
# arguments dictionary
The following arguments are supported:
- Description string
- The description of the Logical Router.
- Display
Name string - The Display Name prefix of Logical Router to retrieve.
- Edge
Cluster stringId - The id of the Edge cluster where this Logical Router is placed.
- Id string
- The ID of Logical Router to retrieve.
- Description string
- The description of the Logical Router.
- Display
Name string - The Display Name prefix of Logical Router to retrieve.
- Edge
Cluster stringId - The id of the Edge cluster where this Logical Router is placed.
- Id string
- The ID of Logical Router to retrieve.
- description String
- The description of the Logical Router.
- display
Name String - The Display Name prefix of Logical Router to retrieve.
- edge
Cluster StringId - The id of the Edge cluster where this Logical Router is placed.
- id String
- The ID of Logical Router to retrieve.
- description string
- The description of the Logical Router.
- display
Name string - The Display Name prefix of Logical Router to retrieve.
- edge
Cluster stringId - The id of the Edge cluster where this Logical Router is placed.
- 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_ strid - The id of the Edge cluster where this Logical Router is placed.
- id str
- The ID of Logical Router to retrieve.
- description String
- The description of the Logical Router.
- display
Name String - The Display Name prefix of Logical Router to retrieve.
- edge
Cluster StringId - The id of the Edge cluster where this Logical Router is placed.
- id String
- The ID of Logical Router to retrieve.
getLogicalTier1Router Result
The following output properties are available:
- Description string
- The description of the Logical Router.
- Display
Name string - Edge
Cluster stringId - The id of the Edge cluster where this Logical Router is placed.
- Id string
- Description string
- The description of the Logical Router.
- Display
Name string - Edge
Cluster stringId - The id of the Edge cluster where this Logical Router is placed.
- Id string
- description String
- The description of the Logical Router.
- display
Name String - edge
Cluster StringId - The id of the Edge cluster where this Logical Router is placed.
- id String
- description string
- The description of the Logical Router.
- display
Name string - edge
Cluster stringId - The id of the Edge cluster where this Logical Router is placed.
- id string
- description str
- The description of the Logical Router.
- display_
name str - edge_
cluster_ strid - The id of the Edge cluster where this Logical Router is placed.
- id str
- description String
- The description of the Logical Router.
- display
Name String - edge
Cluster StringId - The id of the Edge cluster where this Logical Router is placed.
- id String
Package Details
- Repository
- nsxt vmware/terraform-provider-nsxt
- License
- Notes
- This Pulumi package is based on the
nsxt
Terraform Provider.