ovirt_affinity_labels - Module to affinity labels in oVirt

New in version 2.3.

Synopsis

This module manage affinity labels in oVirt. It can also manage assignments of those labels to hosts and 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 `admin@internal`.
    password[required] - The password of the user.
    url[required] - A string containing the base URL of the server, usually something like `https://server.example.com/ovirt-engine/api`.
    token - Token to be used instead of login with username/password.
    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.
    kerberos - A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
    cluster
    		 no
      Name of the cluster where vms and hosts resides.
      hosts
      		 no
        List of the hosts names, which should have assigned this affinity label.
        name
        		 yes
          Name of the the affinity label to manage.
          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 label 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.
              vms
              		 no
                List of the VMs names, which should have assigned this affinity label.
                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 label to vms vm1 and vm2 and host host1
- ovirt_affinity_labels:
    name: mylabel
    cluster: mycluster
    vms:
      - vm1
      - vm2
    hosts:
      - host1

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

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

                  Return Values

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

                  name description returned type sample
                  id ID of the affinity label which is managed On success if affinity label is found. str 7de90f31-222c-436c-a1ca-7e655bd5b60c
                  template Dictionary of all the affinity label attributes. Affinity label attributes can be found on your oVirt instance at following url: https://ovirt.example.com/ovirt-engine/api/model#types/affinity_label. On success if affinity label is found.


                  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

                  This is an Extras Module

                  For more information on what this means please read modules_extra

                  For help in developing on modules, should you be so inclined, please read community, developing_test_pr and developing_modules.