community.general.ovirt_host_facts – Retrieve information about one or more oVirt/RHV hosts
community.general.ovirt_host_facts – Retrieve information about one or more oVirt/RHV hosts
Note
This plugin is part of the community.general collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.ovirt_host_facts
.
DEPRECATED
- Removed in
- version 3.0.0
- Why
- When migrating to collection we decided to use only _info modules.
- Alternative
- Use ovirt.ovirt.ovirt_host_info instead.
Synopsis
- Retrieve information about one or more oVirt/RHV hosts.
Requirements
The below requirements are needed on the host that executes this module.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
all_content boolean |
|
If true all the attributes of the hosts should be included in the response. |
auth dictionary / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| |
cluster_version string |
Filter the hosts based on the cluster version. | |
fetch_nested boolean |
|
If yes the module will fetch additional data from the API. It will fetch only IDs of nested entity. It doesn't fetch multiple levels of nested attributes. Only the attributes of the current entity. User can configure to fetch other attributes of the nested entities by specifying |
nested_attributes list / elements=string |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
pattern string |
Search term which is accepted by oVirt/RHV search backend. For example to search host X from datacenter Y use following pattern: name=X and datacenter=Y |
Notes
Note
- This module returns a variable
ovirt_hosts
, which contains a list of hosts. 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: ansible.builtin.pip: name=ovirt-engine-sdk-python version=4.3.0
Examples
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
- name: Gather information about all hosts which names start with host and belong to data center west
ovirt_host_info:
pattern: name=host* and datacenter=west
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_hosts }}"
- name: Gather information about all hosts with cluster version 4.2
ovirt_host_info:
pattern: name=host*
cluster_version: "4.2"
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_hosts }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_hosts list / elements=string |
On success. |
List of dictionaries describing the hosts. Host attributes are mapped to dictionary keys, all hosts attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/host.
|
Status
- This module will be removed in version 3.0.0. [deprecated]
- For more information see DEPRECATED.
Authors
- Ondra Machacek (@machacekondra)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/ovirt_host_facts_module.html