ovirt_affinity_group – Module to manage affinity groups in oVirt/RHV
ovirt_affinity_group – Module to manage affinity groups in oVirt/RHV
New in version 2.3.
Synopsis
- This module manage affinity groups in oVirt/RHV. It can also manage assignments of those groups to VMs.
Aliases: ovirt_affinity_groups
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth - / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| |
cluster - |
Name of the cluster of the affinity group. | |
description - |
Description of the affinity group. | |
fetch_nested boolean added in 2.3 |
|
If True the module will fetch additional data from the API. It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying |
host_enforcing boolean |
|
If yes VM cannot start on host if it does not satisfy the This parameter is support since oVirt/RHV 4.1 version. |
host_rule - |
|
If positive all VMs in this group should run on the this host. If negative no VMs in this group should run on the this host. This parameter is support since oVirt/RHV 4.1 version. |
hosts - |
List of the hosts names, which should have assigned this affinity group. This parameter is support since oVirt/RHV 4.1 version. | |
name - / required |
Name of the affinity group to manage. | |
nested_attributes - added in 2.3 |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
poll_interval - |
Default: 3 |
Number of the seconds the module waits until another poll request on entity status is sent. |
state - |
|
Should the affinity group be present or absent. |
timeout - |
Default: 180 |
The amount of time in seconds the module should wait for the instance to get into desired state. |
vm_enforcing boolean |
|
If yes VM cannot start if it does not satisfy the |
vm_rule - |
|
If positive all VMs in this group should run on the host defined by If negative no VMs in this group should run on the host defined by If disabled this affinity group doesn't take effect. |
vms - |
List of the VMs names, which should have assigned this affinity group. | |
wait boolean |
|
True if the module should wait for the entity to get into desired state. |
Notes
Note
- In order to use this module you have to install oVirt Python SDK. To ensure it’s installed with correct version you can create the following task: pip: name=ovirt-engine-sdk-python version=4.2.4
Examples
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
- name: Create(if not exists) and assign affinity group to VMs vm1 and vm2 and host host1
ovirt_affinity_group:
name: mygroup
cluster: mycluster
vm_enforcing: true
vm_rule: positive
host_enforcing: true
host_rule: positive
vms:
- vm1
- vm2
hosts:
- host1
- name: Detach VMs from affinity group and disable VM rule
ovirt_affinity_group:
name: mygroup
cluster: mycluster
vm_enforcing: false
vm_rule: disabled
host_enforcing: true
host_rule: positive
vms: []
hosts:
- host1
- host2
- name: Remove affinity group
ovirt_affinity_group:
state: absent
cluster: mycluster
name: mygroup
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
affinity_group string |
On success if affinity group is found. |
Dictionary of all the affinity group attributes. Affinity group attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/affinity_group.
|
id string |
On success if affinity group is found. |
ID of the affinity group which is managed
Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Ondra Machacek (@machacekondra)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ovirt_affinity_group_module.html