community.vmware.vmware_vm_host_drs_rule – Creates vm/host group in a given cluster
community.vmware.vmware_vm_host_drs_rule – Creates vm/host group in a given cluster
Note
This plugin is part of the community.vmware collection (version 1.6.0).
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.
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 |
|
If set to If set to Effective only if |
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
| |
drs_rule_name string / required |
Name of rule to create or remove. | |
enabled boolean |
|
If set to Effective only if |
host_group_name string |
Name of Host group to use with rule. Effective only if | |
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 Environment variable support added in Ansible 2.6. | |
mandatory boolean |
|
If set to Effective only if |
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 Environment variable support added in Ansible 2.6.
| |
port integer |
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 Environment variable support added in Ansible 2.6. |
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 | |
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 | |
state string |
|
If set to If set to |
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 Environment variable support added in Ansible 2.6.
| |
validate_certs boolean |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to |
vm_group_name string |
Name of VM group to use with rule. Effective only if |
Notes
Note
- Tested on vSphere 6.5 and 6.7
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/vmware/vmware_vm_host_drs_rule_module.html