vmware_vm_host_drs_rule – Creates vm/host group in a given cluster — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# vmware_vm_host_drs_rule – Creates vm/host group in a given cluster

New in version 2.8.

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Status

## Synopsis

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

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.6

- PyVmomi

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
affinity_rule boolean | Choices: no yes ← | 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` is set to `present`.
cluster_name string / required |  | Cluster to create VM-Host rule.
datacenter string |  | Datacenter to search for given cluster. If not set, we use first cluster we encounter with `cluster_name`. aliases: datacenter_name
drs_rule_name string / required |  | Name of rule to create or remove.
enabled boolean | Choices: no ← yes | If set to `True`, the DRS rule will be enabled. Effective only if `state` is set to `present`.
host_group_name string / required |  | Name of Host group to use with rule. Effective only if `state` is set to `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. Environment variable support added in Ansible 2.6.
mandatory boolean | Choices: no ← yes | If set to `True`, the DRS rule will be mandatory. Effective only if `state` is set to `present`.
password 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. Environment variable support added in Ansible 2.6. aliases: pass, pwd
port integer added in 2.5 | Default: 443 | 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. Environment variable support added in Ansible 2.6.
proxy_host string added in 2.9 |  | 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. This feature depends on a version of pyvmomi greater than v6.7.1.2018.12
proxy_port integer added in 2.9 |  | 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 / required | Choices: present ← absent | If set to `present` and the rule doesn't exists then the rule will be created. If set to `absent` and the rule exists then the rule will be deleted.
username 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. Environment variable support added in Ansible 2.6. aliases: admin, user
validate_certs boolean | Choices: no yes ← | 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. Environment variable support added in Ansible 2.6. If set to `yes`, please make sure Python >= 2.7.9 is installed on the given machine.
vm_group_name string / required |  | Name of VM group to use with rule. Effective only if `state` is set to `present`.

## Notes

Note

- Tested on vSphere 6.5 and 6.7

## Examples

    ---
    - name: "Create mandatory DRS Affinity rule for VM/Host"
      vmware_vm_host_drs_rule:
        hostname: "{{ vcenter_hostname }}"
        password: "{{ vcenter_password }}"
        username: "{{ vcenter_username }}"
        validate_certs: False
        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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Karsten Kaj Jakobsen (@karstenjakobsen)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.