ovirt.ovirt.ovirt_tag_info – Получение информации об одном или нескольких тегах oVirt/RHV

Примечание

Этот плагин входит в состав коллекции ovirt.ovirt (версия 1.3.0).

Для его установки используйте: ansible-galaxy collection install ovirt.ovirt

Для использования в книге задач укажите: ovirt.ovirt.ovirt_tag_info

Новое в версии 1.0.0: of ovirt.ovirt

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Получение информации об одном или нескольких тегах oVirt/RHV.
Этот модуль назывался ovirt_tag_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль ovirt.ovirt.ovirt_tag_info больше не возвращает ansible_facts!

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 2.7
ovirt-engine-sdk-python >= 4.4.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
auth словарь / обязательно			Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt:
	ca_file строка		Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр `ca_file` не задан, используется системный хранилище сертификатов CA. Значение по умолчанию задано переменной среды `OVIRT_CAFILE`.
	headers словарь		Словарь HTTP-заголовков, которые должны быть добавлены к каждому API-запросу.
	hostname строка		Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задано переменной среды `OVIRT_HOSTNAME`. Требуется либо `url`, либо `hostname`.
	insecure логическое	Варианты: нет да	Флаг логического типа, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.
	kerberos логическое	Варианты: нет да	Флаг логического типа, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.
	password строка / обязательно		Пароль пользователя. Значение по умолчанию задано переменной среды `OVIRT_PASSWORD`.
	token строка		Токен для использования вместо входа с именем пользователя/паролем. Значение по умолчанию задано переменной среды `OVIRT_TOKEN`.
	url строка		Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задано переменной среды `OVIRT_URL`. Требуется либо `url`, либо `hostname`.
	username строка / обязательно		Имя пользователя, например, admin@internal. Значение по умолчанию задано переменной среды `OVIRT_USERNAME`.
fetch_nested логическое		Варианты: нет да	Если да, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенной сущности. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить загрузку других атрибутов вложенных сущностей, указав `nested_attributes`.
host строка			Имя хоста, для которого должны быть перечислены теги.
name строка			Имя тега, который должен быть перечислен.
nested_attributes список / элементы=строка			Указывает список атрибутов, которые должны быть получены из API. Этот параметр применим только тогда, когда `fetch_nested` равен true.
vm строка			Имя виртуальной машины, для которой должны быть перечислены теги.

Примечания

Примечание

Этот модуль возвращает переменную ovirt_tags, которая содержит список тегов. Вам нужно зарегистрировать результат с помощью ключевого слова register, чтобы использовать его.
Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.4.0

Примеры

# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:

# Gather information about all tags, which names start with C(tag):
- ovirt.ovirt.ovirt_tag_info:
    name: tag*
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_tags }}"

# Gather information about all tags, which are assigned to VM C(postgres):
- ovirt.ovirt.ovirt_tag_info:
    vm: postgres
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_tags }}"

# Gather information about all tags, which are assigned to host C(west):
- ovirt.ovirt.ovirt_tag_info:
    host: west
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_tags }}"

Возвращаемые значения

Общие возвращаемые значения описаны в здесь, следующие являются полями, уникальными для этого модуля:

Ключ	Возвращаемое значение	Описание
ovirt_tags список / элементы=строка	При успешном выполнении.	Список словарей, описывающих теги. Атрибуты тегов сопоставляются с ключами словаря, все атрибуты тегов можно найти по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/tag.

Авторы

Ondra Machacek (@machacekondra)
Martin Necas (@mnecas)

© 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/ovirt/ovirt/ovirt_tag_info_module.html