ovirt_storage_connections - Модуль для управления подключениями к хранилищу в oVirt
Новая версия с 2.4.
Обзор
- Модуль для управления подключениями к хранилищу в oVirt
Требования
Ниже перечислены требования, которые должны быть выполнены на хосте, на котором выполняется этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| address | Адрес сервера хранилища. Пример: myserver.mydomain.com | |
| 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, либо hostname. hostname - Строка, содержащая имя хоста сервера, обычно что-то вроде `server.example.com`. Значение по умолчанию задается переменной среды OVIRT_HOSTNAME. Обязательно указать либо url, либо hostname. token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию задается переменной среды OVIRT_TOKEN.insecure - Флаг булевого типа, указывающий, следует ли проверять сертификат TLS сервера и имя хоста.ca_file - PEM-файл, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с помощью этих сертификатов CA. Если параметр `ca_file` не задан, используется системное хранилище сертификатов CA. Значение по умолчанию задается переменной среды OVIRT_CAFILE.kerberos - Флаг булевого типа, указывающий, следует ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые необходимо добавить к каждому API-запросу. | |
| 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 |
True, если модуль должен ожидать, пока сущность не перейдет в нужное состояние. |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, вы можете создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.2.4
Примеры
# 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_connections:
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_connections:
id: 26915c96-92ff-47e5-9e77-b581db2f2d36
address: 10.34.63.204
force: true
# Remove storage connection:
- ovirt_storage_connections:
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. Подробнее об обслуживании модулей см. в разделе Поддержка и обслуживание модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- 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.6/modules/ovirt_storage_connections_module.html
