ovirt_affinity_label - Module to manage affinity labels in oVirt/RHV

New in version 2.3.


  • This module manage affinity labels in oVirt/RHV. It can also manage assignments of those labels to hosts and VMs.

Aliases: ovirt_affinity_labels

Requirements (on host that executes module)

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.0.0


parameter required default choices comments
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
username[required] - The name of the user, something like [email protected]. Default value is set by OVIRT_USERNAME environment variable.
password[required] - The password of the user. Default value is set by OVIRT_PASSWORD environment variable.
url[required] - A string containing the base URL of the server, usually something like ``. Default value is set by OVIRT_URL environment variable.
token - Token to be used instead of login with username/password. Default value is set by OVIRT_TOKEN environment variable.
insecure - A boolean flag that indicates if the server TLS certificate and host name should be checked.
ca_file - A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If `ca_file` parameter is not set, system wide CA certificate store is used. Default value is set by OVIRT_CAFILE environment variable.
kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
headers - Dictionary of HTTP headers to be added to each API call.
Name of the cluster where vms and hosts resides.
(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 nested_attributes.
List of the hosts names, which should have assigned this affinity label.
Name of the affinity label to manage.
(added in 2.3)
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
no 3
Number of the seconds the module waits until another poll request on entity status is sent.
no present
  • present
  • absent
Should the affinity label be present or absent.
no 180
The amount of time in seconds the module should wait for the instance to get into desired state.
List of the VMs names, which should have assigned this affinity label.
True if the module should wait for the entity to get into desired state.


# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Create(if not exists) and assign affinity label to vms vm1 and vm2 and host host1
- ovirt_affinity_label:
    name: mylabel
    cluster: mycluster
      - vm1
      - vm2
      - host1

# To detach all VMs from label
- ovirt_affinity_label:
    name: mylabel
    cluster: mycluster
    vms: []

# Remove affinity label
- ovirt_affinity_label:
    state: absent
    name: mylabel

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
ID of the affinity label which is managed
On success if affinity label is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c
Dictionary of all the affinity label attributes. Affinity label attributes can be found on your oVirt/RHV instance at following url:
On success if affinity label is found. dict



  • 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.0.0


This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.