Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. getNsxtEdgeCluster
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.getNsxtEdgeCluster

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Provides a data source for available NSX-T Edge Clusters.

    Supported in provider v3.1+

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

    Example Usage

    With VDC ID)

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

const existing = vcd.getOrgVdc({
    org: "my-org",
    name: "nsxt-vdc-1",
});
const first = existing.then(existing => vcd.getNsxtEdgeCluster({
    org: "my-org",
    vdcId: existing.id,
    name: "edge-cluster-one",
}));

    import pulumi
import pulumi_vcd as vcd

existing = vcd.get_org_vdc(org="my-org",
    name="nsxt-vdc-1")
first = vcd.get_nsxt_edge_cluster(org="my-org",
    vdc_id=existing.id,
    name="edge-cluster-one")

    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 {
		existing, err := vcd.LookupOrgVdc(ctx, &vcd.LookupOrgVdcArgs{
			Org:  pulumi.StringRef("my-org"),
			Name: "nsxt-vdc-1",
		}, nil)
		if err != nil {
			return err
		}
		_, err = vcd.GetNsxtEdgeCluster(ctx, &vcd.GetNsxtEdgeClusterArgs{
			Org:   pulumi.StringRef("my-org"),
			VdcId: pulumi.StringRef(existing.Id),
			Name:  "edge-cluster-one",
		}, 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 existing = Vcd.GetOrgVdc.Invoke(new()
    {
        Org = "my-org",
        Name = "nsxt-vdc-1",
    });

    var first = Vcd.GetNsxtEdgeCluster.Invoke(new()
    {
        Org = "my-org",
        VdcId = existing.Apply(getOrgVdcResult => getOrgVdcResult.Id),
        Name = "edge-cluster-one",
    });

});

    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.GetOrgVdcArgs;
import com.pulumi.vcd.inputs.GetNsxtEdgeClusterArgs;
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 existing = VcdFunctions.getOrgVdc(GetOrgVdcArgs.builder()
            .org("my-org")
            .name("nsxt-vdc-1")
            .build());

        final var first = VcdFunctions.getNsxtEdgeCluster(GetNsxtEdgeClusterArgs.builder()
            .org("my-org")
            .vdcId(existing.applyValue(getOrgVdcResult -> getOrgVdcResult.id()))
            .name("edge-cluster-one")
            .build());

    }
}

    variables:
  existing:
    fn::invoke:
      function: vcd:getOrgVdc
      arguments:
        org: my-org
        name: nsxt-vdc-1
  first:
    fn::invoke:
      function: vcd:getNsxtEdgeCluster
      arguments:
        org: my-org
        vdcId: ${existing.id}
        name: edge-cluster-one

    With VDC Group ID)

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

const existing = vcd.getVdcGroup({
    org: "my-org",
    name: "nsxt-vdc-group-1",
});
const first = existing.then(existing => vcd.getNsxtEdgeCluster({
    org: "my-org",
    vdcGroupId: existing.id,
    name: "edge-cluster-one",
}));

    import pulumi
import pulumi_vcd as vcd

existing = vcd.get_vdc_group(org="my-org",
    name="nsxt-vdc-group-1")
first = vcd.get_nsxt_edge_cluster(org="my-org",
    vdc_group_id=existing.id,
    name="edge-cluster-one")

    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 {
		existing, err := vcd.LookupVdcGroup(ctx, &vcd.LookupVdcGroupArgs{
			Org:  pulumi.StringRef("my-org"),
			Name: pulumi.StringRef("nsxt-vdc-group-1"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vcd.GetNsxtEdgeCluster(ctx, &vcd.GetNsxtEdgeClusterArgs{
			Org:        pulumi.StringRef("my-org"),
			VdcGroupId: pulumi.StringRef(existing.Id),
			Name:       "edge-cluster-one",
		}, 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 existing = Vcd.GetVdcGroup.Invoke(new()
    {
        Org = "my-org",
        Name = "nsxt-vdc-group-1",
    });

    var first = Vcd.GetNsxtEdgeCluster.Invoke(new()
    {
        Org = "my-org",
        VdcGroupId = existing.Apply(getVdcGroupResult => getVdcGroupResult.Id),
        Name = "edge-cluster-one",
    });

});

    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.GetVdcGroupArgs;
import com.pulumi.vcd.inputs.GetNsxtEdgeClusterArgs;
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 existing = VcdFunctions.getVdcGroup(GetVdcGroupArgs.builder()
            .org("my-org")
            .name("nsxt-vdc-group-1")
            .build());

        final var first = VcdFunctions.getNsxtEdgeCluster(GetNsxtEdgeClusterArgs.builder()
            .org("my-org")
            .vdcGroupId(existing.applyValue(getVdcGroupResult -> getVdcGroupResult.id()))
            .name("edge-cluster-one")
            .build());

    }
}

    variables:
  existing:
    fn::invoke:
      function: vcd:getVdcGroup
      arguments:
        org: my-org
        name: nsxt-vdc-group-1
  first:
    fn::invoke:
      function: vcd:getNsxtEdgeCluster
      arguments:
        org: my-org
        vdcGroupId: ${existing.id}
        name: edge-cluster-one

    With Provider VDC ID)

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

