Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. ComputeClusterHostGroup
vSphere v4.14.0 published on Tuesday, May 20, 2025 by Pulumi
pulumi/pulumi-vsphere

vsphere.ComputeClusterHostGroup

Explore with Pulumi AI

vsphere logo
vSphere v4.14.0 published on Tuesday, May 20, 2025 by Pulumi
pulumi/pulumi-vsphere

    The vsphere.ComputeClusterHostGroup resource can be used to manage groups of hosts in a cluster, either created by the vsphere.ComputeCluster resource or looked up by the vsphere.ComputeCluster data source.

    This resource mainly serves as an input to the vsphere.ComputeClusterVmHostRule resource - see the documentation for that resource for further details on how to use host groups.

    NOTE: This resource requires vCenter and is not available on direct ESXi connections.

    Example Usage

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

const config = new pulumi.Config();
const datacenter = config.get("datacenter") || "dc-01";
const hosts = config.getObject<any>("hosts") || [
    "esxi-01.example.com",
    "esxi-02.example.com",
    "esxi-03.example.com",
];
const datacenterGetDatacenter = vsphere.getDatacenter({
    name: datacenter,
});
const hostsGetHost = (new Array(hosts.length)).map((_, i) => i).map(__index => (vsphere.getHost({
    name: hosts[__index],
    datacenterId: _arg0_.id,
})));
const computeCluster = new vsphere.ComputeCluster("compute_cluster", {
    name: "compute-cluster-test",
    datacenterId: dc.id,
    hostSystemIds: [hostsGetHost.map(__item => __item.id)],
    drsEnabled: true,
    drsAutomationLevel: "fullyAutomated",
    haEnabled: true,
});
const clusterHostGroup = new vsphere.ComputeClusterHostGroup("cluster_host_group", {
    name: "test-cluster-host-group",
    computeClusterId: computeCluster.id,
    hostSystemIds: [hostsGetHost.map(__item => __item.id)],
});

    import pulumi
import pulumi_vsphere as vsphere

config = pulumi.Config()
datacenter = config.get("datacenter")
if datacenter is None:
    datacenter = "dc-01"
hosts = config.get_object("hosts")
if hosts is None:
    hosts = [
        "esxi-01.example.com",
        "esxi-02.example.com",
        "esxi-03.example.com",
    ]
datacenter_get_datacenter = vsphere.get_datacenter(name=datacenter)
hosts_get_host = [vsphere.get_host(name=hosts[__index],
    datacenter_id=datacenter_get_datacenter.id) for __index in range(len(hosts))]
compute_cluster = vsphere.ComputeCluster("compute_cluster",
    name="compute-cluster-test",
    datacenter_id=dc["id"],
    host_system_ids=[[__item.id for __item in hosts_get_host]],
    drs_enabled=True,
    drs_automation_level="fullyAutomated",
    ha_enabled=True)
cluster_host_group = vsphere.ComputeClusterHostGroup("cluster_host_group",
    name="test-cluster-host-group",
    compute_cluster_id=compute_cluster.id,
    host_system_ids=[[__item.id for __item in hosts_get_host]])

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Create ComputeClusterHostGroup Resource

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

    Constructor syntax

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

@overload
def ComputeClusterHostGroup(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            compute_cluster_id: Optional[str] = None,
                            host_system_ids: Optional[Sequence[str]] = None,
                            name: Optional[str] = None)
    func NewComputeClusterHostGroup(ctx *Context, name string, args ComputeClusterHostGroupArgs, opts ...ResourceOption) (*ComputeClusterHostGroup, error)
    public ComputeClusterHostGroup(string name, ComputeClusterHostGroupArgs args, CustomResourceOptions? opts = null)
    public ComputeClusterHostGroup(String name, ComputeClusterHostGroupArgs args)
