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

nsxt.EdgeCluster

Explore with Pulumi AI

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

Create EdgeCluster Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new EdgeCluster(name: string, args: EdgeClusterArgs, opts?: CustomResourceOptions);
@overload
def EdgeCluster(resource_name: str,
                args: EdgeClusterArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def EdgeCluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                display_name: Optional[str] = None,
                description: Optional[str] = None,
                edge_cluster_id: Optional[str] = None,
                edge_ha_profile_id: Optional[str] = None,
                failure_domain_allocation: Optional[str] = None,
                members: Optional[Sequence[EdgeClusterMemberArgs]] = None,
                tags: Optional[Sequence[EdgeClusterTagArgs]] = None)
func NewEdgeCluster(ctx *Context, name string, args EdgeClusterArgs, opts ...ResourceOption) (*EdgeCluster, error)
public EdgeCluster(string name, EdgeClusterArgs args, CustomResourceOptions? opts = null)
public EdgeCluster(String name, EdgeClusterArgs args)
public EdgeCluster(String name, EdgeClusterArgs args, CustomResourceOptions options)

type: nsxt:EdgeCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. EdgeClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. EdgeClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. EdgeClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. EdgeClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. EdgeClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var edgeClusterResource = new Nsxt.EdgeCluster("edgeClusterResource", new()
{
    DisplayName = "string",
    Description = "string",
    EdgeClusterId = "string",
    EdgeHaProfileId = "string",
    FailureDomainAllocation = "string",
    Members = new[]
    {
        new Nsxt.Inputs.EdgeClusterMemberArgs
        {
            TransportNodeId = "string",
            Description = "string",
            DisplayName = "string",
            MemberIndex = 0,
        },
    },
    Tags = new[]
    {
        new Nsxt.Inputs.EdgeClusterTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});
Copy
example, err := nsxt.NewEdgeCluster(ctx, "edgeClusterResource", &nsxt.EdgeClusterArgs{
DisplayName: pulumi.String("string"),
Description: pulumi.String("string"),
EdgeClusterId: pulumi.String("string"),
EdgeHaProfileId: pulumi.String("string"),
FailureDomainAllocation: pulumi.String("string"),
Members: .EdgeClusterMemberArray{
&.EdgeClusterMemberArgs{
TransportNodeId: pulumi.String("string"),
Description: pulumi.String("string"),
DisplayName: pulumi.String("string"),
MemberIndex: pulumi.Float64(0),
},
},
Tags: .EdgeClusterTagArray{
&.EdgeClusterTagArgs{
Scope: pulumi.String("string"),
Tag: pulumi.String("string"),
},
},
})
Copy
var edgeClusterResource = new EdgeCluster("edgeClusterResource", EdgeClusterArgs.builder()
    .displayName("string")
    .description("string")
    .edgeClusterId("string")
    .edgeHaProfileId("string")
    .failureDomainAllocation("string")
    .members(EdgeClusterMemberArgs.builder()
        .transportNodeId("string")
        .description("string")
        .displayName("string")
        .memberIndex(0)
        .build())
    .tags(EdgeClusterTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());
Copy
edge_cluster_resource = nsxt.EdgeCluster("edgeClusterResource",
    display_name="string",
    description="string",
    edge_cluster_id="string",
    edge_ha_profile_id="string",
    failure_domain_allocation="string",
    members=[{
        "transport_node_id": "string",
        "description": "string",
        "display_name": "string",
        "member_index": 0,
    }],
    tags=[{
        "scope": "string",
        "tag": "string",
    }])
Copy
const edgeClusterResource = new nsxt.EdgeCluster("edgeClusterResource", {
    displayName: "string",
    description: "string",
    edgeClusterId: "string",
    edgeHaProfileId: "string",
    failureDomainAllocation: "string",
    members: [{
        transportNodeId: "string",
        description: "string",
        displayName: "string",
        memberIndex: 0,
    }],
    tags: [{
        scope: "string",
        tag: "string",
    }],
});
Copy
type: nsxt:EdgeCluster
properties:
    description: string
    displayName: string
    edgeClusterId: string
    edgeHaProfileId: string
    failureDomainAllocation: string
    members:
        - description: string
          displayName: string
          memberIndex: 0
          transportNodeId: string
    tags:
        - scope: string
          tag: string
Copy

EdgeCluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The EdgeCluster resource accepts the following input properties:

DisplayName This property is required. string
Display name of the resource.
Description string
Description of the resource.
EdgeClusterId string
ID of the resource.
EdgeHaProfileId string
Edge high availability cluster profile ID.
FailureDomainAllocation string
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
Members List<EdgeClusterMember>
Edge cluster members
Tags List<EdgeClusterTag>
A list of scope + tag pairs to associate with this resource.
DisplayName This property is required. string
Display name of the resource.
Description string
Description of the resource.
EdgeClusterId string
ID of the resource.
EdgeHaProfileId string
Edge high availability cluster profile ID.
FailureDomainAllocation string
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
Members []EdgeClusterMemberArgs
Edge cluster members
Tags []EdgeClusterTagArgs
A list of scope + tag pairs to associate with this resource.
displayName This property is required. String
Display name of the resource.
description String
Description of the resource.
edgeClusterId String
ID of the resource.
edgeHaProfileId String
Edge high availability cluster profile ID.
failureDomainAllocation String
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
members List<EdgeClusterMember>
Edge cluster members
tags List<EdgeClusterTag>
A list of scope + tag pairs to associate with this resource.
displayName This property is required. string
Display name of the resource.
description string
Description of the resource.
edgeClusterId string
ID of the resource.
edgeHaProfileId string
Edge high availability cluster profile ID.
failureDomainAllocation string
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
members EdgeClusterMember[]
Edge cluster members
tags EdgeClusterTag[]
A list of scope + tag pairs to associate with this resource.
display_name This property is required. str
Display name of the resource.
description str
Description of the resource.
edge_cluster_id str
ID of the resource.
edge_ha_profile_id str
Edge high availability cluster profile ID.
failure_domain_allocation str
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
members Sequence[EdgeClusterMemberArgs]
Edge cluster members
tags Sequence[EdgeClusterTagArgs]
A list of scope + tag pairs to associate with this resource.
displayName This property is required. String
Display name of the resource.
description String
Description of the resource.
edgeClusterId String
ID of the resource.
edgeHaProfileId String
Edge high availability cluster profile ID.
failureDomainAllocation String
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
members List<Property Map>
Edge cluster members
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the EdgeCluster resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
MemberNodeType string
Node type of the cluster members.
NodeRtepIps List<EdgeClusterNodeRtepIp>
Remote tunnel endpoint ip address.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Id string
The provider-assigned unique ID for this managed resource.
MemberNodeType string
Node type of the cluster members.
NodeRtepIps []EdgeClusterNodeRtepIp
Remote tunnel endpoint ip address.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id String
The provider-assigned unique ID for this managed resource.
memberNodeType String
Node type of the cluster members.
nodeRtepIps List<EdgeClusterNodeRtepIp>
Remote tunnel endpoint ip address.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id string
The provider-assigned unique ID for this managed resource.
memberNodeType string
Node type of the cluster members.
nodeRtepIps EdgeClusterNodeRtepIp[]
Remote tunnel endpoint ip address.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id str
The provider-assigned unique ID for this managed resource.
member_node_type str
Node type of the cluster members.
node_rtep_ips Sequence[EdgeClusterNodeRtepIp]
Remote tunnel endpoint ip address.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
id String
The provider-assigned unique ID for this managed resource.
memberNodeType String
Node type of the cluster members.
nodeRtepIps List<Property Map>
Remote tunnel endpoint ip address.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

Look up Existing EdgeCluster Resource

Get an existing EdgeCluster resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: EdgeClusterState, opts?: CustomResourceOptions): EdgeCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        edge_cluster_id: Optional[str] = None,
        edge_ha_profile_id: Optional[str] = None,
        failure_domain_allocation: Optional[str] = None,
        member_node_type: Optional[str] = None,
        members: Optional[Sequence[EdgeClusterMemberArgs]] = None,
        node_rtep_ips: Optional[Sequence[EdgeClusterNodeRtepIpArgs]] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[EdgeClusterTagArgs]] = None) -> EdgeCluster
