Модуль ovirt.ovirt.ovirt_affinity_label_info — Получение информации об одном или нескольких метках сродства oVirt/RHV

Примечание

Этот модуль является частью коллекции ovirt.ovirt (версия 3.2.0).

Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.

Для её установки используйте: ansible-galaxy collection install ovirt.ovirt. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Для использования в playbook укажите: ovirt.ovirt.ovirt_affinity_label_info.

Новинка в ovirt.ovirt 1.0.0

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

Описание

Получение информации об одном или нескольких метках сродства oVirt/RHV.
Этот модуль назывался ovirt_affinity_label_facts до Ansible 2.9, возвращая ansible_facts. Обратите внимание, что модуль ovirt.ovirt.ovirt_affinity_label_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`.
compress булево	Флаг, указывающий, используется ли сжатие для подключения. Варианты: `false` `true` ← (по умолчанию)
headers словарь	Словарь HTTP-заголовков, которые будут добавлены к каждому API-запросу.
hostname строка	Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию установлено переменной окружения `OVIRT_HOSTNAME`. Требуется либо `url`, либо `hostname`.
insecure булево	Флаг булевого типа, указывающий, следует ли проверять сертификат TLS сервера и имя хоста. Варианты: `false` ← (по умолчанию) `true`
kerberos булево	Флаг булевого типа, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации. Варианты: `false` `true`
password строка	Пароль пользователя. Значение по умолчанию установлено переменной окружения `OVIRT_PASSWORD`.
timeout целое число	Количество секунд ожидания ответа.
token строка	Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию установлено переменной окружения `OVIRT_TOKEN`.
url строка	Строка, содержащая API-URL сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию установлено переменной окружения `OVIRT_URL`. Требуется либо `url`, либо `hostname`.
username строка	Имя пользователя, например admin@internal. Значение по умолчанию установлено переменной окружения `OVIRT_USERNAME`.
fetch_nested булево	Если да, модуль извлечёт дополнительные данные из API. Он извлечёт только идентификаторы вложенных сущностей. Он не извлекает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав `nested_attributes`. Этот параметр устарел и заменён на `follow`. Варианты: `false` ← (по умолчанию) `true`
follow псевдонимы: follows список / элементы=строка добавлен в ovirt.ovirt 1.5.0	Список связанных сущностей, которые должны быть извлечены вместе с основной сущностью. Этот параметр заменяет использование `fetch_nested` и `nested_attributes`. Все параметры follow можно найти по следующему адресу: https://ovirt.github.io/ovirt-engine-api-model/master/#types/affinity_label/links_summary
host строка	Имя хоста, для которого должны быть перечислены метки affinity.
name строка	Имя меток affinity, которые должны быть перечислены.
nested_attributes список / элементы=строка	Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применяется только когда `fetch_nested` имеет значение true. Этот параметр устарел и заменён на `follow`.
vm строка	Имя виртуальной машины, для которой должны быть перечислены метки affinity.

Примечания

Примечание

Этот модуль возвращает переменную ovirt_affinity_labels, которая содержит список меток affinity. Вам необходимо зарегистрировать результат с помощью ключевого слова 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 affinity labels, which names start with C(label):
- ovirt.ovirt.ovirt_affinity_label_info:
    name: label*
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_affinity_labels }}"

# Gather information about all affinity labels, which are assigned to VMs
# which names start with C(postgres):
- ovirt.ovirt.ovirt_affinity_label_info:
    vm: postgres*
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_affinity_labels }}"

# Gather information about all affinity labels, which are assigned to hosts
# which names start with C(west):
- ovirt.ovirt.ovirt_affinity_label_info:
    host: west*
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_affinity_labels }}"

# Gather information about all affinity labels, which are assigned to hosts
# which names start with C(west) or VMs which names start with C(postgres):
- ovirt.ovirt.ovirt_affinity_label_info:
    host: west*
    vm: postgres*
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_affinity_labels }}"

Значения возврата

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

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

Ключ

Описание

ovirt_affinity_labels

список / элементы=строка

Список словарей, описывающих метки родства. Атрибуты меток родства сопоставлены с ключами словаря, все атрибуты меток родства можно найти по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/affinity_label.

Возвращается: При успешном выполнении.

Авторы

Ондрей Махачек (@machacekondra)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ovirt/ovirt/ovirt_affinity_label_info_module.html