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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.
Этот модуль назывался ovirt_storage_domain_facts до Ansible 2.9, возвращая 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 целое число	Количество секунд ожидания ответа.
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/storage_domain/links_summary
nested_attributes список / элементы=строка	Указывает список атрибутов, которые должны быть извлечены из API. Этот параметр применяется только когда `fetch_nested` равно true. Этот параметр устарел и заменён на `follow`.
pattern строка	Поисковый запрос, который принимается бэкендом поиска oVirt/RHV. Например, чтобы найти хранилище X из центров обработки данных Y, используйте следующий запрос: name=X и 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 список / элементы=строка	Список словарей, описывающих хранилища. Атрибуты хранилища сопоставлены с ключами словаря, все атрибуты хранилищ можно найти по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/storage_domain. Возвращаемое значение: При успехе.

Ключ

Описание

ovirt_storage_domains

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

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

Возвращаемое значение: При успехе.

Авторы

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

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

© 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_storage_domain_info_module.html