community.vmware.vmware_vm_host_drs_rule module – Creates vm/host group in a given cluster

Note

This module is part of the community.vmware collection (version 5.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_vm_host_drs_rule.

Synopsis

  • This module can be used to create VM-Host rules in a given cluster.

Parameters

Parameter

Comments

affinity_rule

boolean

If set to true, the DRS rule will be an Affinity rule.

If set to false, the DRS rule will be an Anti-Affinity rule.

Effective only if state=present.

Choices:

  • false

  • true ← (default)

cluster_name

string / required

Cluster to create VM-Host rule.

datacenter

aliases: datacenter_name

string

Datacenter to search for given cluster. If not set, we use first cluster we encounter with cluster_name.

drs_rule_name

string / required

Name of rule to create or remove.

enabled

boolean

If set to true, the DRS rule will be enabled.

Effective only if state=present.

Choices:

  • false ← (default)

  • true

host_group_name

string

Name of Host group to use with rule.

Effective only if state=present.

hostname

string

The hostname or IP address of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

mandatory

boolean

If set to true, the DRS rule will be mandatory.

Effective only if state=present.

Choices:

  • false ← (default)

  • true

password

aliases: pass, pwd

string

The password of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

port

integer

The port number of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

proxy_host

string

Address of a proxy that will receive all HTTPS requests and relay them.

The format is a hostname or a IP.

If the value is not specified in the task, the value of environment variable VMWARE_PROXY_HOST will be used instead.

proxy_port

integer

Port of the HTTP proxy that will receive all HTTPS requests and relay them.

If the value is not specified in the task, the value of environment variable VMWARE_PROXY_PORT will be used instead.

state

string

If set to present and the rule does not exist then the rule will be created.

If set to absent and the rule exists then the rule will be deleted.

Choices:

  • "present" ← (default)

  • "absent"

username

aliases: admin, user

string

The username of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

vm_group_name

string

Name of VM group to use with rule.

Effective only if state=present.

Notes

Note

  • All modules requires API write access and hence is not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

Examples

---
- name: "Create mandatory DRS Affinity rule for VM/Host"
  community.vmware.vmware_vm_host_drs_rule:
    hostname: "{{ vcenter_hostname }}"
    password: "{{ vcenter_password }}"
    username: "{{ vcenter_username }}"
    cluster_name: DC0_C0
    drs_rule_name: drs_rule_host_aff_0001
    host_group_name: DC0_C0_HOST_GR1
    vm_group_name: DC0_C0_VM_GR1
    mandatory: true
    enabled: true
    affinity_rule: true

Authors

  • Karsten Kaj Jakobsen (@karstenjakobsen)