# ovirt_affinity_group – Module to manage affinity groups in oVirt/RHV

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- This module manage affinity groups in oVirt/RHV. It can also manage assignments of those groups to VMs.

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
auth dictionary / required |  | Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| ca_file string |  | 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.
| headers dictionary |  | Dictionary of HTTP headers to be added to each API call.
| hostname string |  | A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by `OVIRT_HOSTNAME` environment variable. Either `url` or `hostname` is required.

insecure
boolean

Choices:
- no
- yes

A boolean flag that indicates if the server TLS certificate and host name should be checked.

kerberos
boolean

Choices:
- no
- yes

A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.

| password string / required |  | The password of the user. Default value is set by `OVIRT_PASSWORD` environment variable.
| token string |  | Token to be used instead of login with username/password. Default value is set by `OVIRT_TOKEN` environment variable.
| url string |  | A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by `OVIRT_URL` environment variable. Either `url` or `hostname` is required.
| username string / required |  | The name of the user, something like admin@internal. Default value is set by `OVIRT_USERNAME` environment variable.
cluster - |  | Name of the cluster of the affinity group.
description - |  | Description of the affinity group.

fetch_nested
boolean

Choices:
- no
- yes

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`.

host_enforcing
boolean

Choices:
- no
- yes

If yes VM cannot start on host if it does not satisfy the `host_rule`.
This parameter is support since oVirt/RHV 4.1 version.

host_rule
-

Choices:
- negative
- positive

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 list |  | Specifies list of the attributes which should be fetched from the API. This parameter apply only when `fetch_nested` is true.
poll_interval integer | Default: 3 | Number of the seconds the module waits until another poll request on entity status is sent.

state
-

Choices:
- absent
- present ←

Should the affinity group be present or absent.

timeout integer | Default: 180 | The amount of time in seconds the module should wait for the instance to get into desired state.

vm_enforcing
boolean

Choices:
- no
- yes

If yes VM cannot start if it does not satisfy the `vm_rule`.

vm_rule
-

Choices:
- disabled
- negative
- positive

If positive all VMs in this group should run on the host defined by `host_rule`.
If negative no VMs in this group should run on the host defined by `host_rule`.
If disabled this affinity group doesn't take effect.

vms - |  | List of the VMs names, which should have assigned this affinity group.

wait
boolean

Choices:
- no
- yes ←

`yes` 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.3.0

## 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)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.