Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Avi Provider
  3. API Docs
  4. Cluster
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

avi.Cluster

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

<!–

Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

–>

layout: “avi”

page_title: “Avi: avi.Cluster” sidebar_current: “docs-avi-resource-cluster” description: |- Creates and manages Avi Cluster.

avi.Cluster

The Cluster resource allows the creation and management of Avi Cluster

Example Usage

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

const foo = new avi.Cluster("foo", {tenantRef: "/api/tenant/?name=admin"});
Copy
import pulumi
import pulumi_avi as avi

foo = avi.Cluster("foo", tenant_ref="/api/tenant/?name=admin")
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.NewCluster(ctx, "foo", &avi.ClusterArgs{
			TenantRef: pulumi.String("/api/tenant/?name=admin"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var foo = new Avi.Cluster("foo", new()
    {
        TenantRef = "/api/tenant/?name=admin",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.Cluster;
import com.pulumi.avi.ClusterArgs;
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) {
        var foo = new Cluster("foo", ClusterArgs.builder()
            .tenantRef("/api/tenant/?name=admin")
            .build());

    }
}
Copy
resources:
  foo:
    type: avi:Cluster
    properties:
      tenantRef: /api/tenant/?name=admin
Copy

Create Cluster Resource

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

Constructor syntax

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

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            nodes: Optional[Sequence[ClusterNodeArgs]] = None,
            cluster_id: Optional[str] = None,
            cluster_states: Optional[Sequence[ClusterClusterStateArgs]] = None,
            name: Optional[str] = None,
            rejoin_nodes_automatically: Optional[str] = None,
            tenant_ref: Optional[str] = None,
            uuid: Optional[str] = None,
            virtual_ip6s: Optional[Sequence[ClusterVirtualIp6Args]] = None,
            virtual_ips: Optional[Sequence[ClusterVirtualIpArgs]] = None)
func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

type: avi:Cluster
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. ClusterArgs
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. ClusterArgs
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. ClusterArgs
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. ClusterArgs
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. ClusterArgs
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 clusterResource = new Avi.Cluster("clusterResource", new()
{
    Nodes = new[]
    {
        new Avi.Inputs.ClusterNodeArgs
        {
            Categories = new[]
            {
                "string",
            },
            Interfaces = new[]
            {
                new Avi.Inputs.ClusterNodeInterfaceArgs
                {
                    Gateway6s = new[]
                    {
                        new Avi.Inputs.ClusterNodeInterfaceGateway6Args
                        {
                            Addr = "string",
                            Type = "string",
                        },
                    },
                    Gateways = new[]
                    {
                        new Avi.Inputs.ClusterNodeInterfaceGatewayArgs
                        {
                            Addr = "string",
                            Type = "string",
                        },
                    },
                    IfName = "string",
                    Ip6s = new[]
                    {
                        new Avi.Inputs.ClusterNodeInterfaceIp6Args
                        {
                            IpAddrs = new[]
                            {
                                new Avi.Inputs.ClusterNodeInterfaceIp6IpAddrArgs
                                {
                                    Addr = "string",
                                    Type = "string",
                                },
                            },
                            Mask = "string",
                        },
                    },
                    Ips = new[]
                    {
                        new Avi.Inputs.ClusterNodeInterfaceIpArgs
                        {
                            IpAddrs = new[]
                            {
                                new Avi.Inputs.ClusterNodeInterfaceIpIpAddrArgs
                                {
                                    Addr = "string",
                                    Type = "string",
                                },
                            },
                            Mask = "string",
                        },
                    },
                    Labels = new[]
                    {
                        "string",
                    },
                    MacAddress = "string",
                    Mode = "string",
                    Mode6 = "string",
                    PublicIpOrNames = new[]
                    {
                        new Avi.Inputs.ClusterNodeInterfacePublicIpOrNameArgs
                        {
                            Addr = "string",
                            Type = "string",
                        },
                    },
                    V4Enabled = "string",
                    V6Enabled = "string",
                },
            },
            Ip6s = new[]
            {
                new Avi.Inputs.ClusterNodeIp6Args
                {
                    Addr = "string",
                    Type = "string",
                },
            },
            Ips = new[]
            {
                new Avi.Inputs.ClusterNodeIpArgs
                {
                    Addr = "string",
                    Type = "string",
                },
            },
            Name = "string",
            Password = "string",
            PublicIpOrNames = new[]
            {
                new Avi.Inputs.ClusterNodePublicIpOrNameArgs
                {
                    Addr = "string",
                    Type = "string",
                },
            },
            StaticRoutes = new[]
            {
                new Avi.Inputs.ClusterNodeStaticRouteArgs
                {
                    NextHops = new[]
                    {
                        new Avi.Inputs.ClusterNodeStaticRouteNextHopArgs
                        {
                            Addr = "string",
                            Type = "string",
                        },
                    },
                    Prefixes = new[]
                    {
                        new Avi.Inputs.ClusterNodeStaticRoutePrefixArgs
                        {
                            IpAddrs = new[]
                            {
                                new Avi.Inputs.ClusterNodeStaticRoutePrefixIpAddrArgs
                                {
                                    Addr = "string",
                                    Type = "string",
                                },
                            },
                            Mask = "string",
                        },
                    },
                    RouteId = "string",
                    DisableGatewayMonitor = "string",
                    IfName = "string",
                    Labels = new[]
                    {
                        new Avi.Inputs.ClusterNodeStaticRouteLabelArgs
                        {
                            Key = "string",
                            Value = "string",
                        },
                    },
                },
            },
            VmHostname = "string",
            VmMor = "string",
            VmName = "string",
            VmUuid = "string",
        },
    },
    ClusterId = "string",
    ClusterStates = new[]
    {
        new Avi.Inputs.ClusterClusterStateArgs
        {
            Progress = "string",
            State = "string",
            UpSince = "string",
        },
    },
    Name = "string",
    RejoinNodesAutomatically = "string",
    TenantRef = "string",
    Uuid = "string",
    VirtualIp6s = new[]
    {
        new Avi.Inputs.ClusterVirtualIp6Args
        {
            Addr = "string",
            Type = "string",
        },
    },
    VirtualIps = new[]
    {
        new Avi.Inputs.ClusterVirtualIpArgs
        {
            Addr = "string",
            Type = "string",
        },
    },
});
Copy
example, err := avi.NewCluster(ctx, "clusterResource", &avi.ClusterArgs{
	Nodes: avi.ClusterNodeArray{
		&avi.ClusterNodeArgs{
			Categories: pulumi.StringArray{
				pulumi.String("string"),
			},
			Interfaces: avi.ClusterNodeInterfaceArray{
				&avi.ClusterNodeInterfaceArgs{
					Gateway6s: avi.ClusterNodeInterfaceGateway6Array{
						&avi.ClusterNodeInterfaceGateway6Args{
							Addr: pulumi.String("string"),
							Type: pulumi.String("string"),
						},
					},
					Gateways: avi.ClusterNodeInterfaceGatewayArray{
						&avi.ClusterNodeInterfaceGatewayArgs{
							Addr: pulumi.String("string"),
							Type: pulumi.String("string"),
						},
					},
					IfName: pulumi.String("string"),
					Ip6s: avi.ClusterNodeInterfaceIp6Array{
						&avi.ClusterNodeInterfaceIp6Args{
							IpAddrs: avi.ClusterNodeInterfaceIp6IpAddrArray{
								&avi.ClusterNodeInterfaceIp6IpAddrArgs{
									Addr: pulumi.String("string"),
									Type: pulumi.String("string"),
								},
							},
							Mask: pulumi.String("string"),
						},
					},
					Ips: avi.ClusterNodeInterfaceIpArray{
						&avi.ClusterNodeInterfaceIpArgs{
							IpAddrs: avi.ClusterNodeInterfaceIpIpAddrArray{
								&avi.ClusterNodeInterfaceIpIpAddrArgs{
									Addr: pulumi.String("string"),
									Type: pulumi.String("string"),
								},
							},
							Mask: pulumi.String("string"),
						},
					},
					Labels: pulumi.StringArray{
						pulumi.String("string"),
					},
					MacAddress: pulumi.String("string"),
					Mode:       pulumi.String("string"),
					Mode6:      pulumi.String("string"),
					PublicIpOrNames: avi.ClusterNodeInterfacePublicIpOrNameArray{
						&avi.ClusterNodeInterfacePublicIpOrNameArgs{
							Addr: pulumi.String("string"),
							Type: pulumi.String("string"),
						},
					},
					V4Enabled: pulumi.String("string"),
					V6Enabled: pulumi.String("string"),
				},
			},
			Ip6s: avi.ClusterNodeIp6Array{
				&avi.ClusterNodeIp6Args{
					Addr: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			Ips: avi.ClusterNodeIpArray{
				&avi.ClusterNodeIpArgs{
					Addr: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			Name:     pulumi.String("string"),
			Password: pulumi.String("string"),
			PublicIpOrNames: avi.ClusterNodePublicIpOrNameArray{
				&avi.ClusterNodePublicIpOrNameArgs{
					Addr: pulumi.String("string"),
					Type: pulumi.String("string"),
				},
			},
			StaticRoutes: avi.ClusterNodeStaticRouteArray{
				&avi.ClusterNodeStaticRouteArgs{
					NextHops: avi.ClusterNodeStaticRouteNextHopArray{
						&avi.ClusterNodeStaticRouteNextHopArgs{
							Addr: pulumi.String("string"),
							Type: pulumi.String("string"),
						},
					},
					Prefixes: avi.ClusterNodeStaticRoutePrefixArray{
						&avi.ClusterNodeStaticRoutePrefixArgs{
							IpAddrs: avi.ClusterNodeStaticRoutePrefixIpAddrArray{
								&avi.ClusterNodeStaticRoutePrefixIpAddrArgs{
									Addr: pulumi.String("string"),
									Type: pulumi.String("string"),
								},
							},
							Mask: pulumi.String("string"),
						},
					},
					RouteId:               pulumi.String("string"),
					DisableGatewayMonitor: pulumi.String("string"),
					IfName:                pulumi.String("string"),
					Labels: avi.ClusterNodeStaticRouteLabelArray{
						&avi.ClusterNodeStaticRouteLabelArgs{
							Key:   pulumi.String("string"),
							Value: pulumi.String("string"),
						},
					},
				},
			},
			VmHostname: pulumi.String("string"),
			VmMor:      pulumi.String("string"),
			VmName:     pulumi.String("string"),
			VmUuid:     pulumi.String("string"),
		},
	},
	ClusterId: pulumi.String("string"),
	ClusterStates: avi.ClusterClusterStateArray{
		&avi.ClusterClusterStateArgs{
			Progress: pulumi.String("string"),
			State:    pulumi.String("string"),
			UpSince:  pulumi.String("string"),
		},
	},
	Name:                     pulumi.String("string"),
	RejoinNodesAutomatically: pulumi.String("string"),
	TenantRef:                pulumi.String("string"),
	Uuid:                     pulumi.String("string"),
	VirtualIp6s: avi.ClusterVirtualIp6Array{
		&avi.ClusterVirtualIp6Args{
			Addr: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
	VirtualIps: avi.ClusterVirtualIpArray{
		&avi.ClusterVirtualIpArgs{
			Addr: pulumi.String("string"),
			Type: pulumi.String("string"),
		},
	},
})
Copy
var clusterResource = new Cluster("clusterResource", ClusterArgs.builder()
    .nodes(ClusterNodeArgs.builder()
        .categories("string")
        .interfaces(ClusterNodeInterfaceArgs.builder()
            .gateway6s(ClusterNodeInterfaceGateway6Args.builder()
                .addr("string")
                .type("string")
                .build())
            .gateways(ClusterNodeInterfaceGatewayArgs.builder()
                .addr("string")
                .type("string")
                .build())
            .ifName("string")
            .ip6s(ClusterNodeInterfaceIp6Args.builder()
                .ipAddrs(ClusterNodeInterfaceIp6IpAddrArgs.builder()
                    .addr("string")
                    .type("string")
                    .build())
                .mask("string")
                .build())
            .ips(ClusterNodeInterfaceIpArgs.builder()
                .ipAddrs(ClusterNodeInterfaceIpIpAddrArgs.builder()
                    .addr("string")
                    .type("string")
                    .build())
                .mask("string")
                .build())
            .labels("string")
            .macAddress("string")
            .mode("string")
            .mode6("string")
            .publicIpOrNames(ClusterNodeInterfacePublicIpOrNameArgs.builder()
                .addr("string")
                .type("string")
                .build())
            .v4Enabled("string")
            .v6Enabled("string")
            .build())
        .ip6s(ClusterNodeIp6Args.builder()
            .addr("string")
            .type("string")
            .build())
        .ips(ClusterNodeIpArgs.builder()
            .addr("string")
            .type("string")
            .build())
        .name("string")
        .password("string")
        .publicIpOrNames(ClusterNodePublicIpOrNameArgs.builder()
            .addr("string")
            .type("string")
            .build())
        .staticRoutes(ClusterNodeStaticRouteArgs.builder()
            .nextHops(ClusterNodeStaticRouteNextHopArgs.builder()
                .addr("string")
                .type("string")
                .build())
            .prefixes(ClusterNodeStaticRoutePrefixArgs.builder()
                .ipAddrs(ClusterNodeStaticRoutePrefixIpAddrArgs.builder()
                    .addr("string")
                    .type("string")
                    .build())
                .mask("string")
                .build())
            .routeId("string")
            .disableGatewayMonitor("string")
            .ifName("string")
            .labels(ClusterNodeStaticRouteLabelArgs.builder()
                .key("string")
                .value("string")
                .build())
            .build())
        .vmHostname("string")
        .vmMor("string")
        .vmName("string")
        .vmUuid("string")
        .build())
    .clusterId("string")
    .clusterStates(ClusterClusterStateArgs.builder()
        .progress("string")
        .state("string")
        .upSince("string")
        .build())
    .name("string")
    .rejoinNodesAutomatically("string")
    .tenantRef("string")
    .uuid("string")
    .virtualIp6s(ClusterVirtualIp6Args.builder()
        .addr("string")
        .type("string")
        .build())
    .virtualIps(ClusterVirtualIpArgs.builder()
        .addr("string")
        .type("string")
        .build())
    .build());
Copy
cluster_resource = avi.Cluster("clusterResource",
    nodes=[{
        "categories": ["string"],
        "interfaces": [{
            "gateway6s": [{
                "addr": "string",
                "type": "string",
            }],
            "gateways": [{
                "addr": "string",
                "type": "string",
            }],
            "if_name": "string",
            "ip6s": [{
                "ip_addrs": [{
                    "addr": "string",
                    "type": "string",
                }],
                "mask": "string",
            }],
            "ips": [{
                "ip_addrs": [{
                    "addr": "string",
                    "type": "string",
                }],
                "mask": "string",
            }],
            "labels": ["string"],
            "mac_address": "string",
            "mode": "string",
            "mode6": "string",
            "public_ip_or_names": [{
                "addr": "string",
                "type": "string",
            }],
            "v4_enabled": "string",
            "v6_enabled": "string",
        }],
        "ip6s": [{
            "addr": "string",
            "type": "string",
        }],
        "ips": [{
            "addr": "string",
            "type": "string",
        }],
        "name": "string",
        "password": "string",
        "public_ip_or_names": [{
            "addr": "string",
            "type": "string",
        }],
        "static_routes": [{
            "next_hops": [{
                "addr": "string",
                "type": "string",
            }],
            "prefixes": [{
                "ip_addrs": [{
                    "addr": "string",
                    "type": "string",
                }],
                "mask": "string",
            }],
            "route_id": "string",
            "disable_gateway_monitor": "string",
            "if_name": "string",
            "labels": [{
                "key": "string",
                "value": "string",
            }],
        }],
        "vm_hostname": "string",
        "vm_mor": "string",
        "vm_name": "string",
        "vm_uuid": "string",
    }],
    cluster_id="string",
    cluster_states=[{
        "progress": "string",
        "state": "string",
        "up_since": "string",
    }],
    name="string",
    rejoin_nodes_automatically="string",
    tenant_ref="string",
    uuid="string",
    virtual_ip6s=[{
        "addr": "string",
        "type": "string",
    }],
    virtual_ips=[{
        "addr": "string",
        "type": "string",
    }])
Copy
const clusterResource = new avi.Cluster("clusterResource", {
    nodes: [{
        categories: ["string"],
        interfaces: [{
            gateway6s: [{
                addr: "string",
                type: "string",
            }],
            gateways: [{
                addr: "string",
                type: "string",
            }],
            ifName: "string",
            ip6s: [{
                ipAddrs: [{
                    addr: "string",
                    type: "string",
                }],
                mask: "string",
            }],
            ips: [{
                ipAddrs: [{
                    addr: "string",
                    type: "string",
                }],
                mask: "string",
            }],
            labels: ["string"],
            macAddress: "string",
            mode: "string",
            mode6: "string",
            publicIpOrNames: [{
                addr: "string",
                type: "string",
            }],
            v4Enabled: "string",
            v6Enabled: "string",
        }],
        ip6s: [{
            addr: "string",
            type: "string",
        }],
        ips: [{
            addr: "string",
            type: "string",
        }],
        name: "string",
        password: "string",
        publicIpOrNames: [{
            addr: "string",
            type: "string",
        }],
        staticRoutes: [{
            nextHops: [{
                addr: "string",
                type: "string",
            }],
            prefixes: [{
                ipAddrs: [{
                    addr: "string",
                    type: "string",
                }],
                mask: "string",
            }],
            routeId: "string",
            disableGatewayMonitor: "string",
            ifName: "string",
            labels: [{
                key: "string",
                value: "string",
            }],
        }],
        vmHostname: "string",
        vmMor: "string",
        vmName: "string",
        vmUuid: "string",
    }],
    clusterId: "string",
    clusterStates: [{
        progress: "string",
        state: "string",
        upSince: "string",
    }],
    name: "string",
    rejoinNodesAutomatically: "string",
    tenantRef: "string",
    uuid: "string",
    virtualIp6s: [{
        addr: "string",
        type: "string",
    }],
    virtualIps: [{
        addr: "string",
        type: "string",
    }],
});
Copy
type: avi:Cluster
properties:
    clusterId: string
    clusterStates:
        - progress: string
          state: string
          upSince: string
    name: string
    nodes:
        - categories:
            - string
          interfaces:
            - gateway6s:
                - addr: string
                  type: string
              gateways:
                - addr: string
                  type: string
              ifName: string
              ip6s:
                - ipAddrs:
                    - addr: string
                      type: string
                  mask: string
              ips:
                - ipAddrs:
                    - addr: string
                      type: string
                  mask: string
              labels:
                - string
              macAddress: string
              mode: string
              mode6: string
              publicIpOrNames:
                - addr: string
                  type: string
              v4Enabled: string
              v6Enabled: string
          ip6s:
            - addr: string
              type: string
          ips:
            - addr: string
              type: string
          name: string
          password: string
          publicIpOrNames:
            - addr: string
              type: string
          staticRoutes:
            - disableGatewayMonitor: string
              ifName: string
              labels:
                - key: string
                  value: string
              nextHops:
                - addr: string
                  type: string
              prefixes:
                - ipAddrs:
                    - addr: string
                      type: string
                  mask: string
              routeId: string
          vmHostname: string
          vmMor: string
          vmName: string
          vmUuid: string
    rejoinNodesAutomatically: string
    tenantRef: string
    uuid: string
    virtualIp6s:
        - addr: string
          type: string
    virtualIps:
        - addr: string
          type: string
Copy

Cluster 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 Cluster resource accepts the following input properties:

Nodes This property is required. List<ClusterNode>
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ClusterId string
ClusterStates List<ClusterClusterState>
Name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
RejoinNodesAutomatically string
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VirtualIp6s List<ClusterVirtualIp6>
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
VirtualIps List<ClusterVirtualIp>
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Nodes This property is required. []ClusterNodeArgs
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ClusterId string
ClusterStates []ClusterClusterStateArgs
Name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
RejoinNodesAutomatically string
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VirtualIp6s []ClusterVirtualIp6Args
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
VirtualIps []ClusterVirtualIpArgs
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nodes This property is required. List<ClusterNode>
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
clusterId String
clusterStates List<ClusterClusterState>
name String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
rejoinNodesAutomatically String
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
virtualIp6s List<ClusterVirtualIp6>
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
virtualIps List<ClusterVirtualIp>
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nodes This property is required. ClusterNode[]
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
clusterId string
clusterStates ClusterClusterState[]
name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
rejoinNodesAutomatically string
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
virtualIp6s ClusterVirtualIp6[]
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
virtualIps ClusterVirtualIp[]
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nodes This property is required. Sequence[ClusterNodeArgs]
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cluster_id str
cluster_states Sequence[ClusterClusterStateArgs]
name str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
rejoin_nodes_automatically str
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
virtual_ip6s Sequence[ClusterVirtualIp6Args]
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
virtual_ips Sequence[ClusterVirtualIpArgs]
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nodes This property is required. List<Property Map>
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
clusterId String
clusterStates List<Property Map>
name String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
rejoinNodesAutomatically String
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
virtualIp6s List<Property Map>
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
virtualIps List<Property Map>
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Outputs

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

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing Cluster Resource

Get an existing Cluster 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?: ClusterState, opts?: CustomResourceOptions): Cluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cluster_id: Optional[str] = None,
        cluster_states: Optional[Sequence[ClusterClusterStateArgs]] = None,
        name: Optional[str] = None,
        nodes: Optional[Sequence[ClusterNodeArgs]] = None,
        rejoin_nodes_automatically: Optional[str] = None,
        tenant_ref: Optional[str] = None,
        uuid: Optional[str] = None,
        virtual_ip6s: Optional[Sequence[ClusterVirtualIp6Args]] = None,
        virtual_ips: Optional[Sequence[ClusterVirtualIpArgs]] = None) -> Cluster
func GetCluster(ctx *Context, name string, id IDInput, state *ClusterState, opts ...ResourceOption) (*Cluster, error)
public static Cluster Get(string name, Input<string> id, ClusterState? state, CustomResourceOptions? opts = null)
public static Cluster get(String name, Output<String> id, ClusterState state, CustomResourceOptions options)
resources:  _:    type: avi:Cluster    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:
ClusterId string
ClusterStates List<ClusterClusterState>
Name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Nodes List<ClusterNode>
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
RejoinNodesAutomatically string
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VirtualIp6s List<ClusterVirtualIp6>
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
VirtualIps List<ClusterVirtualIp>
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
ClusterId string
ClusterStates []ClusterClusterStateArgs
Name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Nodes []ClusterNodeArgs
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
RejoinNodesAutomatically string
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
TenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
VirtualIp6s []ClusterVirtualIp6Args
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
VirtualIps []ClusterVirtualIpArgs
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
clusterId String
clusterStates List<ClusterClusterState>
name String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nodes List<ClusterNode>
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
rejoinNodesAutomatically String
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
virtualIp6s List<ClusterVirtualIp6>
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
virtualIps List<ClusterVirtualIp>
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
clusterId string
clusterStates ClusterClusterState[]
name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nodes ClusterNode[]
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
rejoinNodesAutomatically string
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef string
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
virtualIp6s ClusterVirtualIp6[]
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
virtualIps ClusterVirtualIp[]
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
cluster_id str
cluster_states Sequence[ClusterClusterStateArgs]
name str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nodes Sequence[ClusterNodeArgs]
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
rejoin_nodes_automatically str
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenant_ref str
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid str
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
virtual_ip6s Sequence[ClusterVirtualIp6Args]
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
virtual_ips Sequence[ClusterVirtualIpArgs]
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
clusterId String
clusterStates List<Property Map>
name String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
nodes List<Property Map>
Minimum of 1 items required. Maximum of 7 items allowed. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
rejoinNodesAutomatically String
Re-join cluster nodes automatically in the event one of the node is reset to factory. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
tenantRef String
It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
uuid String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
virtualIp6s List<Property Map>
A v6 virtual ip address for the cluster that always points to the v6 ip of the leader node in cluster. Field introduced in 30.2.1. Allowed with any value in enterprise, enterprise with cloud services edition.
virtualIps List<Property Map>
A v4 virtual ip address for the cluster that always points to the v4 ip of the leader node in cluster. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

Supporting Types

ClusterClusterState
, ClusterClusterStateArgs

Progress string
State string
UpSince string
Progress string
State string
UpSince string
progress String
state String
upSince String
progress string
state string
upSince string
progress String
state String
upSince String

ClusterNode
, ClusterNodeArgs

Categories List<string>
Interfaces List<ClusterNodeInterface>
Ip6s List<ClusterNodeIp6>
Ips List<ClusterNodeIp>
Name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Password string
PublicIpOrNames List<ClusterNodePublicIpOrName>
StaticRoutes List<ClusterNodeStaticRoute>
VmHostname string
VmMor string
VmName string
VmUuid string
Categories []string
Interfaces []ClusterNodeInterface
Ip6s []ClusterNodeIp6
Ips []ClusterNodeIp
Name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Password string
PublicIpOrNames []ClusterNodePublicIpOrName
StaticRoutes []ClusterNodeStaticRoute
VmHostname string
VmMor string
VmName string
VmUuid string
categories List<String>
interfaces List<ClusterNodeInterface>
ip6s List<ClusterNodeIp6>
ips List<ClusterNodeIp>
name String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
password String
publicIpOrNames List<ClusterNodePublicIpOrName>
staticRoutes List<ClusterNodeStaticRoute>
vmHostname String
vmMor String
vmName String
vmUuid String
categories string[]
interfaces ClusterNodeInterface[]
ip6s ClusterNodeIp6[]
ips ClusterNodeIp[]
name string
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
password string
publicIpOrNames ClusterNodePublicIpOrName[]
staticRoutes ClusterNodeStaticRoute[]
vmHostname string
vmMor string
vmName string
vmUuid string
categories List<String>
interfaces List<Property Map>
ip6s List<Property Map>
ips List<Property Map>
name String
Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
password String
publicIpOrNames List<Property Map>
staticRoutes List<Property Map>
vmHostname String
vmMor String
vmName String
vmUuid String

ClusterNodeInterface
, ClusterNodeInterfaceArgs

ClusterNodeInterfaceGateway
, ClusterNodeInterfaceGatewayArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterNodeInterfaceGateway6
, ClusterNodeInterfaceGateway6Args

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterNodeInterfaceIp
, ClusterNodeInterfaceIpArgs

IpAddrs This property is required. List<ClusterNodeInterfaceIpIpAddr>
Mask This property is required. string
IpAddrs This property is required. []ClusterNodeInterfaceIpIpAddr
Mask This property is required. string
ipAddrs This property is required. List<ClusterNodeInterfaceIpIpAddr>
mask This property is required. String
ipAddrs This property is required. ClusterNodeInterfaceIpIpAddr[]
mask This property is required. string
ip_addrs This property is required. Sequence[ClusterNodeInterfaceIpIpAddr]
mask This property is required. str
ipAddrs This property is required. List<Property Map>
mask This property is required. String

ClusterNodeInterfaceIp6
, ClusterNodeInterfaceIp6Args

IpAddrs This property is required. List<ClusterNodeInterfaceIp6IpAddr>
Mask This property is required. string
IpAddrs This property is required. []ClusterNodeInterfaceIp6IpAddr
Mask This property is required. string
ipAddrs This property is required. List<ClusterNodeInterfaceIp6IpAddr>
mask This property is required. String
ipAddrs This property is required. ClusterNodeInterfaceIp6IpAddr[]
mask This property is required. string
ip_addrs This property is required. Sequence[ClusterNodeInterfaceIp6IpAddr]
mask This property is required. str
ipAddrs This property is required. List<Property Map>
mask This property is required. String

ClusterNodeInterfaceIp6IpAddr
, ClusterNodeInterfaceIp6IpAddrArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterNodeInterfaceIpIpAddr
, ClusterNodeInterfaceIpIpAddrArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterNodeInterfacePublicIpOrName
, ClusterNodeInterfacePublicIpOrNameArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterNodeIp
, ClusterNodeIpArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterNodeIp6
, ClusterNodeIp6Args

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterNodePublicIpOrName
, ClusterNodePublicIpOrNameArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterNodeStaticRoute
, ClusterNodeStaticRouteArgs

NextHops This property is required. []ClusterNodeStaticRouteNextHop
Prefixes This property is required. []ClusterNodeStaticRoutePrefix
RouteId This property is required. string
DisableGatewayMonitor string
IfName string
Labels []ClusterNodeStaticRouteLabel
nextHops This property is required. ClusterNodeStaticRouteNextHop[]
prefixes This property is required. ClusterNodeStaticRoutePrefix[]
routeId This property is required. string
disableGatewayMonitor string
ifName string
labels ClusterNodeStaticRouteLabel[]
nextHops This property is required. List<Property Map>
prefixes This property is required. List<Property Map>
routeId This property is required. String
disableGatewayMonitor String
ifName String
labels List<Property Map>

ClusterNodeStaticRouteLabel
, ClusterNodeStaticRouteLabelArgs

Key This property is required. string
Value string
Key This property is required. string
Value string
key This property is required. String
value String
key This property is required. string
value string
key This property is required. str
value str
key This property is required. String
value String

ClusterNodeStaticRouteNextHop
, ClusterNodeStaticRouteNextHopArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterNodeStaticRoutePrefix
, ClusterNodeStaticRoutePrefixArgs

IpAddrs This property is required. List<ClusterNodeStaticRoutePrefixIpAddr>
Mask This property is required. string
IpAddrs This property is required. []ClusterNodeStaticRoutePrefixIpAddr
Mask This property is required. string
ipAddrs This property is required. List<ClusterNodeStaticRoutePrefixIpAddr>
mask This property is required. String
ipAddrs This property is required. ClusterNodeStaticRoutePrefixIpAddr[]
mask This property is required. string
ip_addrs This property is required. Sequence[ClusterNodeStaticRoutePrefixIpAddr]
mask This property is required. str
ipAddrs This property is required. List<Property Map>
mask This property is required. String

ClusterNodeStaticRoutePrefixIpAddr
, ClusterNodeStaticRoutePrefixIpAddrArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterVirtualIp
, ClusterVirtualIpArgs

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

ClusterVirtualIp6
, ClusterVirtualIp6Args

Addr This property is required. string
Type This property is required. string
Addr This property is required. string
Type This property is required. string
addr This property is required. String
type This property is required. String
addr This property is required. string
type This property is required. string
addr This property is required. str
type This property is required. str
addr This property is required. String
type This property is required. String

Package Details

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