ovirt_storage_domains - Модуль для управления доменными хранилищами в oVirt/RHV
Новый в версии 2.3.
- Обзор
- Требования (к хосту, на котором выполняется модуль)
- Параметры
- Примеры
- Возвращаемые значения
- Примечания
Обзор
- Модуль для управления доменными хранилищами в oVirt/RHV
Требования (к хосту, на котором выполняется модуль)
- python >= 2.7
- ovirt-engine-sdk-python >= 4.0.0
Параметры
| параметр | обязательно | значение по умолчанию | варианты | комментарии |
|---|---|---|---|---|
| auth | да | Словарь со значениями, необходимыми для создания HTTP/HTTPS-соединения с oVirt: username[обязательно] - Имя пользователя, например, admin@internal. Значение по умолчанию устанавливается переменной окружения OVIRT_USERNAME.password[обязательно] - Пароль пользователя. Значение по умолчанию устанавливается переменной окружения OVIRT_PASSWORD.url[обязательно] - Строка, содержащая базовый URL-адрес сервера, обычно что-то вроде `https://server.example.com/ovirt-engine/api`. Значение по умолчанию устанавливается переменной окружения OVIRT_URL.token - Токен, используемый вместо входа с именем пользователя/паролем. Значение по умолчанию устанавливается переменной окружения OVIRT_TOKEN.insecure - Логическая переменная, указывающая, нужно ли проверять сертификат TLS сервера и имя хоста.ca_file - Файл PEM, содержащий доверенные сертификаты CA. Представленный сервером сертификат будет проверен с использованием этих сертификатов CA. Если параметр `ca_file` не задан, используется системный хранилище сертификатов CA. Значение по умолчанию устанавливается переменной окружения OVIRT_CAFILE.kerberos - Логическая переменная, указывающая, нужно ли использовать аутентификацию Kerberos вместо стандартной аутентификации.headers - Словарь HTTP-заголовков, которые нужно добавлять к каждому API-запросу. | ||
| comment | нет | Комментарий к доменному хранилищу. | ||
| data_center | нет | Имя ЦОД, к которому должно быть подключено доменное хранилище. Этот параметр не идемпотентен, изменить ЦОД доменного хранилища нельзя. | ||
| description | нет | Описание доменного хранилища. | ||
| destroy | нет | Логическое удаление доменного хранилища. Если true, сохраняет данные доменного хранилища для импорта. Этот параметр актуален только когда state отсутствует. | ||
| domain_function | нет | data |
| Функция доменного хранилища. Этот параметр не идемпотентен, изменить функцию доменного хранилища нельзя. Синонимы: тип |
| fcp | нет | Словарь со значениями для типа хранения Fibre Channel: address - Адрес сервера Fibre Channel.port - Порт сервера Fibre Channel.lun_id - Идентификатор LUN.Обратите внимание, что эти параметры не идемпотентны. | ||
| fetch_nested (добавлен в 2.3)
| нет | Если True, модуль извлечет дополнительные данные из API. Он извлечет идентификаторы дисков, снимков и т. д. для виртуальных машин. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes. | ||
| format | нет | Если True, доменное хранилище будет отформатировано после удаления из oVirt/RHV. Этот параметр актуален только когда state отсутствует. | ||
| glusterfs | нет | Словарь со значениями для типа хранения GlusterFS: address - Адрес сервера Gluster. Например: myserver.mydomain.compath - Путь к точке монтирования. Например: /path/to/my/datamount_options - Параметр, который будет передан при монтировании хранилища.Обратите внимание, что эти параметры не идемпотентны. | ||
| host | нет | Хост, используемый для монтирования хранилища. | ||
| id (добавлен в 2.4)
| нет | Идентификатор доменного хранилища для импорта. | ||
| iscsi | нет | Словарь со значениями для типа хранения iSCSI: address - Адрес сервера iSCSI.port - Порт сервера iSCSI.target - Целевой IQN для устройства хранения.lun_id - Идентификатор(ы) LUN.username - Имя пользователя CHAP для входа на целевой объект.password - Пароль CHAP для входа на целевой объект.override_luns - Если True, LUNы доменного хранилища iSCSI будут перезаписаны перед добавлением.Обратите внимание, что эти параметры не идемпотентны. | ||
| localfs (добавлен в 2.4)
| нет | Словарь со значениями для типа хранения localfs: path - Путь к точке монтирования. Например: /path/to/my/dataОбратите внимание, что эти параметры не идемпотентны. | ||
| name | нет | Имя доменного хранилища для управления. (Не требуется, когда состояние imported) | ||
| nested_attributes (добавлен в 2.3)
| нет | Указывает список атрибутов, которые нужно извлечь из API. Этот параметр применяется только когда fetch_nested true. | ||
| nfs | нет | Словарь со значениями для типа хранения NFS: address - Адрес сервера NFS. Например: myserver.mydomain.compath - Путь к точке монтирования. Например: /path/to/my/dataversion - Версия NFS. Один из: auto, v3, v4 или v4_1.timeout - Время в десятых долях секунды ожидания ответа перед повторной попыткой запросов NFS. Диапазон от 0 до 65535.retrans - Количество попыток повтора запроса перед попыткой дополнительных действий по восстановлению. Диапазон от 0 до 65535.Обратите внимание, что эти параметры не идемпотентны. | ||
| poll_interval | нет | 3 | Количество секунд, которое модуль ждет, прежде чем отправлять другой запрос опроса состояния сущности. | |
| posixfs | нет | Словарь со значениями для типа хранения PosixFS: path - Путь к точке монтирования. Например: /path/to/my/datavfs_type - Тип виртуальной файловой системы.mount_options - Параметр, который будет передан при монтировании хранилища.Обратите внимание, что эти параметры не идемпотентны. | ||
| state | нет | present |
| Должно ли доменное хранилище присутствовать/отсутствовать/в режиме обслуживания/отключено/импортировано
imported поддерживается с версии 2.4. |
| timeout | нет | 180 | Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние. | |
| wait | нет |
True, если модуль должен дождаться, пока сущность перейдет в нужное состояние. |
Примеры
# Examples don't contain auth parameter for simplicity,
# look at ovirt_auth module to see how to reuse authentication:
# Add data NFS storage domain
- ovirt_storage_domains:
name: data_nfs
host: myhost
data_center: mydatacenter
nfs:
address: 10.34.63.199
path: /path/data
# Add data NFS storage domain with id for data center
- ovirt_storage_domains:
name: data_nfs
host: myhost
data_center: 11111
nfs:
address: 10.34.63.199
path: /path/data
# Add data localfs storage domain
- ovirt_storage_domains:
name: data_localfs
host: myhost
data_center: mydatacenter
localfs:
path: /path/to/data
# Add data iSCSI storage domain:
- ovirt_storage_domains:
name: data_iscsi
host: myhost
data_center: mydatacenter
iscsi:
target: iqn.2016-08-09.domain-01:nickname
lun_id:
- 1IET_000d0001
- 1IET_000d0002
address: 10.34.63.204
# Add data glusterfs storage domain
- ovirt_storage_domains:
name: glusterfs_1
host: myhost
data_center: mydatacenter
glusterfs:
address: 10.10.10.10
path: /path/data
# Create export NFS storage domain:
- ovirt_storage_domains:
name: myexportdomain
domain_function: export
host: myhost
data_center: mydatacenter
nfs:
address: 10.34.63.199
path: /path/export
# Import export NFS storage domain:
- ovirt_storage_domains:
state: imported
domain_function: export
host: myhost
data_center: mydatacenter
nfs:
address: 10.34.63.199
path: /path/export
# Create ISO NFS storage domain
- ovirt_storage_domains:
name: myiso
domain_function: iso
host: myhost
data_center: mydatacenter
nfs:
address: 10.34.63.199
path: /path/iso
# Remove storage domain
- ovirt_storage_domains:
state: absent
name: mystorage_domain
format: true
Возвращаемые значения
Общие возвращаемые значения описаны здесь Возвращаемые значения, следующие являются полями, уникальными для этого модуля:
| название | описание | возвращается | тип | пример |
|---|---|---|---|---|
| id | Идентификатор доменного хранилища, которое управляется | При успехе, если доменное хранилище найдено. | str | 7de90f31-222c-436c-a1ca-7e655bd5b60c |
| storage_domain | Словарь всех атрибутов доменного хранилища. Атрибуты доменного хранилища можно найти на вашем экземпляре oVirt/RHV по следующему URL-адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/storage_domain. | При успехе, если доменное хранилище найдено. | dict |
Примечания
Примечание
- Для использования этого модуля необходимо установить oVirt Python SDK. Чтобы убедиться, что он установлен с правильной версией, можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Статус
Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы заинтересованы, пожалуйста, прочтите Информацию о сообществе и участии в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ovirt_storage_domains_module.html