ovirt.ovirt.ovirt_cluster_info – Retrieve information about one or more oVirt/RHV clusters¶
Note
This plugin is part of the ovirt.ovirt collection (version 1.3.0).
To install it use: ansible-galaxy collection install ovirt.ovirt
.
To use it in a playbook, specify: ovirt.ovirt.ovirt_cluster_info
.
New in version 1.0.0: of ovirt.ovirt
Synopsis¶
Retrieve information about one or more oVirt/RHV clusters.
This module was called
ovirt_cluster_facts
before Ansible 2.9, returningansible_facts
. Note that the ovirt.ovirt.ovirt_cluster_info module no longer returnsansible_facts
!
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 2.7
ovirt-engine-sdk-python >= 4.4.0
Parameters¶
Notes¶
Note
This module returns a variable
ovirt_clusters
, which contains a list of clusters. You need to register the result with the register keyword to use it.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.4.0
Examples¶
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Gather information about all clusters which names start with C<production>:
- ovirt.ovirt.ovirt_cluster_info:
pattern:
name: 'production*'
register: result
- ansible.builtin.debug:
msg: "{{ result.ovirt_clusters }}"
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Ondra Machacek (@machacekondra)
Martin Necas (@mnecas)