1. Packages
  2. Vsphere Provider
  3. API Docs
  4. ComputeClusterVmAntiAffinityRule
Viewing docs for vSphere v4.16.3
published on Thursday, Feb 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-vsphere

vsphere.ComputeClusterVmAntiAffinityRule

vsphere logo
Viewing docs for vSphere v4.16.3
published on Thursday, Feb 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-vsphere

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

    An anti-affinity rule places a group of virtual machines across different hosts within a cluster, and is useful for preventing single points of failure in application cluster scenarios. When configured, vSphere DRS will make a best effort to ensure that the virtual machines run on different hosts, or prevent any operation that would keep that from happening, depending on the value of the mandatory flag.

    An anti-affinity rule can only be used to place virtual machines on separate non-specific hosts. Specific hosts cannot be specified with this rule. To enable this capability, use VM-Host Groups, see the vsphere.ComputeClusterVmHostRule resource.

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

    Create ComputeClusterVmAntiAffinityRule Resource

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

    Constructor syntax

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

@overload
def ComputeClusterVmAntiAffinityRule(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 NewComputeClusterVmAntiAffinityRule(ctx *Context, name string, args ComputeClusterVmAntiAffinityRuleArgs, opts ...ResourceOption) (*ComputeClusterVmAntiAffinityRule, error)
    public ComputeClusterVmAntiAffinityRule(string name, ComputeClusterVmAntiAffinityRuleArgs args, CustomResourceOptions? opts = null)
    public ComputeClusterVmAntiAffinityRule(String name, ComputeClusterVmAntiAffinityRuleArgs args)
public ComputeClusterVmAntiAffinityRule(String name, ComputeClusterVmAntiAffinityRuleArgs args, CustomResourceOptions options)

    type: vsphere:ComputeClusterVmAntiAffinityRule
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 ComputeClusterVmAntiAffinityRuleArgs
    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 ComputeClusterVmAntiAffinityRuleArgs
    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 ComputeClusterVmAntiAffinityRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ComputeClusterVmAntiAffinityRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ComputeClusterVmAntiAffinityRuleArgs
    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 computeClusterVmAntiAffinityRuleResource = new VSphere.ComputeClusterVmAntiAffinityRule("computeClusterVmAntiAffinityRuleResource", new()
{
    ComputeClusterId = "string",
    VirtualMachineIds = new[]
    {
        "string",
    },
    Enabled = false,
    Mandatory = false,
    Name = "string",
});

    example, err := vsphere.NewComputeClusterVmAntiAffinityRule(ctx, "computeClusterVmAntiAffinityRuleResource", &vsphere.ComputeClusterVmAntiAffinityRuleArgs{
	ComputeClusterId: pulumi.String("string"),
	VirtualMachineIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Enabled:   pulumi.Bool(false),
	Mandatory: pulumi.Bool(false),
	Name:      pulumi.String("string"),
})

    var computeClusterVmAntiAffinityRuleResource = new ComputeClusterVmAntiAffinityRule("computeClusterVmAntiAffinityRuleResource", ComputeClusterVmAntiAffinityRuleArgs.builder()
    .computeClusterId("string")
    .virtualMachineIds("string")
    .enabled(false)
    .mandatory(false)
    .name("string")
    .build());

    compute_cluster_vm_anti_affinity_rule_resource = vsphere.ComputeClusterVmAntiAffinityRule("computeClusterVmAntiAffinityRuleResource",
    compute_cluster_id="string",
    virtual_machine_ids=["string"],
    enabled=False,
    mandatory=False,
    name="string")

    const computeClusterVmAntiAffinityRuleResource = new vsphere.ComputeClusterVmAntiAffinityRule("computeClusterVmAntiAffinityRuleResource", {
    computeClusterId: "string",
    virtualMachineIds: ["string"],
    enabled: false,
    mandatory: false,
    name: "string",
});

    type: vsphere:ComputeClusterVmAntiAffinityRule
properties:
    computeClusterId: string
    enabled: false
    mandatory: false
    name: string
    virtualMachineIds:
        - string

    ComputeClusterVmAntiAffinityRule 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 ComputeClusterVmAntiAffinityRule 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 hosts different from each other.
    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 hosts different from each other.
    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 hosts different from each other.
    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 hosts different from each other.
    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 hosts different from each other.
    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 hosts different from each other.
    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 ComputeClusterVmAntiAffinityRule 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 ComputeClusterVmAntiAffinityRule Resource

    Get an existing ComputeClusterVmAntiAffinityRule 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?: ComputeClusterVmAntiAffinityRuleState, opts?: CustomResourceOptions): ComputeClusterVmAntiAffinityRule
    @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) -> ComputeClusterVmAntiAffinityRule
    func GetComputeClusterVmAntiAffinityRule(ctx *Context, name string, id IDInput, state *ComputeClusterVmAntiAffinityRuleState, opts ...ResourceOption) (*ComputeClusterVmAntiAffinityRule, error)
    public static ComputeClusterVmAntiAffinityRule Get(string name, Input<string> id, ComputeClusterVmAntiAffinityRuleState? state, CustomResourceOptions? opts = null)
    public static ComputeClusterVmAntiAffinityRule get(String name, Output<String> id, ComputeClusterVmAntiAffinityRuleState state, CustomResourceOptions options)
    resources:  _:    type: vsphere:ComputeClusterVmAntiAffinityRule    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.
    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 hosts different from each other.
    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 hosts different from each other.
    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 hosts different from each other.
    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 hosts different from each other.
    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 hosts different from each other.
    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 hosts different from each other.

    Import

    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_anti_affinity_rule.vm_anti_affinity_rule \
  '{"compute_cluster_path": "/dc-01/host/cluster-01", \
  "name": "vm-anti-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
    Viewing docs for vSphere v4.16.3
    published on Thursday, Feb 26, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-vsphere
      Try Pulumi Cloud free. Your team will thank you.