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

Примечание

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

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

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

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

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

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

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

Получение информации об одном или нескольких доменах хранения oVirt/RHV.
До Ansible 2.9 этот модуль назывался ovirt_storage_domain_facts и возвращал ansible_facts. Обратите внимание, что модуль ovirt.ovirt.ovirt_storage_domain_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/storage_domain/links_summary По умолчанию: `[]`
nested_attributes список / элементы=строка	Задает список атрибутов, которые следует получить из API. Этот параметр применяется только если `fetch_nested` имеет значение true. Этот параметр устарел и заменен параметром `follow`. По умолчанию: `[]`
pattern строка	Поисковый запрос, принимаемый серверной частью поиска oVirt/RHV. Например, чтобы найти домен хранения X в центре обработки данных Y, используйте следующий шаблон: name=X and datacenter=Y По умолчанию: `""`

Примечания

Примечание

Этот модуль возвращает переменную ovirt_storage_domains, содержащую список доменов хранения. Чтобы использовать результат, зарегистрируйте его с помощью ключевого слова 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 storage domains which names start with C(data) and
# belong to data center C(west):
- ovirt.ovirt.ovirt_storage_domain_info:
    pattern: name=data* and datacenter=west
  register: result
- ansible.builtin.debug:
    msg: "{{ result.ovirt_storage_domains }}"

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

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

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

Ключ

Описание

ovirt_storage_domains

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

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

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

Авторы

Разработчики 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_storage_domain_info_module.html