community.general.ovirt_storage_template_facts – Retrieve information about one or more oVirt/RHV templates relate to a storage domain.

Note

This plugin is part of the community.general collection (version 1.3.6).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.ovirt_storage_template_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_storage_template_info instead.

Synopsis

  • Retrieve information about one or more oVirt/RHV templates relate to a storage domain.

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:
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- A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by OVIRT_URL environment variable. Either url or hostname is required.
hostname - A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by OVIRT_HOSTNAME environment variable. Either url or hostname is required.
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
boolean
    Choices:
  • no ←
  • yes
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.
max
string
Sets the maximum number of templates to return. If not specified all the templates are returned.
nested_attributes
list / elements=string
Specifies list of the attributes which should be fetched from the API.
This parameter apply only when fetch_nested is true.
storage_domain
string
The storage domain name where the templates should be listed.
unregistered
boolean
    Choices:
  • no ←
  • yes
Flag which indicates whether to get unregistered templates which contain one or more disks which reside on a storage domain or diskless templates.

Notes

Note

  • This module returns a variable ovirt_storage_templates, which contains a list of templates. 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 templates which relate to a storage domain and are unregistered
  ovirt_storage_template_info:
    unregistered: yes
  register: result

- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_storage_templates }}"

Return Values

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

Key Returned Description
ovirt_storage_templates
list / elements=string
On success.
List of dictionaries describing the Templates. Template attributes are mapped to dictionary keys, all Templates attributes can be found at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/template.


Status

  • This module will be removed in version 3.0.0. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Maor Lipchuk (@machacekondra)