ovirt_storage_connection – Модуль управления подключениями к хранилищу в oVirt
Новая версия 2.4.
Обзор
- Модуль для управления подключениями к хранилищу в oVirt
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.3.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| address - | Адрес сервера хранилища. Например: myserver.mydomain.com | ||
| auth словарь / обязательный | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: | ||
| ca_file строка | Файл PEM, содержащий доверенные сертификаты CA. Сертификат, представленный сервером, будет проверен с использованием этих сертификатов CA. Если параметр ca_file не задан, используется системный хранилище сертификатов CA.Значение по умолчанию устанавливается переменной среды OVIRT_CAFILE. | ||
| headers словарь | Словарь HTTP-заголовков, которые нужно добавить к каждому API-запросу. | ||
| hostname строка | Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию устанавливается переменной среды OVIRT_HOSTNAME. Требуется либо url, либо hostname. | ||
| insecure булево |
| Флаг булевого типа, указывающий, нужно ли проверять сертификат TLS сервера и имя хоста. | |
| kerberos булево |
| Флаг булевого типа, указывающий, нужно ли использовать аутентификацию Kerberos вместо стандартной аутентификации. | |
| password строка / обязательный | Пароль пользователя. Значение по умолчанию устанавливается переменной среды OVIRT_PASSWORD. | ||
| token строка | Токен, который используется вместо входа с именем пользователя/паролем. Значение по умолчанию устанавливается переменной среды OVIRT_TOKEN. | ||
| url строка | Строка, содержащая URL API сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию устанавливается переменной среды OVIRT_URL. Требуется либо url, либо hostname. | ||
| username строка / обязательный | Имя пользователя, например admin@internal. Значение по умолчанию устанавливается переменной среды OVIRT_USERNAME. | ||
| fetch_nested булево добавлено в 2.3 |
| Если True, модуль получит дополнительные данные из API. Он получит идентификаторы дисков, снимков и т.д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes. | |
| force булево |
| Этот параметр актуален только при обновлении подключения. Если true, домен хранилища не обязательно должен быть в состоянии MAINTENANCE, чтобы подключение к хранилищу было обновлено. | |
| id - | Идентификатор подключения к хранилищу, которое нужно управлять. | ||
| mount_options - | Опции, которые будут переданы при монтировании хранилища. | ||
| nested_attributes список добавлено в 2.3 | Указывает список атрибутов, которые нужно получить из API. Этот параметр применяется только когда fetch_nested равно true. | ||
| nfs_retrans - | Количество попыток повторного запроса перед попыткой дополнительных действий восстановления. Диапазон от 0 до 65535. | ||
| nfs_timeout - | Время в десятых долях секунды ожидания ответа перед повторной попыткой NFS-запросов. Диапазон от 0 до 65535. | ||
| nfs_version - | Версия NFS. Один из: auto, v3, v4 или v4_1. | ||
| password - | Пароль CHAP для входа в целевой объект. | ||
| path - | Путь к точке монтирования хранилища. Например: /path/to/my/data | ||
| poll_interval целое число | По умолчанию: 3 | Количество секунд, которое модуль ожидает, прежде чем отправить новый запрос на проверку статуса объекта. | |
| port - | Порт сервера iSCSI хранилища. | ||
| state - |
| Подключение к хранилищу должно быть присутствовать или отсутствовать. | |
| storage - | Имя домена хранилища, которое нужно использовать с подключением к хранилищу. | ||
| target - | Целевой IQN для устройства хранилища. | ||
| timeout целое число | По умолчанию: 180 | Количество секунд, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. | |
| type - | Тип хранилища. Например: nfs, iscsi и т.д. | ||
| username - | Имя пользователя CHAP для входа в целевой объект. | ||
| vfs_type - | Тип виртуальной файловой системы. | ||
| wait булево |
| yes если модуль должен ожидать, пока объект перейдет в нужное состояние. | |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: 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:
# Add new storage connection:
- ovirt_storage_connection:
storage: myiscsi
address: 10.34.63.199
target: iqn.2016-08-09.domain-01:nickname
port: 3260
type: iscsi
# Update the existing storage connection address:
- ovirt_storage_connection:
id: 26915c96-92ff-47e5-9e77-b581db2f2d36
address: 10.34.63.204
force: true
# Remove storage connection:
- ovirt_storage_connection:
id: 26915c96-92ff-47e5-9e77-b581db2f2d36
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| id строка | При успешном обнаружении подключения к хранилищу. | Идентификатор подключение к хранилищу, которое управляется Пример: 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| storage_connection словарь | При успешном обнаружении подключения к хранилищу. | Словарь всех атрибутов подключения к хранилищу. Атрибуты подключения к хранилищу можно найти на вашем экземпляре oVirt по следующему URL-адресу: https://ovirt.example.com/ovirt-engine/api/model#types/storage_connection. |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/ovirt_storage_connection_module.html
