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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать модуль в плейбуке, укажите: ovirt.ovirt.ovirt_affinity_label_info.

Добавлено в ovirt.ovirt 1.0.0

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

Краткое описание

Получение информации об одной или нескольких метках affinity oVirt/RHV.
До Ansible 2.9 этот модуль назывался ovirt_affinity_label_facts и возвращал 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 целое число	Количество секунд ожидания ответа. По умолчанию: `0`
token строка	Токен, используемый вместо входа с именем пользователя и паролем. Значение по умолчанию задается переменной окружения `OVIRT_TOKEN`.
url строка	Строка с URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию задается переменной окружения `OVIRT_URL`. Необходимо указать либо `url`, либо `hostname`.
username строка	Имя пользователя, например admin@internal. Значение по умолчанию задается переменной окружения `OVIRT_USERNAME`.
fetch_nested логический	Если установлено значение yes, модуль получит из 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 список / элементы=строка	Список словарей с описанием меток affinity. Атрибуты меток affinity сопоставлены с ключами словаря. Все атрибуты меток affinity перечислены по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/affinity_label. Возвращается: При успешном выполнении.

Ключ

Описание

ovirt_affinity_labels

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

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

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

Авторы

Разработчики oVirt (@oVirt)

Ссылки на коллекцию

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