Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vsphere Provider
  3. API Docs
  4. ComputeClusterVmAntiAffinityRule
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

vsphere.ComputeClusterVmAntiAffinityRule

Explore with Pulumi AI

vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere

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:

$ pulumi import vsphere:index/computeClusterVmAntiAffinityRule:ComputeClusterVmAntiAffinityRule vm_anti_affinity_rule \
Copy

‘{“compute_cluster_path”: “/dc-01/host/cluster-01”, \

“name”: “vm-anti-affinity-rule”}’

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 This property is required. string
The unique name of the resource.
args This property is required. ComputeClusterVmAntiAffinityRuleArgs
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. 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 This property is required. string
The unique name of the resource.
args This property is required. ComputeClusterVmAntiAffinityRuleArgs
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. ComputeClusterVmAntiAffinityRuleArgs
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. 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",
});
Copy
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"),
})
Copy
var computeClusterVmAntiAffinityRuleResource = new ComputeClusterVmAntiAffinityRule("computeClusterVmAntiAffinityRuleResource", ComputeClusterVmAntiAffinityRuleArgs.builder()
    .computeClusterId("string")
    .virtualMachineIds("string")
    .enabled(false)
    .mandatory(false)
    .name("string")
    .build());
Copy
compute_cluster_vm_anti_affinity_rule_resource = vsphere.ComputeClusterVmAntiAffinityRule("computeClusterVmAntiAffinityRuleResource",
    compute_cluster_id="string",
    virtual_machine_ids=["string"],
    enabled=False,
    mandatory=False,
    name="string")
Copy
const computeClusterVmAntiAffinityRuleResource = new vsphere.ComputeClusterVmAntiAffinityRule("computeClusterVmAntiAffinityRuleResource", {
    computeClusterId: "string",
    virtualMachineIds: ["string"],
    enabled: false,
    mandatory: false,
    name: "string",
});
Copy
type: vsphere:ComputeClusterVmAntiAffinityRule
properties:
    computeClusterId: string
    enabled: false
    mandatory: false
    name: string
    virtualMachineIds:
        - string
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
VirtualMachineIds This property is required. 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
This property is required.
Changes to this property will trigger replacement.
string
The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
VirtualMachineIds This property is required. []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
This property is required.
Changes to this property will trigger replacement.
String
The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
virtualMachineIds This property is required. 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
This property is required.
Changes to this property will trigger replacement.
string
The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
virtualMachineIds This property is required. 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
This property is required.
Changes to this property will trigger replacement.
str
The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
virtual_machine_ids This property is required. 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
This property is required.
Changes to this property will trigger replacement.
String
The managed object reference ID of the cluster to put the group in. Forces a new resource if changed.
virtualMachineIds This property is required. 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 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:
ComputeClusterId Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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 Changes to this property will trigger replacement. 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.

Package Details

Repository
vSphere pulumi/pulumi-vsphere
License
Apache-2.0
Notes
This Pulumi package is based on the vsphere Terraform Provider.
vSphere v4.13.2 published on Wednesday, Apr 9, 2025 by Pulumi
pulumi/pulumi-vsphere