Documentation

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

Requirements (on host that executes module)

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

Options

parameter required default choices comments
auth
yes
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 `https://server.example.com/ovirt-engine/api`. 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.
cluster
no
Name of the cluster of the affinity group.
description
no
Description of the affinity group.
fetch_nested
(added in 2.3)
no
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
no
If true 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
no
  • positive
  • negative
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
no
List of the hosts names, which should have assigned this affinity group.
This parameter is support since oVirt/RHV 4.1 version.
name
yes
Name of the affinity group to manage.
nested_attributes
(added in 2.3)
no
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
poll_interval
no 3
Number of the seconds the module waits until another poll request on entity status is sent.
state
no present
  • present
  • absent
Should the affinity group be present or absent.
timeout
no 180
The amount of time in seconds the module should wait for the instance to get into desired state.
vm_enforcing
no
If true VM cannot start if it does not satisfy the vm_rule.
vm_rule
no
  • positive
  • negative
  • disabled
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
no
List of the VMs names, which should have assigned this affinity group.
wait
no
True if the module should wait for the entity to get into desired state.

Examples

# 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 group to VMs vm1 and vm2 and host host1
- ovirt_affinity_groups:
    name: mygroup
    cluster: mycluster
    vm_enforcing: true
    vm_rule: positive
    host_enforcing: true
    host_rule: positive
    vms:
      - vm1
      - vm2
    hosts:
      - host1

# Detach VMs from affinity group and disable VM rule:
- ovirt_affinity_groups:
    name: mygroup
    cluster: mycluster
    vm_enforcing: false
    vm_rule: disabled
    host_enforcing: true
    host_rule: positive
    vms: []
    hosts:
      - host1
      - host2

# Remove affinity group
- ovirt_affinity_groups:
    state: absent
    cluster: mycluster
    name: mygroup

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 ID of the affinity group which is managed On success if affinity group is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c
affinity_group 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. On success if affinity group is found. str


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

Status

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

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

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