Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. getEdgeCluster
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.getEdgeCluster

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    This data source provides information about Edge clusters configured in NSX. An Edge cluster is a collection of Edge nodes which can be deployed as either VM form-factor or bare-metal form-factor machines for connectivity between overlay logical switches and non-NSX underlay networking for north/south layer 2 or layer 3 connectivity. Each T0 router will be placed on one ore more Edge nodes in an Edge cluster therefore this data source is needed for the creation of T0 logical routers.

    Example Usage

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

const edgeCluster1 = nsxt.getEdgeCluster({
    displayName: "edgecluster",
});

    import pulumi
import pulumi_nsxt as nsxt

edge_cluster1 = nsxt.get_edge_cluster(display_name="edgecluster")

    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.LookupEdgeCluster(ctx, &nsxt.LookupEdgeClusterArgs{
			DisplayName: pulumi.StringRef("edgecluster"),
		}, 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 edgeCluster1 = Nsxt.GetEdgeCluster.Invoke(new()
    {
        DisplayName = "edgecluster",
    });

});

    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.GetEdgeClusterArgs;
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 edgeCluster1 = NsxtFunctions.getEdgeCluster(GetEdgeClusterArgs.builder()
            .displayName("edgecluster")
            .build());

    }
}

    variables:
  edgeCluster1:
    fn::invoke:
      function: nsxt:getEdgeCluster
      arguments:
        displayName: edgecluster

    Using getEdgeCluster

    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 getEdgeCluster(args: GetEdgeClusterArgs, opts?: InvokeOptions): Promise<GetEdgeClusterResult>
function getEdgeClusterOutput(args: GetEdgeClusterOutputArgs, opts?: InvokeOptions): Output<GetEdgeClusterResult>
    def get_edge_cluster(deployment_type: Optional[str] = None,
                     description: Optional[str] = None,
                     display_name: Optional[str] = None,
                     id: Optional[str] = None,
                     member_node_type: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetEdgeClusterResult
def get_edge_cluster_output(deployment_type: Optional[pulumi.Input[str]] = None,
                     description: Optional[pulumi.Input[str]] = None,
                     display_name: Optional[pulumi.Input[str]] = None,
                     id: Optional[pulumi.Input[str]] = None,
                     member_node_type: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetEdgeClusterResult]
    func LookupEdgeCluster(ctx *Context, args *LookupEdgeClusterArgs, opts ...InvokeOption) (*LookupEdgeClusterResult, error)
func LookupEdgeClusterOutput(ctx *Context, args *LookupEdgeClusterOutputArgs, opts ...InvokeOption) LookupEdgeClusterResultOutput

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

    public static class GetEdgeCluster 
{
    public static Task<GetEdgeClusterResult> InvokeAsync(GetEdgeClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetEdgeClusterResult> Invoke(GetEdgeClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetEdgeClusterResult> getEdgeCluster(GetEdgeClusterArgs args, InvokeOptions options)
public static Output<GetEdgeClusterResult> getEdgeCluster(GetEdgeClusterArgs args, InvokeOptions options)

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

    The following arguments are supported:

    DeploymentType string
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    Description string
    The description of the edge cluster.
    DisplayName string
    The Display Name prefix of the Edge Cluster to retrieve.
    Id string
    The ID of Edge Cluster to retrieve.
    MemberNodeType string
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,
    DeploymentType string
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    Description string
    The description of the edge cluster.
    DisplayName string
    The Display Name prefix of the Edge Cluster to retrieve.
    Id string
    The ID of Edge Cluster to retrieve.
    MemberNodeType string
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,
    deploymentType String
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    description String
    The description of the edge cluster.
    displayName String
    The Display Name prefix of the Edge Cluster to retrieve.
    id String
    The ID of Edge Cluster to retrieve.
    memberNodeType String
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,
    deploymentType string
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    description string
    The description of the edge cluster.
    displayName string
    The Display Name prefix of the Edge Cluster to retrieve.
    id string
    The ID of Edge Cluster to retrieve.
    memberNodeType string
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,
    deployment_type str
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    description str
    The description of the edge cluster.
    display_name str
    The Display Name prefix of the Edge Cluster to retrieve.
    id str
    The ID of Edge Cluster to retrieve.
    member_node_type str
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,
    deploymentType String
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    description String
    The description of the edge cluster.
    displayName String
    The Display Name prefix of the Edge Cluster to retrieve.
    id String
    The ID of Edge Cluster to retrieve.
    memberNodeType String
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,

    getEdgeCluster Result

    The following output properties are available:

    DeploymentType string
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    Description string
    The description of the edge cluster.
    DisplayName string
    Id string
    MemberNodeType string
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,
    DeploymentType string
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    Description string
    The description of the edge cluster.
    DisplayName string
    Id string
    MemberNodeType string
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,
    deploymentType String
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    description String
    The description of the edge cluster.
    displayName String
    id String
    memberNodeType String
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,
    deploymentType string
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    description string
    The description of the edge cluster.
    displayName string
    id string
    memberNodeType string
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,
    deployment_type str
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    description str
    The description of the edge cluster.
    display_name str
    id str
    member_node_type str
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,
    deploymentType String
    This field could show deployment_type of members. It would return UNKNOWN if there is no members, and return VIRTUAL_MACHINE|PHYSICAL_MACHINE if all Edge members are VIRTUAL_MACHINE|PHYSICAL_MACHINE.
    description String
    The description of the edge cluster.
    displayName String
    id String
    memberNodeType String
    An Edge cluster is homogeneous collection of NSX transport nodes used for north/south connectivity between NSX logical networking and physical networking. Hence all transport nodes of the cluster must be of same type. This field shows the type of transport node,

    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.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt