community / community.vmware / 4.2.0 / module / vmware_drs_group Creates vm/host group in a given cluster. Authors: Karsten Kaj Jakobsen (@karstenjakobsen)community.vmware.vmware_drs_group (4.2.0) — module
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections: - name: community.vmware version: 4.2.0
This module can be used to create VM/Host groups in a given cluster. Creates a vm group if O(vms) is set. Creates a host group if O(hosts) is set.
--- - name: "Create DRS VM group" delegate_to: localhost community.vmware.vmware_drs_group: hostname: "{{ vcenter_hostname }}" password: "{{ vcenter_password }}" username: "{{ vcenter_username }}" cluster_name: DC0_C0 datacenter_name: DC0 group_name: TEST_VM_01 vms: - DC0_C0_RP0_VM0 - DC0_C0_RP0_VM1 state: present
- name: "Create DRS Host group" delegate_to: localhost community.vmware.vmware_drs_group: hostname: "{{ vcenter_hostname }}" password: "{{ vcenter_password }}" username: "{{ vcenter_username }}" cluster_name: DC0_C0 datacenter_name: DC0 group_name: TEST_HOST_01 hosts: - DC0_C0_H0 - DC0_C0_H1 - DC0_C0_H2 state: present
- name: "Delete DRS Host group" delegate_to: localhost community.vmware.vmware_drs_group: hostname: "{{ vcenter_hostname }}" password: "{{ vcenter_password }}" username: "{{ vcenter_username }}" cluster_name: DC0_C0 datacenter_name: DC0 group_name: TEST_HOST_01 state: absent
vms: description: - List of vms to create in group. - Required if O(hosts) is not set. - O(hosts) and O(vms) are mutually exclusive parameters. elements: str required: false type: list port: default: 443 description: - The port number of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PORT) will be used instead. type: int hosts: description: - List of hosts to create in group. - Required if O(vms) is not set. - O(hosts) and O(vms) are mutually exclusive parameters. elements: str required: false type: list state: choices: - present - absent default: present description: - If set to V(present) and the group doesn't exists then the group will be created. - If set to V(absent) and the group exists then the group will be deleted. type: str hostname: description: - 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 E(VMWARE_HOST) will be used instead. type: str password: aliases: - pass - pwd description: - The password of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD) will be used instead. type: str username: aliases: - admin - user description: - The username of the vSphere vCenter or ESXi server. - If the value is not specified in the task, the value of environment variable E(VMWARE_USER) will be used instead. type: str datacenter: aliases: - datacenter_name description: - Datacenter to search for given cluster. If not set, we use first cluster we encounter with O(cluster_name). required: false type: str group_name: description: - The name of the group to create or remove. required: true type: str proxy_host: description: - 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 E(VMWARE_PROXY_HOST) will be used instead. required: false type: str proxy_port: description: - 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 E(VMWARE_PROXY_PORT) will be used instead. required: false type: int cluster_name: description: - Cluster to create vm/host group. required: true type: str validate_certs: default: true description: - Allows connection when SSL certificates are not valid. Set to V(false) when certificates are not trusted. - If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS) will be used instead. type: bool
drs_group_facts: description: Metadata about DRS group created returned: always sample: drs_group_facts: changed: true failed: false msg: Created host group TEST_HOST_01 successfully result: DC0_C0: - group_name: TEST_HOST_01 hosts: - DC0_C0_H0 - DC0_C0_H1 - DC0_C0_H2 type: host type: dict