community.general.ovirt_tag_facts – Retrieve information about one or more oVirt/RHV tags
community.general.ovirt_tag_facts – Retrieve information about one or more oVirt/RHV tags
Note
This plugin is part of the community.general collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.ovirt_tag_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_tag_info instead.
Synopsis
- Retrieve information about one or more oVirt/RHV tags.
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 |
---|---|---|
auth dictionary / required |
Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| |
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 |
host string |
Name of the host, which tags should be listed. | |
name string |
Name of the tag which should be listed. | |
nested_attributes list / elements=string |
Specifies list of the attributes which should be fetched from the API. This parameter apply only when | |
vm string |
Name of the VM, which tags should be listed. |
Notes
Note
- This module returns a variable
ovirt_tags
, which contains a list of tags. 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 tags, which names start with tag
ovirt_tag_info:
name: tag*
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_tags }}"
- name: Gather information about all tags, which are assigned to VM postgres
ovirt_tag_info:
vm: postgres
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_tags }}"
- name: Gather information about all tags, which are assigned to host west
ovirt_tag_info:
host: west
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_tags }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
ovirt_tags list / elements=string |
On success. |
List of dictionaries describing the tags. Tags attributes are mapped to dictionary keys, all tags attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/tag.
|
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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/ovirt_tag_facts_module.html