Viewing docs for vcd 3.14.1
published on Monday, Apr 14, 2025 by vmware
published on Monday, Apr 14, 2025 by vmware
Viewing docs for vcd 3.14.1
published on Monday, Apr 14, 2025 by vmware
published on Monday, Apr 14, 2025 by vmware
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 dictionaryThe 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.
- Provider
Vdc stringId - The ID of VDC Group for lookup. Data source
vcd.ProviderVdccan be used to get ID. - Vdc string
- The name of VDC that owns the edge cluster. Optional if defined at provider level.
- Vdc
Group stringId - The ID of VDC Group for lookup. Data source
vcd.VdcGroupcan be used to get ID. - Vdc
Id string - The ID of VDC for lookup. Data source
vcd.OrgVdccan 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.
- Provider
Vdc stringId - The ID of VDC Group for lookup. Data source
vcd.ProviderVdccan be used to get ID. - Vdc string
- The name of VDC that owns the edge cluster. Optional if defined at provider level.
- Vdc
Group stringId - The ID of VDC Group for lookup. Data source
vcd.VdcGroupcan be used to get ID. - Vdc
Id string - The ID of VDC for lookup. Data source
vcd.OrgVdccan 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.
- provider
Vdc StringId - The ID of VDC Group for lookup. Data source
vcd.ProviderVdccan be used to get ID. - vdc String
- The name of VDC that owns the edge cluster. Optional if defined at provider level.
- vdc
Group StringId - The ID of VDC Group for lookup. Data source
vcd.VdcGroupcan be used to get ID. - vdc
Id String - The ID of VDC for lookup. Data source
vcd.OrgVdccan 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.
- provider
Vdc stringId - The ID of VDC Group for lookup. Data source
vcd.ProviderVdccan be used to get ID. - vdc string
- The name of VDC that owns the edge cluster. Optional if defined at provider level.
- vdc
Group stringId - The ID of VDC Group for lookup. Data source
vcd.VdcGroupcan be used to get ID. - vdc
Id string - The ID of VDC for lookup. Data source
vcd.OrgVdccan 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_ strid - The ID of VDC Group for lookup. Data source
vcd.ProviderVdccan be used to get ID. - vdc str
- The name of VDC that owns the edge cluster. Optional if defined at provider level.
- vdc_
group_ strid - The ID of VDC Group for lookup. Data source
vcd.VdcGroupcan be used to get ID. - vdc_
id str - The ID of VDC for lookup. Data source
vcd.OrgVdccan 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.
- provider
Vdc StringId - The ID of VDC Group for lookup. Data source
vcd.ProviderVdccan be used to get ID. - vdc String
- The name of VDC that owns the edge cluster. Optional if defined at provider level.
- vdc
Group StringId - The ID of VDC Group for lookup. Data source
vcd.VdcGroupcan be used to get ID. - vdc
Id String - The ID of VDC for lookup. Data source
vcd.OrgVdccan be used to get ID.
getNsxtEdgeCluster Result
The following output properties are available:
- Deployment
Type string - Deployment type of Edge Cluster.
- Description string
- Edge Cluster description in NSX-T manager.
- Id string
- Name string
- Node
Count double - Number of nodes in Edge Cluster.
- Node
Type string - Type of nodes in Edge Cluster.
- Org string
- Provider
Vdc stringId - Vdc string
- Vdc
Group stringId - Vdc
Id string
- Deployment
Type string - Deployment type of Edge Cluster.
- Description string
- Edge Cluster description in NSX-T manager.
- Id string
- Name string
- Node
Count float64 - Number of nodes in Edge Cluster.
- Node
Type string - Type of nodes in Edge Cluster.
- Org string
- Provider
Vdc stringId - Vdc string
- Vdc
Group stringId - Vdc
Id string
- deployment
Type String - Deployment type of Edge Cluster.
- description String
- Edge Cluster description in NSX-T manager.
- id String
- name String
- node
Count Double - Number of nodes in Edge Cluster.
- node
Type String - Type of nodes in Edge Cluster.
- org String
- provider
Vdc StringId - vdc String
- vdc
Group StringId - vdc
Id String
- deployment
Type string - Deployment type of Edge Cluster.
- description string
- Edge Cluster description in NSX-T manager.
- id string
- name string
- node
Count number - Number of nodes in Edge Cluster.
- node
Type string - Type of nodes in Edge Cluster.
- org string
- provider
Vdc stringId - vdc string
- vdc
Group stringId - vdc
Id 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_ strid - vdc str
- vdc_
group_ strid - vdc_
id str
- deployment
Type String - Deployment type of Edge Cluster.
- description String
- Edge Cluster description in NSX-T manager.
- id String
- name String
- node
Count Number - Number of nodes in Edge Cluster.
- node
Type String - Type of nodes in Edge Cluster.
- org String
- provider
Vdc StringId - vdc String
- vdc
Group StringId - vdc
Id String
Package Details
- Repository
- vcd vmware/terraform-provider-vcd
- License
- Notes
- This Pulumi package is based on the
vcdTerraform Provider.
Viewing docs for vcd 3.14.1
published on Monday, Apr 14, 2025 by vmware
published on Monday, Apr 14, 2025 by vmware
