community.general.ovirt_tag_facts – Получение информации об одном или нескольких тегах oVirt/RHV
Примечание
Этот плагин является частью коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general
Чтобы использовать его в плейбуке, укажите: community.general.ovirt_tag_facts
УСТАРЕЛО
- Удалено в
-
версии 3.0.0
- Почему
-
При миграции в коллекцию мы решили использовать только модули _info.
- Альтернатива
-
Используйте ovirt.ovirt.ovirt_tag_info вместо этого.
Описание
- Получение информации об одном или нескольких тегах oVirt/RHV.
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| auth словарь / обязательный | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательно] - Имя пользователя, например admin@internal. Значение по умолчанию устанавливается переменной среды OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию устанавливается переменной среды OVIRT_PASSWORD.url- Строка, содержащая URL API сервера, обычно `https://server.example.com/ovirt-engine/api`. Значение по умолчанию устанавливается переменной среды OVIRT_URL. Требуется либо url, либо hostname.hostname - Строка, содержащая имя хоста сервера, обычно `server.example.com`. Значение по умолчанию устанавливается переменной среды OVIRT_HOSTNAME. Требуется либо url, либо hostname.token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию устанавливается переменной среды OVIRT_TOKEN.insecure - Флаг, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста.ca_file - PEM-файл, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр `ca_file` не задан, используется системный хранилище сертификатов CA. Значение по умолчанию устанавливается переменной среды OVIRT_CAFILE.kerberos - Флаг, указывающий, нужно ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые нужно добавить к каждому вызову API. | |
| fetch_nested булево |
| Если да, модуль будет получать дополнительные данные из API. Будет получены только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. |
| host строка | Имя хоста, для которого нужно получить список тегов. | |
| name строка | Имя тега, который нужно получить. | |
| nested_attributes список / элементы=строка | Указывает список атрибутов, которые нужно получить из API. Этот параметр применяется только когда fetch_nested равен true. | |
| vm строка | Имя ВМ, для которой нужно получить список тегов. |
Примечания
Примечание
- Этот модуль возвращает переменную
ovirt_tags, которая содержит список тегов. Вам необходимо зарегистрировать результат с помощью ключевого слова register, чтобы использовать его. - Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: ansible.builtin.pip: name=ovirt-engine-sdk-python version=4.3.0
Примеры
# 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 }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_tags список / элементы=строка | При успехе. | Список словарей, описывающих теги. Атрибуты тегов сопоставлены с ключами словарей, все атрибуты тегов можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/tag. |
Статус
- Этот модуль будет удален в версии 3.0.0. [устарело]
- Для получения дополнительной информации см. УСТАРЕЛО.
Авторы
- 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