func GetEdgeCluster(ctx *Context, name string, id IDInput, state *EdgeClusterState, opts ...ResourceOption) (*EdgeCluster, error)
public static EdgeCluster Get(string name, Input<string> id, EdgeClusterState? state, CustomResourceOptions? opts = null)
public static EdgeCluster get(String name, Output<String> id, EdgeClusterState state, CustomResourceOptions options)
resources:  _:    type: nsxt:EdgeCluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description string
Description of the resource.
DisplayName string
Display name of the resource.
EdgeClusterId string
ID of the resource.
EdgeHaProfileId string
Edge high availability cluster profile ID.
FailureDomainAllocation string
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
MemberNodeType string
Node type of the cluster members.
Members List<EdgeClusterMember>
Edge cluster members
NodeRtepIps List<EdgeClusterNodeRtepIp>
Remote tunnel endpoint ip address.
Revision double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Tags List<EdgeClusterTag>
A list of scope + tag pairs to associate with this resource.
Description string
Description of the resource.
DisplayName string
Display name of the resource.
EdgeClusterId string
ID of the resource.
EdgeHaProfileId string
Edge high availability cluster profile ID.
FailureDomainAllocation string
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
MemberNodeType string
Node type of the cluster members.
Members []EdgeClusterMemberArgs
Edge cluster members
NodeRtepIps []EdgeClusterNodeRtepIpArgs
Remote tunnel endpoint ip address.
Revision float64
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
Tags []EdgeClusterTagArgs
A list of scope + tag pairs to associate with this resource.
description String
Description of the resource.
displayName String
Display name of the resource.
edgeClusterId String
ID of the resource.
edgeHaProfileId String
Edge high availability cluster profile ID.
failureDomainAllocation String
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
memberNodeType String
Node type of the cluster members.
members List<EdgeClusterMember>
Edge cluster members
nodeRtepIps List<EdgeClusterNodeRtepIp>
Remote tunnel endpoint ip address.
revision Double
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags List<EdgeClusterTag>
A list of scope + tag pairs to associate with this resource.
description string
Description of the resource.
displayName string
Display name of the resource.
edgeClusterId string
ID of the resource.
edgeHaProfileId string
Edge high availability cluster profile ID.
failureDomainAllocation string
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
memberNodeType string
Node type of the cluster members.
members EdgeClusterMember[]
Edge cluster members
nodeRtepIps EdgeClusterNodeRtepIp[]
Remote tunnel endpoint ip address.
revision number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags EdgeClusterTag[]
A list of scope + tag pairs to associate with this resource.
description str
Description of the resource.
display_name str
Display name of the resource.
edge_cluster_id str
ID of the resource.
edge_ha_profile_id str
Edge high availability cluster profile ID.
failure_domain_allocation str
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
member_node_type str
Node type of the cluster members.
members Sequence[EdgeClusterMemberArgs]
Edge cluster members
node_rtep_ips Sequence[EdgeClusterNodeRtepIpArgs]
Remote tunnel endpoint ip address.
revision float
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags Sequence[EdgeClusterTagArgs]
A list of scope + tag pairs to associate with this resource.
description String
Description of the resource.
displayName String
Display name of the resource.
edgeClusterId String
ID of the resource.
edgeHaProfileId String
Edge high availability cluster profile ID.
failureDomainAllocation String
Flag to enable failure domain based allocation. Enable placement algorithm to consider failure domain of edge transport nodes and place active and standby contexts in different failure domains. Supported values are enable and disable.
memberNodeType String
Node type of the cluster members.
members List<Property Map>
Edge cluster members
nodeRtepIps List<Property Map>
Remote tunnel endpoint ip address.
revision Number
Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
tags List<Property Map>
A list of scope + tag pairs to associate with this resource.

