Deprecated

Removed in 3.0.0

i

Reason:When migrating to collection we decided to use only _info modules. | Alternative:Use M(ovirt.ovirt.ovirt_tag_info) instead.

community.general.ovirt_tag_facts (2.5.9) — module

Retrieve information about one or more oVirt/RHV tags

Authors: Ondra Machacek (@machacekondra)

Install collection

Install with ansible-galaxy collection install community.general:==2.5.9


Add to requirements.yml

  collections:
    - name: community.general
      version: 2.5.9

Description

Retrieve information about one or more oVirt/RHV tags.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_tags }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather information about all tags, which are assigned to VM postgres
  ovirt_tag_info:
    vm: postgres
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_tags }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Gather information about all tags, which are assigned to host west
  ovirt_tag_info:
    host: west
  register: result
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Print gathered information
  ansible.builtin.debug:
    msg: "{{ result.ovirt_tags }}"

Inputs

    
vm:
    description:
    - Name of the VM, which tags should be listed.

auth:
    description:
    - 'Dictionary with values needed to create HTTP/HTTPS connection to oVirt:'
    - C(username)[I(required)] - The name of the user, something like I(admin@internal).
      Default value is set by I(OVIRT_USERNAME) environment variable.
    - C(password)[I(required)] - The password of the user. Default value is set by I(OVIRT_PASSWORD)
      environment variable.
    - C(url)- A string containing the API URL of the server, usually something like `I(https://server.example.com/ovirt-engine/api)`.
      Default value is set by I(OVIRT_URL) environment variable. Either C(url) or C(hostname)
      is required.
    - C(hostname) - A string containing the hostname of the server, usually something
      like `I(server.example.com)`. Default value is set by I(OVIRT_HOSTNAME) environment
      variable. Either C(url) or C(hostname) is required.
    - C(token) - Token to be used instead of login with username/password. Default value
      is set by I(OVIRT_TOKEN) environment variable.
    - C(insecure) - A boolean flag that indicates if the server TLS certificate and host
      name should be checked.
    - C(ca_file) - A PEM file containing the trusted CA certificates. The certificate
      presented by the server will be verified using these CA certificates. If `C(ca_file)`
      parameter is not set, system wide CA certificate store is used. Default value is
      set by I(OVIRT_CAFILE) environment variable.
    - C(kerberos) - A boolean flag indicating if Kerberos authentication should be used
      instead of the default basic authentication.
    - C(headers) - Dictionary of HTTP headers to be added to each API call.
    required: true
    type: dict

host:
    description:
    - Name of the host, which tags should be listed.

name:
    description:
    - Name of the tag which should be listed.

fetch_nested:
    default: false
    description:
    - If I(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 C(nested_attributes).
    type: bool

nested_attributes:
    description:
    - Specifies list of the attributes which should be fetched from the API.
    - This parameter apply only when C(fetch_nested) is I(true).
    type: list

Outputs

ovirt_tags:
  description: '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.'
  returned: On success.
  type: list