vmware_vm_vm_drs_rule - Configure VMware DRS Affinity rule for virtual machine in given cluster
New in version 2.5.
Synopsis
- This module can be used to configure VMware DRS Affinity rule for virtual machine in 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 |
| 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 required | Desired cluster name where virtual machines are present for the DRS rule. | |
drs_rule_name required | The name of the DRS rule to manage. | |
enabled |
| If set to True , the DRS rule will be enabled.Effective only if state is set to present . |
hostname | 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 supported added in version 2.6. | |
mandatory |
| If set to True , the DRS rule will be mandatory.Effective only if state is set to present . |
password | 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 supported added in version 2.6. aliases: pass, pwd | |
port (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 supported added in version 2.6. |
state |
| If set to present , then the DRS rule is created if not present.If set to present , then the DRS rule is deleted and created if present already.If set to absent , then the DRS rule is deleted if present. |
username | 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 supported added in version 2.6. aliases: user, admin | |
validate_certs |
True | 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 supported added in version 2.6. |
vms | List of virtual machines name for which DRS rule needs to be applied. Required if state is set to present . |
Notes
Note
- Tested on vSphere 6.5
Examples
- name: Create DRS Affinity Rule for VM-VM vmware_vm_vm_drs_rule: hostname: "{{ esxi }}" username: "{{ esxi_username }}" password: "{{ esxi_password }}" cluster_name: "{{ cluster_name }}" validate_certs: no vms: - vm1 - vm2 drs_rule_name: vm1-vm2-affinity-rule-001 enabled: True mandatory: True affinity_rule: True - name: Create DRS Anti-Affinity Rule for VM-VM vmware_vm_vm_drs_rule: hostname: "{{ esxi }}" username: "{{ esxi_username }}" password: "{{ esxi_password }}" cluster_name: "{{ cluster_name }}" validate_certs: no vms: - vm1 - vm2 drs_rule_name: vm1-vm2-affinity-rule-001 enabled: True mandatory: True affinity_rule: False - name: Delete DRS Affinity Rule for VM-VM vmware_vm_vm_drs_rule: hostname: "{{ esxi }}" username: "{{ esxi_username }}" password: "{{ esxi_password }}" cluster_name: "{{ cluster_name }}" validate_certs: no drs_rule_name: vm1-vm2-affinity-rule-001 state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
result dict | when state is present | metadata about DRS VM and VM rule Sample: {'rule_name': 'drs_rule_0014', 'rule_mandatory': True, 'rule_key': 20, 'rule_uuid': '525f3bc0-253f-825a-418e-2ec93bffc9ae', 'rule_enabled': False, 'rule_vms': ['VM_65', 'VM_146']} |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Author
- Abhijeet Kasurde (@akasurde)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/vmware_vm_vm_drs_rule_module.html