community.vmware.vmware_drs_group_manager module – Manage VMs and Hosts in DRS group.
Note
This module is part of the community.vmware collection (version 2.10.2).
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_drs_group_manager
.
New in community.vmware 1.7.0
Synopsis
The module can be used to add VMs / Hosts to or remove them from a DRS group.
Parameters
Parameter |
Comments |
---|---|
Cluster to which DRS group associated with. |
|
Name of the datacenter. |
|
The name of the group to manage. |
|
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. |
|
A List of hosts to add / remove in the group. Required only if vms is not set. |
|
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. |
|
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. Default: |
|
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 |
|
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 |
|
If set to If set to Choices:
|
|
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. |
|
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 Choices:
|
|
A List of vms to add / remove in the group. Required only if hosts is not set. |
Notes
Note
All modules requires API write access and hence is not supported on a free ESXi license.
Examples
---
- name: Add VMs in an existing DRS VM group
delegate_to: localhost
community.vmware.vmware_drs_group_manager:
hostname: "{{ vcenter_hostname }}"
password: "{{ vcenter_password }}"
username: "{{ vcenter_username }}"
cluster: DC0_C0
datacenter: DC0
group_name: TEST_VM_01
vms:
- DC0_C0_RP0_VM0
- DC0_C0_RP0_VM1
state: present
- name: Add Hosts in an existing DRS Host group
delegate_to: localhost
community.vmware.vmware_drs_group_manager:
hostname: "{{ vcenter_hostname }}"
password: "{{ vcenter_password }}"
username: "{{ vcenter_username }}"
cluster: DC0_C0
datacenter: DC0
group_name: TEST_HOST_01
hosts:
- DC0_C0_H0
- DC0_C0_H1
- DC0_C0_H2
state: present
- name: Remove VM from an existing DRS VM group
delegate_to: localhost
community.vmware.vmware_drs_group_manager:
hostname: "{{ vcenter_hostname }}"
password: "{{ vcenter_password }}"
username: "{{ vcenter_username }}"
cluster: DC0_C0
datacenter: DC0
group_name: TEST_VM_01
vms:
- DC0_C0_RP0_VM0
state: absent
- name: Remove host from an existing DRS Host group
delegate_to: localhost
community.vmware.vmware_drs_group_manager:
hostname: "{{ vcenter_hostname }}"
password: "{{ vcenter_password }}"
username: "{{ vcenter_username }}"
cluster: DC0_C0
datacenter: DC0
group_name: TEST_HOST_01
hosts:
- DC0_C0_H0
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Metadata about DRS group Returned: always Sample: |
|
Info message Returned: always Sample: |