W3cubDocs

/Ansible

ovirt_cluster_facts - Retrieve facts about one or more oVirt/RHV clusters

New in version 2.3.

Synopsis

  • Retrieve facts about one or more oVirt/RHV clusters.

Aliases: ovirt_clusters_facts

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. 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.
headers - Dictionary of HTTP headers to be added to each API call.
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.
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.
pattern
 no
Search term which is accepted by oVirt/RHV search backend.
For example to search cluster X from datacenter Y use following pattern: name=X and datacenter=Y

Examples

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

# Gather facts about all clusters which names start with C<production>:
- ovirt_cluster_facts:
    pattern:
      name: 'production*'
- debug:
    var: ovirt_clusters

Return Values

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

name description returned type sample
ovirt_clusters
List of dictionaries describing the clusters. Cluster attribues are mapped to dictionary keys, all clusters attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/cluster.
 On success. list

Notes

Note

  • This module creates a new top-level ovirt_clusters fact, which contains a list of clusters.
  • 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.

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

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ovirt_cluster_facts_module.html