public ComputeClusterHostGroup(String name, ComputeClusterHostGroupArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args ComputeClusterHostGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ComputeClusterHostGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ComputeClusterHostGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ComputeClusterHostGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ComputeClusterHostGroupArgs
    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 computeClusterHostGroupResource = new VSphere.ComputeClusterHostGroup("computeClusterHostGroupResource", new()
{
    ComputeClusterId = "string",
    HostSystemIds = new[]
    {
        "string",
    },
    Name = "string",
});

    example, err := vsphere.NewComputeClusterHostGroup(ctx, "computeClusterHostGroupResource", &vsphere.ComputeClusterHostGroupArgs{
	ComputeClusterId: pulumi.String("string"),
	HostSystemIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name: pulumi.String("string"),
})

    var computeClusterHostGroupResource = new ComputeClusterHostGroup("computeClusterHostGroupResource", ComputeClusterHostGroupArgs.builder()
    .computeClusterId("string")
    .hostSystemIds("string")
    .name("string")
    .build());

    compute_cluster_host_group_resource = vsphere.ComputeClusterHostGroup("computeClusterHostGroupResource",
    compute_cluster_id="string",
    host_system_ids=["string"],
    name="string")

    const computeClusterHostGroupResource = new vsphere.ComputeClusterHostGroup("computeClusterHostGroupResource", {
    computeClusterId: "string",
    hostSystemIds: ["string"],
    name: "string",
});

    type: vsphere:ComputeClusterHostGroup
properties:
    computeClusterId: string
    hostSystemIds:
        - string
    name: string

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

    ComputeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    HostSystemIds List<string>

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    Name string
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
    ComputeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    HostSystemIds []string

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    Name string
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    hostSystemIds List<String>

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    name String
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
    computeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    hostSystemIds string[]

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    name string
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
    compute_cluster_id str
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    host_system_ids Sequence[str]

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    name str
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    hostSystemIds List<String>

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    name String
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ComputeClusterHostGroup 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 ComputeClusterHostGroup Resource

    Get an existing ComputeClusterHostGroup 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?: ComputeClusterHostGroupState, opts?: CustomResourceOptions): ComputeClusterHostGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compute_cluster_id: Optional[str] = None,
        host_system_ids: Optional[Sequence[str]] = None,
        name: Optional[str] = None) -> ComputeClusterHostGroup
    func GetComputeClusterHostGroup(ctx *Context, name string, id IDInput, state *ComputeClusterHostGroupState, opts ...ResourceOption) (*ComputeClusterHostGroup, error)
    public static ComputeClusterHostGroup Get(string name, Input<string> id, ComputeClusterHostGroupState? state, CustomResourceOptions? opts = null)
    public static ComputeClusterHostGroup get(String name, Output<String> id, ComputeClusterHostGroupState state, CustomResourceOptions options)
    resources:  _:    type: vsphere:ComputeClusterHostGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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
    The unique name of the resulting resource.
    id
    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:
    ComputeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    HostSystemIds List<string>

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    Name string
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
    ComputeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    HostSystemIds []string

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    Name string
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    hostSystemIds List<String>

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    name String
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
    computeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    hostSystemIds string[]

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    name string
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
    compute_cluster_id str
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    host_system_ids Sequence[str]

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    name str
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    hostSystemIds List<String>

    The managed object IDs of the hosts to put in the cluster.

    NOTE: The namespace for cluster names on this resource (defined by the name argument) is shared with the vsphere.ComputeClusterVmGroup resource. Make sure your names are unique across both resources.

    name String
    The name of the host group. This must be unique in the cluster. Forces a new resource if changed.

    Import

    An existing group can be imported into this resource by

    supplying both the path to the cluster, and the name of the host group. If the

    name or cluster is not found, or if the group is of a different type, an error

    will be returned. An example is below:

    $ pulumi import vsphere:index/computeClusterHostGroup:ComputeClusterHostGroup cluster_host_group \

    ‘{“compute_cluster_path”: “/dc1/host/cluster1”, \

    “name”: “pulumi-test-cluster-host-group”}’

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo
    vSphere v4.14.0 published on Tuesday, May 20, 2025 by Pulumi
    pulumi/pulumi-vsphere