const nsxt_pvdc = vcd.getProviderVdc({
    name: "nsxt-provider-vdc",
});
const first = nsxt_pvdc.then(nsxt_pvdc => vcd.getNsxtEdgeCluster({
    org: "my-org",
    providerVdcId: nsxt_pvdc.id,
    name: "edge-cluster-one",
}));

    import pulumi
import pulumi_vcd as vcd

nsxt_pvdc = vcd.get_provider_vdc(name="nsxt-provider-vdc")
first = vcd.get_nsxt_edge_cluster(org="my-org",
    provider_vdc_id=nsxt_pvdc.id,
    name="edge-cluster-one")

    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 {
		nsxt_pvdc, err := vcd.LookupProviderVdc(ctx, &vcd.LookupProviderVdcArgs{
			Name: "nsxt-provider-vdc",
		}, nil)
		if err != nil {
			return err
		}
		_, err = vcd.GetNsxtEdgeCluster(ctx, &vcd.GetNsxtEdgeClusterArgs{
			Org:           pulumi.StringRef("my-org"),
			ProviderVdcId: pulumi.StringRef(nsxt_pvdc.Id),
			Name:          "edge-cluster-one",
		}, 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 nsxt_pvdc = Vcd.GetProviderVdc.Invoke(new()
    {
        Name = "nsxt-provider-vdc",
    });

    var first = Vcd.GetNsxtEdgeCluster.Invoke(new()
    {
        Org = "my-org",
        ProviderVdcId = nsxt_pvdc.Apply(getProviderVdcResult => getProviderVdcResult.Id),
        Name = "edge-cluster-one",
    });

});

    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.GetProviderVdcArgs;
import com.pulumi.vcd.inputs.GetNsxtEdgeClusterArgs;
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 nsxt-pvdc = VcdFunctions.getProviderVdc(GetProviderVdcArgs.builder()
            .name("nsxt-provider-vdc")
            .build());

        final var first = VcdFunctions.getNsxtEdgeCluster(GetNsxtEdgeClusterArgs.builder()
            .org("my-org")
            .providerVdcId(nsxt_pvdc.id())
            .name("edge-cluster-one")
            .build());

    }
}

    variables:
  nsxt-pvdc:
    fn::invoke:
      function: vcd:getProviderVdc
      arguments:
        name: nsxt-provider-vdc
  first:
    fn::invoke:
      function: vcd:getNsxtEdgeCluster
      arguments:
        org: my-org
        providerVdcId: ${["nsxt-pvdc"].id}
        name: edge-cluster-one

    Using getNsxtEdgeCluster

    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 getNsxtEdgeCluster(args: GetNsxtEdgeClusterArgs, opts?: InvokeOptions): Promise<GetNsxtEdgeClusterResult>
