1. Packages
  2. vSphere
  3. API Docs
  4. ComputeClusterVmAffinityRule
vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi

vsphere.ComputeClusterVmAffinityRule

Explore with Pulumi AI

vsphere logo
vSphere v4.10.1 published on Friday, May 10, 2024 by Pulumi

    The vsphere.ComputeClusterVmAffinityRule resource can be used to manage virtual machine affinity rules in a cluster, either created by the vsphere.ComputeCluster resource or looked up by the vsphere.ComputeCluster data source.

    This rule can be used to tell a set of virtual machines to run together on the same host within a cluster. When configured, DRS will make a best effort to ensure that the virtual machines run on the same host, or prevent any operation that would keep that from happening, depending on the value of the mandatory flag.

    An affinity rule can only be used to place virtual machines on the same non-specific hosts. It cannot be used to pin virtual machines to a host. To enable this capability, use the vsphere.ComputeClusterVmHostRule resource.

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

    NOTE: vSphere DRS requires a vSphere Enterprise Plus license.

    Example Usage

    The following example creates two virtual machines in a cluster using the vsphere.VirtualMachine resource, creating the virtual machines in the cluster looked up by the vsphere.ComputeCluster data source. It then creates an affinity rule for these two virtual machines, ensuring they will run on the same host whenever possible.

    import * as pulumi from "@pulumi/pulumi";
    import * as vsphere from "@pulumi/vsphere";
    
    const datacenter = vsphere.getDatacenter({
        name: "dc-01",
    });
    const datastore = datacenter.then(datacenter => vsphere.getDatastore({
        name: "datastore-01",
        datacenterId: datacenter.id,
    }));
    const cluster = datacenter.then(datacenter => vsphere.getComputeCluster({
        name: "cluster-01",
        datacenterId: datacenter.id,
    }));
    const network = datacenter.then(datacenter => vsphere.getNetwork({
        name: "VM Network",
        datacenterId: datacenter.id,
    }));
    const vm: vsphere.VirtualMachine[] = [];
    for (const range = {value: 0}; range.value < 2; range.value++) {
        vm.push(new vsphere.VirtualMachine(`vm-${range.value}`, {
            name: `foo-${range.value}`,
            resourcePoolId: cluster.then(cluster => cluster.resourcePoolId),
            datastoreId: datastore.then(datastore => datastore.id),
            numCpus: 1,
            memory: 1024,
            guestId: "otherLinux64Guest",
            networkInterfaces: [{
                networkId: network.then(network => network.id),
            }],
            disks: [{
                label: "disk0",
                size: 20,
            }],
        }));
    }
    const vmAffinityRule = new vsphere.ComputeClusterVmAffinityRule("vm_affinity_rule", {
        name: "vm-affinity-rule",
        computeClusterId: cluster.then(cluster => cluster.id),
        virtualMachineIds: vm.map((v, k) => [k, v]).map(([, ]) => (v.id)),
    });
    
    import pulumi
    import pulumi_vsphere as vsphere
    
    datacenter = vsphere.get_datacenter(name="dc-01")
    datastore = vsphere.get_datastore(name="datastore-01",
        datacenter_id=datacenter.id)
    cluster = vsphere.get_compute_cluster(name="cluster-01",
        datacenter_id=datacenter.id)
    network = vsphere.get_network(name="VM Network",
        datacenter_id=datacenter.id)
    vm = []
    for range in [{"value": i} for i in range(0, 2)]:
        vm.append(vsphere.VirtualMachine(f"vm-{range['value']}",
            name=f"foo-{range['value']}",
            resource_pool_id=cluster.resource_pool_id,
            datastore_id=datastore.id,
            num_cpus=1,
            memory=1024,
            guest_id="otherLinux64Guest",
            network_interfaces=[vsphere.VirtualMachineNetworkInterfaceArgs(
                network_id=network.id,
            )],
            disks=[vsphere.VirtualMachineDiskArgs(
                label="disk0",
                size=20,
            )]))
    vm_affinity_rule = vsphere.ComputeClusterVmAffinityRule("vm_affinity_rule",
        name="vm-affinity-rule",
        compute_cluster_id=cluster.id,
        virtual_machine_ids=[v.id for k, v in vm])
    
    Coming soon!
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using VSphere = Pulumi.VSphere;
    
    return await Deployment.RunAsync(() => 
    {
        var datacenter = VSphere.GetDatacenter.Invoke(new()
        {
            Name = "dc-01",
        });
    
        var datastore = VSphere.GetDatastore.Invoke(new()
        {
            Name = "datastore-01",
            DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
        });
    
        var cluster = VSphere.GetComputeCluster.Invoke(new()
        {
            Name = "cluster-01",
            DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
        });
    
        var network = VSphere.GetNetwork.Invoke(new()
        {
            Name = "VM Network",
            DatacenterId = datacenter.Apply(getDatacenterResult => getDatacenterResult.Id),
        });
    
        var vm = new List<VSphere.VirtualMachine>();
        for (var rangeIndex = 0; rangeIndex < 2; rangeIndex++)
        {
            var range = new { Value = rangeIndex };
            vm.Add(new VSphere.VirtualMachine($"vm-{range.Value}", new()
            {
                Name = $"foo-{range.Value}",
                ResourcePoolId = cluster.Apply(getComputeClusterResult => getComputeClusterResult.ResourcePoolId),
                DatastoreId = datastore.Apply(getDatastoreResult => getDatastoreResult.Id),
                NumCpus = 1,
                Memory = 1024,
                GuestId = "otherLinux64Guest",
                NetworkInterfaces = new[]
                {
                    new VSphere.Inputs.VirtualMachineNetworkInterfaceArgs
                    {
                        NetworkId = network.Apply(getNetworkResult => getNetworkResult.Id),
                    },
                },
                Disks = new[]
                {
                    new VSphere.Inputs.VirtualMachineDiskArgs
                    {
                        Label = "disk0",
                        Size = 20,
                    },
                },
            }));
        }
        var vmAffinityRule = new VSphere.ComputeClusterVmAffinityRule("vm_affinity_rule", new()
        {
            Name = "vm-affinity-rule",
            ComputeClusterId = cluster.Apply(getComputeClusterResult => getComputeClusterResult.Id),
            VirtualMachineIds = vm.Select((value, i) => new { Key = i.ToString(), Value = pair.Value }).Select(v => 
            {
                return v.Id;
            }).ToList(),
        });
    
    });
    
    Coming soon!
    
    Coming soon!
    

    The following example creates an affinity rule for a set of virtual machines in the cluster by looking up the virtual machine UUIDs from the vsphere.VirtualMachine data source.

    import * as pulumi from "@pulumi/pulumi";
    import * as vsphere from "@pulumi/vsphere";
    
    const vms = [
        "foo-0",
        "foo-1",
    ];
    const datacenter = vsphere.getDatacenter({
        name: "dc-01",
    });
    const cluster = datacenter.then(datacenter => vsphere.getComputeCluster({
        name: "cluster-01",
        datacenterId: datacenter.id,
    }));
    const vmsGetVirtualMachine = (new Array(vms.length)).map((_, i) => i).map(__index => (vsphere.getVirtualMachine({
        name: vms[__index],
        datacenterId: _arg0_.id,
    })));
    const vmAffinityRule = new vsphere.ComputeClusterVmAffinityRule("vm_affinity_rule", {
        name: "vm-affinity-rule",
        enabled: true,
        computeClusterId: cluster.then(cluster => cluster.id),
        virtualMachineIds: vmsGetVirtualMachine.map(__item => __item.id),
    });
    
    import pulumi
    import pulumi_vsphere as vsphere
    
    vms = [
        "foo-0",
        "foo-1",
    ]
    datacenter = vsphere.get_datacenter(name="dc-01")
    cluster = vsphere.get_compute_cluster(name="cluster-01",
        datacenter_id=datacenter.id)
    vms_get_virtual_machine = [vsphere.get_virtual_machine(name=vms[__index],
        datacenter_id=datacenter.id) for __index in range(len(vms))]
    vm_affinity_rule = vsphere.ComputeClusterVmAffinityRule("vm_affinity_rule",
        name="vm-affinity-rule",
        enabled=True,
        compute_cluster_id=cluster.id,
        virtual_machine_ids=[__item.id for __item in vms_get_virtual_machine])
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    

    Create ComputeClusterVmAffinityRule Resource

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

    Constructor syntax

    new ComputeClusterVmAffinityRule(name: string, args: ComputeClusterVmAffinityRuleArgs, opts?: CustomResourceOptions);
    @overload
    def ComputeClusterVmAffinityRule(resource_name: str,
                                     args: ComputeClusterVmAffinityRuleArgs,
                                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def ComputeClusterVmAffinityRule(resource_name: str,
                                     opts: Optional[ResourceOptions] = None,
                                     compute_cluster_id: Optional[str] = None,
                                     virtual_machine_ids: Optional[Sequence[str]] = None,
                                     enabled: Optional[bool] = None,
                                     mandatory: Optional[bool] = None,
                                     name: Optional[str] = None)
    func NewComputeClusterVmAffinityRule(ctx *Context, name string, args ComputeClusterVmAffinityRuleArgs, opts ...ResourceOption) (*ComputeClusterVmAffinityRule, error)
    public ComputeClusterVmAffinityRule(string name, ComputeClusterVmAffinityRuleArgs args, CustomResourceOptions? opts = null)
    public ComputeClusterVmAffinityRule(String name, ComputeClusterVmAffinityRuleArgs args)
    public ComputeClusterVmAffinityRule(String name, ComputeClusterVmAffinityRuleArgs args, CustomResourceOptions options)
    
    type: vsphere:ComputeClusterVmAffinityRule
    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 ComputeClusterVmAffinityRuleArgs
    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 ComputeClusterVmAffinityRuleArgs
    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 ComputeClusterVmAffinityRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ComputeClusterVmAffinityRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ComputeClusterVmAffinityRuleArgs
    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 computeClusterVmAffinityRuleResource = new VSphere.ComputeClusterVmAffinityRule("computeClusterVmAffinityRuleResource", new()
    {
        ComputeClusterId = "string",
        VirtualMachineIds = new[]
        {
            "string",
        },
        Enabled = false,
        Mandatory = false,
        Name = "string",
    });
    
    example, err := vsphere.NewComputeClusterVmAffinityRule(ctx, "computeClusterVmAffinityRuleResource", &vsphere.ComputeClusterVmAffinityRuleArgs{
    	ComputeClusterId: pulumi.String("string"),
    	VirtualMachineIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Enabled:   pulumi.Bool(false),
    	Mandatory: pulumi.Bool(false),
    	Name:      pulumi.String("string"),
    })
    
    var computeClusterVmAffinityRuleResource = new ComputeClusterVmAffinityRule("computeClusterVmAffinityRuleResource", ComputeClusterVmAffinityRuleArgs.builder()
        .computeClusterId("string")
        .virtualMachineIds("string")
        .enabled(false)
        .mandatory(false)
        .name("string")
        .build());
    
    compute_cluster_vm_affinity_rule_resource = vsphere.ComputeClusterVmAffinityRule("computeClusterVmAffinityRuleResource",
        compute_cluster_id="string",
        virtual_machine_ids=["string"],
        enabled=False,
        mandatory=False,
        name="string")
    
    const computeClusterVmAffinityRuleResource = new vsphere.ComputeClusterVmAffinityRule("computeClusterVmAffinityRuleResource", {
        computeClusterId: "string",
        virtualMachineIds: ["string"],
        enabled: false,
        mandatory: false,
        name: "string",
    });
    
    type: vsphere:ComputeClusterVmAffinityRule
    properties:
        computeClusterId: string
        enabled: false
        mandatory: false
        name: string
        virtualMachineIds:
            - string
    

    ComputeClusterVmAffinityRule Resource Properties

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

    Inputs

    The ComputeClusterVmAffinityRule 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.
    VirtualMachineIds List<string>
    The UUIDs of the virtual machines to run on the same host together.
    Enabled bool
    Enable this rule in the cluster. Default: true.
    Mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    Name string
    The name of the rule. This must be unique in the cluster.
    ComputeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    VirtualMachineIds []string
    The UUIDs of the virtual machines to run on the same host together.
    Enabled bool
    Enable this rule in the cluster. Default: true.
    Mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    Name string
    The name of the rule. This must be unique in the cluster.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    virtualMachineIds List<String>
    The UUIDs of the virtual machines to run on the same host together.
    enabled Boolean
    Enable this rule in the cluster. Default: true.
    mandatory Boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name String
    The name of the rule. This must be unique in the cluster.
    computeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    virtualMachineIds string[]
    The UUIDs of the virtual machines to run on the same host together.
    enabled boolean
    Enable this rule in the cluster. Default: true.
    mandatory boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name string
    The name of the rule. This must be unique in the cluster.
    compute_cluster_id str
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    virtual_machine_ids Sequence[str]
    The UUIDs of the virtual machines to run on the same host together.
    enabled bool
    Enable this rule in the cluster. Default: true.
    mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name str
    The name of the rule. This must be unique in the cluster.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    virtualMachineIds List<String>
    The UUIDs of the virtual machines to run on the same host together.
    enabled Boolean
    Enable this rule in the cluster. Default: true.
    mandatory Boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name String
    The name of the rule. This must be unique in the cluster.

    Outputs

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

    Get an existing ComputeClusterVmAffinityRule 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?: ComputeClusterVmAffinityRuleState, opts?: CustomResourceOptions): ComputeClusterVmAffinityRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compute_cluster_id: Optional[str] = None,
            enabled: Optional[bool] = None,
            mandatory: Optional[bool] = None,
            name: Optional[str] = None,
            virtual_machine_ids: Optional[Sequence[str]] = None) -> ComputeClusterVmAffinityRule
    func GetComputeClusterVmAffinityRule(ctx *Context, name string, id IDInput, state *ComputeClusterVmAffinityRuleState, opts ...ResourceOption) (*ComputeClusterVmAffinityRule, error)
    public static ComputeClusterVmAffinityRule Get(string name, Input<string> id, ComputeClusterVmAffinityRuleState? state, CustomResourceOptions? opts = null)
    public static ComputeClusterVmAffinityRule get(String name, Output<String> id, ComputeClusterVmAffinityRuleState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    Enabled bool
    Enable this rule in the cluster. Default: true.
    Mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    Name string
    The name of the rule. This must be unique in the cluster.
    VirtualMachineIds List<string>
    The UUIDs of the virtual machines to run on the same host together.
    ComputeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    Enabled bool
    Enable this rule in the cluster. Default: true.
    Mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    Name string
    The name of the rule. This must be unique in the cluster.
    VirtualMachineIds []string
    The UUIDs of the virtual machines to run on the same host together.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    enabled Boolean
    Enable this rule in the cluster. Default: true.
    mandatory Boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name String
    The name of the rule. This must be unique in the cluster.
    virtualMachineIds List<String>
    The UUIDs of the virtual machines to run on the same host together.
    computeClusterId string
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    enabled boolean
    Enable this rule in the cluster. Default: true.
    mandatory boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name string
    The name of the rule. This must be unique in the cluster.
    virtualMachineIds string[]
    The UUIDs of the virtual machines to run on the same host together.
    compute_cluster_id str
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    enabled bool
    Enable this rule in the cluster. Default: true.
    mandatory bool

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name str
    The name of the rule. This must be unique in the cluster.
    virtual_machine_ids Sequence[str]
    The UUIDs of the virtual machines to run on the same host together.
    computeClusterId String
    The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
    enabled Boolean
    Enable this rule in the cluster. Default: true.
    mandatory Boolean

    When this value is true, prevents any virtual machine operations that may violate this rule. Default: false.

    NOTE: The namespace for rule names on this resource (defined by the name argument) is shared with all rules in the cluster - consider this when naming your rules.

    name String
    The name of the rule. This must be unique in the cluster.
    virtualMachineIds List<String>
    The UUIDs of the virtual machines to run on the same host together.

    Import

    ing

    An existing rule can be imported into this resource by supplying both the path to the cluster, and the name the rule. If the name or cluster is not found, or if the rule is of a different type, an error will be returned. An example is below:

    terraform import vsphere_compute_cluster_vm_affinity_rule.vm_affinity_rule \
      '{"compute_cluster_path": "/dc-01/host/cluster-01", \
      "name": "vm-affinity-rule"}'
    

    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.10.1 published on Friday, May 10, 2024 by Pulumi