Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

ComputeClusterVmHostRule

Create a ComputeClusterVmHostRule Resource

new ComputeClusterVmHostRule(name: string, args: ComputeClusterVmHostRuleArgs, opts?: CustomResourceOptions);
def ComputeClusterVmHostRule(resource_name: str, opts: Optional[ResourceOptions] = None, affinity_host_group_name: Optional[str] = None, anti_affinity_host_group_name: Optional[str] = None, compute_cluster_id: Optional[str] = None, enabled: Optional[bool] = None, mandatory: Optional[bool] = None, name: Optional[str] = None, vm_group_name: Optional[str] = None)
func NewComputeClusterVmHostRule(ctx *Context, name string, args ComputeClusterVmHostRuleArgs, opts ...ResourceOption) (*ComputeClusterVmHostRule, error)
public ComputeClusterVmHostRule(string name, ComputeClusterVmHostRuleArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args ComputeClusterVmHostRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ComputeClusterVmHostRuleArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ComputeClusterVmHostRuleArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

ComputeClusterVmHostRule Resource Properties

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

Inputs

The ComputeClusterVmHostRule 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.

VmGroupName string

The name of the virtual machine group to use with this rule.

AffinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will be run on the hosts defined in this host group.

AntiAffinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.

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.

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.

VmGroupName string

The name of the virtual machine group to use with this rule.

AffinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will be run on the hosts defined in this host group.

AntiAffinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.

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.

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.

vmGroupName string

The name of the virtual machine group to use with this rule.

affinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will be run on the hosts defined in this host group.

antiAffinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.

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.

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.

vm_group_name str

The name of the virtual machine group to use with this rule.

affinity_host_group_name str

When this field is used, the virtual machines defined in vm_group_name will be run on the hosts defined in this host group.

anti_affinity_host_group_name str

When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.

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.

name str

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

Outputs

All input properties are implicitly available as output properties. Additionally, the ComputeClusterVmHostRule 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing ComputeClusterVmHostRule Resource

Get an existing ComputeClusterVmHostRule 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?: ComputeClusterVmHostRuleState, opts?: CustomResourceOptions): ComputeClusterVmHostRule
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, affinity_host_group_name: Optional[str] = None, anti_affinity_host_group_name: Optional[str] = None, compute_cluster_id: Optional[str] = None, enabled: Optional[bool] = None, mandatory: Optional[bool] = None, name: Optional[str] = None, vm_group_name: Optional[str] = None) -> ComputeClusterVmHostRule
func GetComputeClusterVmHostRule(ctx *Context, name string, id IDInput, state *ComputeClusterVmHostRuleState, opts ...ResourceOption) (*ComputeClusterVmHostRule, error)
public static ComputeClusterVmHostRule Get(string name, Input<string> id, ComputeClusterVmHostRuleState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

AffinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will be run on the hosts defined in this host group.

AntiAffinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.

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.

Name string

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

VmGroupName string

The name of the virtual machine group to use with this rule.

AffinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will be run on the hosts defined in this host group.

AntiAffinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.

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.

Name string

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

VmGroupName string

The name of the virtual machine group to use with this rule.

affinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will be run on the hosts defined in this host group.

antiAffinityHostGroupName string

When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.

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.

name string

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

vmGroupName string

The name of the virtual machine group to use with this rule.

affinity_host_group_name str

When this field is used, the virtual machines defined in vm_group_name will be run on the hosts defined in this host group.

anti_affinity_host_group_name str

When this field is used, the virtual machines defined in vm_group_name will not be run on the hosts defined in this host group.

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.

name str

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

vm_group_name str

The name of the virtual machine group to use with this rule.

Package Details

Repository
https://github.com/pulumi/pulumi-vsphere
License
Apache-2.0
Notes
This Pulumi package is based on the vsphere Terraform Provider.