Supporting Types

EdgeClusterMember
, EdgeClusterMemberArgs

TransportNodeId This property is required. string
UUID of edge transport node.
Description string
Description of this resource.
DisplayName string
The display name of this resource. Defaults to ID if not set.
MemberIndex double
System generated index for cluster member.
TransportNodeId This property is required. string
UUID of edge transport node.
Description string
Description of this resource.
DisplayName string
The display name of this resource. Defaults to ID if not set.
MemberIndex float64
System generated index for cluster member.
transportNodeId This property is required. String
UUID of edge transport node.
description String
Description of this resource.
displayName String
The display name of this resource. Defaults to ID if not set.
memberIndex Double
System generated index for cluster member.
transportNodeId This property is required. string
UUID of edge transport node.
description string
Description of this resource.
displayName string
The display name of this resource. Defaults to ID if not set.
memberIndex number
System generated index for cluster member.
transport_node_id This property is required. str
UUID of edge transport node.
description str
Description of this resource.
display_name str
The display name of this resource. Defaults to ID if not set.
member_index float
System generated index for cluster member.
transportNodeId This property is required. String
UUID of edge transport node.
description String
Description of this resource.
displayName String
The display name of this resource. Defaults to ID if not set.
memberIndex Number
System generated index for cluster member.

EdgeClusterNodeRtepIp
, EdgeClusterNodeRtepIpArgs

MemberIndex This property is required. double
System generated index for cluster member
RtepIps This property is required. List<string>
Remote tunnel endpoint ip address
TransportNodeId This property is required. string
UUID of edge transport node
MemberIndex This property is required. float64
System generated index for cluster member
RtepIps This property is required. []string
Remote tunnel endpoint ip address
TransportNodeId This property is required. string
UUID of edge transport node
memberIndex This property is required. Double
System generated index for cluster member
rtepIps This property is required. List<String>
Remote tunnel endpoint ip address
transportNodeId This property is required. String
UUID of edge transport node
memberIndex This property is required. number
System generated index for cluster member
rtepIps This property is required. string[]
Remote tunnel endpoint ip address
transportNodeId This property is required. string
UUID of edge transport node
member_index This property is required. float
System generated index for cluster member
rtep_ips This property is required. Sequence[str]
Remote tunnel endpoint ip address
transport_node_id This property is required. str
UUID of edge transport node
memberIndex This property is required. Number
System generated index for cluster member
rtepIps This property is required. List<String>
Remote tunnel endpoint ip address
transportNodeId This property is required. String
UUID of edge transport node

EdgeClusterTag
, EdgeClusterTagArgs

Scope string
Tag string
A list of scope + tag pairs to associate with this resource.
Scope string
Tag string
A list of scope + tag pairs to associate with this resource.
scope String
tag String
A list of scope + tag pairs to associate with this resource.
scope string
tag string
A list of scope + tag pairs to associate with this resource.
scope str
tag str
A list of scope + tag pairs to associate with this resource.
scope String
tag String
A list of scope + tag pairs to associate with this resource.

Package Details

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