ovirt_affinity_labels_facts - Retrieve facts about one or more oVirt affinity labels

New in version 2.3.

Synopsis

Retrieve facts about one or more oVirt affinity labels.

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.
    host
    		 no
      Name of the host, which affinity labels should be listed.
      name
      		 no
        Name of the affinity labels which should be listed.
        poll_interval
        		 no 3
          Number of the seconds the module waits until another poll request on entity status is sent.
          timeout
          		 no 180
            The amount of time in seconds the module should wait for the instance to get into desired state.
            vm
            		 no
              Name of the VM, which affinity labels should be listed.
              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:

# Gather facts about all affinity labels, which names start with C(label):
- ovirt_affinity_labels_facts:
    name: label*
- debug:
    var: affinity_labels

# Gather facts about all affinity labels, which are assigned to VMs
# which names start with C(postgres):
- ovirt_affinity_labels_facts:
    vm: postgres*
- debug:
    var: affinity_labels

# Gather facts about all affinity labels, which are assigned to hosts
# which names start with C(west):
- ovirt_affinity_labels_facts:
    host: west*
- debug:
    var: affinity_labels

# Gather facts about all affinity labels, which are assigned to hosts
# which names start with C(west) or VMs which names start with C(postgres):
- ovirt_affinity_labels_facts:
    host: west*
    vm: postgres*
- debug:
    var: affinity_labels

                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
                ovirt_vms List of dictionaries describing the affinity labels. Affinity labels attribues are mapped to dictionary keys, all affinity labels attributes can be found at following url: https://ovirt.example.com/ovirt-engine/api/model#types/affinity_label. On success. list


                Notes

                Note

                This module creates a new top-level affinity_labels fact, which contains a list of affinity labels.

                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.