community.general.ovirt_storage_domain_facts – Получение информации об одном или нескольких хранилищах oVirt/RHV
Примечание
Этот плагин входит в состав коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general
Для использования в книге задач укажите: community.general.ovirt_storage_domain_facts
УСТЕРЕГШЕЕ
- Удалино в
-
версии 3.0.0
- Почему
-
При миграции в коллекцию мы решили использовать только модули _info.
- Альтернатива
-
Используйте ovirt.ovirt.ovirt_storage_domain_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, либо hostnamehostname - Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию устанавливается переменной среды OVIRT_HOSTNAME. Требуется либо url, либо hostnametoken - Токен для использования вместо входа с именем пользователя/паролем. Значение по умолчанию устанавливается переменной среды OVIRT_TOKEN.insecure - Логический флаг, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.ca_file - Файл PEM, содержащий доверенные сертификаты CA. Сертификат, представленный сервером, будет проверен с использованием этих сертификатов CA. Если параметр `ca_file` не задан, используется системный хранилище сертификатов CA. Значение по умолчанию устанавливается переменной среды OVIRT_CAFILE.kerberos - Логический флаг, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые должны быть добавлены к каждому API-запросу. | |
| fetch_nested логическое |
| Если да, модуль получит дополнительные данные из API. Он получит только идентификаторы вложенных сущностей. Он не получает несколько уровней вложенных атрибутов. Только атрибуты текущей сущности. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes |
| nested_attributes список / элементы=строка | Указывает список атрибутов, которые должны быть получены из API. Этот параметр применяется только когда fetch_nested равен true. | |
| pattern строка | Поисковый термин, принимаемый back-end поиска oVirt/RHV. Например, для поиска хранилища X из ЦОД Y используйте следующий шаблон: name=X and datacenter=Y |
Примечания
Примечание
- Этот модуль возвращает переменную
ovirt_storage_domains, которая содержит список хранилищ. Вам необходимо зарегистрировать результат с ключевым словом 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 storage domains which names
start with data and belong to data center west
ovirt_storage_domain_info:
pattern: name=data* and datacenter=west
register: result
- name: Print gathered information
ansible.builtin.debug:
msg: "{{ result.ovirt_storage_domains }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие являются полями, уникальными для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| ovirt_storage_domains список / элементы=строка | При успехе. | Список словарей, описывающих хранилища. Атрибуты хранилища сопоставлены с ключами словаря, все атрибуты хранилища можно найти по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/storage_domain. |
Статус
- Этот модуль будет удален в версии 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_storage_domain_facts_module.html