ovirt_storage_domains - Модуль управления доменными хранилищами в oVirt/RHV
Новая версия 2.3.
Обзор
- Модуль для управления доменными хранилищами в oVirt/RHV
Требования
Ниже приведены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.7
- ovirt-engine-sdk-python >= 4.2.4
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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-запросу. | |
| backup (добавлен в 2.5) | Логический флаг, указывающий, настроена ли область хранения как резервная. | |
| comment | Комментарий к области хранения. | |
| critical_space_action_blocker (добавлен в 2.5) | Указывает минимальное свободное пространство, которое должна содержать область хранения в процентах. | |
| data_center | Имя центра обработки данных, к которому должна быть подключена область хранения. Этот параметр не идемпотентный, изменить центр обработки данных для области хранения нельзя. | |
| description | Описание области хранения. | |
| destroy | Логическое удаление области хранения. Если true, сохраняет данные области хранения для импорта. Этот параметр актуален только когда state отсутствует. | |
| discard_after_delete (добавлен в 2.5) | Если True, блоки области хранения будут удалены при удалении. Включено по умолчанию. Этот параметр актуален только для блочных областей хранения. | |
| domain_function |
| Функция области хранения. Этот параметр не идемпотентный, изменить функцию области хранения нельзя. псевдонимы: type |
| fcp | Словарь со значениями для типа хранения Fibre Channel: address - Адрес сервера Fibre Channel.port - Порт сервера Fibre Channel.lun_id - Идентификатор LUN.override_luns - Если True, LUNы области хранения FCP будут перезаписаны перед добавлением.Обратите внимание, что эти параметры не идемпотентны. | |
| 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 будут перезаписаны перед добавлением.target_lun_map - Список словарей, содержащих цели и LUNы."Обратите внимание, что эти параметры не идемпотентны. Параметр target_lun_map поддерживается начиная с Ansible 2.5. | |
| 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.mount_options - Параметр, который будет передан при монтировании хранилища.Обратите внимание, что эти параметры не идемпотентны. | |
| poll_interval | По умолчанию: 3 | Количество секунд, которое модуль ожидает, прежде чем отправлять другой запрос опроса о статусе сущности. |
| posixfs | Словарь со значениями для типа хранения PosixFS: path - Путь к точке монтирования. Например: /path/to/my/datavfs_type - Тип виртуальной файловой системы.mount_options - Параметр, который будет передан при монтировании хранилища.Обратите внимание, что эти параметры не идемпотентны. | |
| state |
| Должна ли область хранения быть present/absent/maintenance/unattached/imported/update_ovf_store
imported поддерживается с версии 2.4.
update_ovf_store поддерживается с версии 2.5, в настоящее время, если wait равно (true), мы не ждем обновления. |
| timeout | По умолчанию: 180 | Количество секунд, которое модуль должен ждать, пока экземпляр не перейдёт в нужное состояние. |
| wait |
True, если модуль должен ждать, пока сущность перейдёт в нужное состояние. | |
| warning_low_space (добавлен в 2.5) | Указывает минимальный процент свободного места в области хранения для отображения предупреждения. | |
| wipe_after_delete (добавлен в 2.5) | Логический флаг, указывающий, следует ли очистить данные области хранения после удаления. |
Примечания
Примечание
- Для использования данного модуля необходимо установить oVirt Python SDK. Для обеспечения установки с правильной версией можно создать следующую задачу: pip: name=ovirt-engine-sdk-python version=4.0.0
Примеры
# 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
mount_options: noexec,nosuid
# 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
discard_after_delete: True
backup: False
critical_space_action_blocker: 5
warning_low_space: 10
# Since Ansible 2.5 you can specify multiple targets for storage domain,
# Add data iSCSI storage domain with multiple targets:
- ovirt_storage_domains:
name: data_iscsi
host: myhost
data_center: mydatacenter
iscsi:
target_lun_map:
- target: iqn.2016-08-09.domain-01:nickname
lun_id: 1IET_000d0001
- target: iqn.2016-08-09.domain-02:nickname
lun_id: 1IET_000d0002
address: 10.34.63.204
discard_after_delete: True
# 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
wipe_after_delete: False
backup: True
critical_space_action_blocker: 2
warning_low_space: 5
# 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
# Update OVF_STORE:
- ovirt_storage_domains:
state: update_ovf_store
name: domain
# 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 dict | При успешном поиске домена хранилища. | Словарь всех атрибутов домена хранилища. Атрибуты домена хранилища можно найти на вашем экземпляре oVirt/RHV по следующему адресу: http://ovirt.github.io/ovirt-engine-api-model/master/#types/storage_domain. |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/ovirt_storage_domains_module.html