function getNsxtEdgeClusterOutput(args: GetNsxtEdgeClusterOutputArgs, opts?: InvokeOptions): Output<GetNsxtEdgeClusterResult>
    def get_nsxt_edge_cluster(id: Optional[str] = None,
                          name: Optional[str] = None,
                          org: Optional[str] = None,
                          provider_vdc_id: Optional[str] = None,
                          vdc: Optional[str] = None,
                          vdc_group_id: Optional[str] = None,
                          vdc_id: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetNsxtEdgeClusterResult
def get_nsxt_edge_cluster_output(id: Optional[pulumi.Input[str]] = None,
                          name: Optional[pulumi.Input[str]] = None,
                          org: Optional[pulumi.Input[str]] = None,
                          provider_vdc_id: Optional[pulumi.Input[str]] = None,
                          vdc: Optional[pulumi.Input[str]] = None,
                          vdc_group_id: Optional[pulumi.Input[str]] = None,
                          vdc_id: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetNsxtEdgeClusterResult]
    func GetNsxtEdgeCluster(ctx *Context, args *GetNsxtEdgeClusterArgs, opts ...InvokeOption) (*GetNsxtEdgeClusterResult, error)
func GetNsxtEdgeClusterOutput(ctx *Context, args *GetNsxtEdgeClusterOutputArgs, opts ...InvokeOption) GetNsxtEdgeClusterResultOutput

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

    public static class GetNsxtEdgeCluster 
{
    public static Task<GetNsxtEdgeClusterResult> InvokeAsync(GetNsxtEdgeClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetNsxtEdgeClusterResult> Invoke(GetNsxtEdgeClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNsxtEdgeClusterResult> getNsxtEdgeCluster(GetNsxtEdgeClusterArgs args, InvokeOptions options)
public static Output<GetNsxtEdgeClusterResult> getNsxtEdgeCluster(GetNsxtEdgeClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: vcd:index/getNsxtEdgeCluster:getNsxtEdgeCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    NSX-T Edge Cluster name. Note. NSX-T does allow to have duplicate names therefore to be able to correctly use this data source there should not be multiple NSX-T Edge Clusters with the same name defined.
    Id string
    Org string
    The name of organization to which edge cluster belongs. Optional if defined at provider level.
    ProviderVdcId string
    The ID of VDC Group for lookup. Data source vcd.ProviderVdc can be used to get ID.
    Vdc string
    The name of VDC that owns the edge cluster. Optional if defined at provider level.

    Deprecated: Deprecated

    VdcGroupId string
    The ID of VDC Group for lookup. Data source vcd.VdcGroup can be used to get ID.
    VdcId string
    The ID of VDC for lookup. Data source vcd.OrgVdc can be used to get ID.
    Name string
    NSX-T Edge Cluster name. Note. NSX-T does allow to have duplicate names therefore to be able to correctly use this data source there should not be multiple NSX-T Edge Clusters with the same name defined.
    Id string
    Org string
    The name of organization to which edge cluster belongs. Optional if defined at provider level.
    ProviderVdcId string
    The ID of VDC Group for lookup. Data source vcd.ProviderVdc can be used to get ID.
    Vdc string
    The name of VDC that owns the edge cluster. Optional if defined at provider level.

    Deprecated: Deprecated

    VdcGroupId string
    The ID of VDC Group for lookup. Data source vcd.VdcGroup can be used to get ID.
    VdcId string
    The ID of VDC for lookup. Data source vcd.OrgVdc can be used to get ID.
    name String
    NSX-T Edge Cluster name. Note. NSX-T does allow to have duplicate names therefore to be able to correctly use this data source there should not be multiple NSX-T Edge Clusters with the same name defined.
    id String
    org String
    The name of organization to which edge cluster belongs. Optional if defined at provider level.
    providerVdcId String
    The ID of VDC Group for lookup. Data source vcd.ProviderVdc can be used to get ID.
    vdc String
    The name of VDC that owns the edge cluster. Optional if defined at provider level.

    Deprecated: Deprecated

    vdcGroupId String
    The ID of VDC Group for lookup. Data source vcd.VdcGroup can be used to get ID.
    vdcId String
    The ID of VDC for lookup. Data source vcd.OrgVdc can be used to get ID.
    name string
    NSX-T Edge Cluster name. Note. NSX-T does allow to have duplicate names therefore to be able to correctly use this data source there should not be multiple NSX-T Edge Clusters with the same name defined.
    id string
    org string
    The name of organization to which edge cluster belongs. Optional if defined at provider level.
    providerVdcId string
    The ID of VDC Group for lookup. Data source vcd.ProviderVdc can be used to get ID.
    vdc string
    The name of VDC that owns the edge cluster. Optional if defined at provider level.

    Deprecated: Deprecated

    vdcGroupId string
    The ID of VDC Group for lookup. Data source vcd.VdcGroup can be used to get ID.
    vdcId string
    The ID of VDC for lookup. Data source vcd.OrgVdc can be used to get ID.
    name str
    NSX-T Edge Cluster name. Note. NSX-T does allow to have duplicate names therefore to be able to correctly use this data source there should not be multiple NSX-T Edge Clusters with the same name defined.
    id str
    org str
    The name of organization to which edge cluster belongs. Optional if defined at provider level.
    provider_vdc_id str
    The ID of VDC Group for lookup. Data source vcd.ProviderVdc can be used to get ID.
    vdc str
    The name of VDC that owns the edge cluster. Optional if defined at provider level.

    Deprecated: Deprecated

    vdc_group_id str
    The ID of VDC Group for lookup. Data source vcd.VdcGroup can be used to get ID.
    vdc_id str
    The ID of VDC for lookup. Data source vcd.OrgVdc can be used to get ID.
    name String
    NSX-T Edge Cluster name. Note. NSX-T does allow to have duplicate names therefore to be able to correctly use this data source there should not be multiple NSX-T Edge Clusters with the same name defined.
    id String
    org String
    The name of organization to which edge cluster belongs. Optional if defined at provider level.
    providerVdcId String
    The ID of VDC Group for lookup. Data source vcd.ProviderVdc can be used to get ID.
    vdc String
    The name of VDC that owns the edge cluster. Optional if defined at provider level.

    Deprecated: Deprecated

    vdcGroupId String
    The ID of VDC Group for lookup. Data source vcd.VdcGroup can be used to get ID.
    vdcId String
    The ID of VDC for lookup. Data source vcd.OrgVdc can be used to get ID.

    getNsxtEdgeCluster Result

    The following output properties are available:

    DeploymentType string
    Deployment type of Edge Cluster.
    Description string
    Edge Cluster description in NSX-T manager.
    Id string
    Name string
    NodeCount double
    Number of nodes in Edge Cluster.
    NodeType string
    Type of nodes in Edge Cluster.
    Org string
    ProviderVdcId string
    Vdc string

    Deprecated: Deprecated

    VdcGroupId string
    VdcId string
    DeploymentType string
    Deployment type of Edge Cluster.
    Description string
    Edge Cluster description in NSX-T manager.
    Id string
    Name string
    NodeCount float64
    Number of nodes in Edge Cluster.
    NodeType string
    Type of nodes in Edge Cluster.
    Org string
    ProviderVdcId string
    Vdc string

    Deprecated: Deprecated

    VdcGroupId string
    VdcId string
    deploymentType String
    Deployment type of Edge Cluster.
    description String
    Edge Cluster description in NSX-T manager.
    id String
    name String
    nodeCount Double
    Number of nodes in Edge Cluster.
    nodeType String
    Type of nodes in Edge Cluster.
    org String
    providerVdcId String
    vdc String

    Deprecated: Deprecated

    vdcGroupId String
    vdcId String
    deploymentType string
    Deployment type of Edge Cluster.
    description string
    Edge Cluster description in NSX-T manager.
    id string
    name string
    nodeCount number
    Number of nodes in Edge Cluster.
    nodeType string
    Type of nodes in Edge Cluster.
    org string
    providerVdcId string
    vdc string

    Deprecated: Deprecated

    vdcGroupId string
    vdcId string
    deployment_type str
    Deployment type of Edge Cluster.
    description str
    Edge Cluster description in NSX-T manager.
    id str
    name str
    node_count float
    Number of nodes in Edge Cluster.
    node_type str
    Type of nodes in Edge Cluster.
    org str
    provider_vdc_id str
    vdc str

    Deprecated: Deprecated

    vdc_group_id str
    vdc_id str
    deploymentType String
    Deployment type of Edge Cluster.
    description String
    Edge Cluster description in NSX-T manager.
    id String
    name String
    nodeCount Number
    Number of nodes in Edge Cluster.
    nodeType String
    Type of nodes in Edge Cluster.
    org String
    providerVdcId String
    vdc String

    Deprecated: Deprecated

    vdcGroupId String
    vdcId 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
    vmware/terraform-provider-vcd