Spec-Zone.ru › Ansible 2.8

ovirt_storage_domain – Модуль управления доменными хранилищами в oVirt/RHV

Новая версия с 2.3.

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Значения возврата
  • Статус

Описание

  • Модуль управления доменными хранилищами в oVirt/RHV

Требования

Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.

  • python >= 2.7
  • ovirt-engine-sdk-python >= 4.3.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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.
backup
логическое
добавлен в 2.5
    Варианты:
  • нет
  • да
Логическая переменная, указывающая, настроен ли домен хранения как резервный.
comment
-
Комментарий к домену хранения.
critical_space_action_blocker
-
добавлен в 2.5
Указывает минимальный свободный объем пространства в процентах, который должен содержать домен хранения.
data_center
-
Имя ЦОД, к которому должен быть подключен домен хранения.
Этот параметр не идемпотентный; изменить ЦОД хранилища невозможно.
description
-
Описание домена хранения.
destroy
логическое
    Варианты:
  • нет
  • да
Логическое удаление домена хранения. Если истина, сохраняет данные домена хранения для импорта.
Этот параметр актуален только при отсутствии state.
discard_after_delete
логическое
добавлен в 2.5
    Варианты:
  • нет
  • да
Если истина, блоки домена хранения будут удалены при удалении. Включено по умолчанию.
Этот параметр актуален только для блочных доменов хранения.
domain_function
-
    Варианты:
  • данные ←
  • iso
  • экспорт
Функция домена хранения.
Этот параметр не идемпотентный; изменить функцию домена хранения невозможно.

псевдонимы: тип
fcp
-
Словарь со значениями для типа хранения Fibre Channel:
Обратите внимание, что эти параметры не идемпотентны.
lun_id
-
Идентификатор LUN.
override_luns
логическое
    Варианты:
  • нет
  • да
Если истина, LUN домена хранения FCP будут перезаписаны перед добавлением.
fetch_nested
логическое
добавлен в 2.3
    Варианты:
  • нет
  • да
Если истина, модуль извлечёт дополнительные данные из API.
Он извлечёт идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить извлечение других атрибутов вложенных сущностей, указав nested_attributes.
format
логическое
    Варианты:
  • нет
  • да
Если истина, домен хранения будет отформатирован после удаления из oVirt/RHV.
Этот параметр актуален только при отсутствии state.
glusterfs
-
Словарь со значениями для типа хранения GlusterFS:
Обратите внимание, что эти параметры не идемпотентны.
address
-
Адрес сервера Gluster. Например: myserver.mydomain.com
mount_options
-
Параметр, который будет передан при монтировании хранилища.
path
-
Путь к точке монтирования. Например: /path/to/my/data
host
-
Хост, используемый для монтирования хранилища.
id
-
добавлен в 2.4
Идентификатор домена хранения для импорта.
iscsi
-
Словарь со значениями для типа хранения iSCSI:
Обратите внимание, что эти параметры не идемпотентны.
address
-
Адрес сервера хранения iSCSI.
lun_id
-
Идентификатор(ы) LUN.
override_luns
логическое
    Варианты:
  • нет
  • да
Если истина, LUN домена хранения iSCSI будут перезаписаны перед добавлением.
password
-
Пароль CHAP для входа на целевой ресурс.
port
-
Порт сервера хранения iSCSI.
target
-
Целевой IQN для устройства хранения.
target_lun_map
-
добавлено в 2.5
Список словарей, содержащих целевые значения и LUN.
username
-
Имя пользователя CHAP для входа в целевой ресурс.
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.com
mount_options
-
Параметры, которые будут переданы при монтировании хранилища.
path
-
Путь к точке монтирования. Например: /path/to/my/data
retrans
-
Количество попыток повторной отправки запроса перед попыткой дальнейшего восстановления. Диапазон от 0 до 65535.
timeout
-
Время в десятых долях секунды, которое следует ожидать для получения ответа перед повторной отправкой запросов NFS. Диапазон от 0 до 65535.
version
-
Версия NFS. Одна из: auto, v3, v4 или v4_1.
poll_interval
целое число
По умолчанию:
3
Количество секунд, которое модуль ожидает до отправки нового запроса опроса состояния сущности.
posixfs
-
Словарь со значениями для типа хранения PosixFS:
Обратите внимание, что эти параметры не идемпотентны.
mount_options
-
Параметры, которые будут переданы при монтировании хранилища.
path
-
Путь к точке монтирования. Например: /path/to/my/data
vfs_type
-
Тип виртуальной файловой системы.
state
-
    Варианты:
  • present ←
  • absent
  • maintenance
  • unattached
  • imported
  • update_ovf_store
Должен ли домен хранилища быть present/absent/maintenance/unattached/imported/update_ovf_store
imported поддерживается с версии 2.4.
update_ovf_store поддерживается с версии 2.5, в настоящее время, если wait имеет значение (true), ожидание обновления не происходит.
timeout
целое число
По умолчанию:
180
Время в секундах, которое модуль должен ждать, пока инстанс не перейдет в нужное состояние.
wait
булево
    Варианты:
  • no
  • yes ←
yes указывает, следует ли модулю ожидать перехода сущности в нужное состояние.
warning_low_space
-
добавлено в 2.5
Указывает минимальный процент свободного места в домене хранилища, при котором будет отображено предупреждение.
wipe_after_delete
булево
добавлено в 2.5
    Варианты:
  • no
  • 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 data NFS storage domain
- ovirt_storage_domain:
    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_domain:
    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_domain:
    name: data_localfs
    host: myhost
    data_center: mydatacenter
    localfs:
      path: /path/to/data

# Add data iSCSI storage domain:
- ovirt_storage_domain:
    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_domain:
    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_domain:
    name: glusterfs_1
    host: myhost
    data_center: mydatacenter
    glusterfs:
      address: 10.10.10.10
      path: /path/data

# Create export NFS storage domain:
- ovirt_storage_domain:
    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_domain:
    state: imported
    domain_function: export
    host: myhost
    data_center: mydatacenter
    nfs:
      address: 10.34.63.199
      path: /path/export

# Import FCP storage domain:
- ovirt_storage_domain:
    state: imported
    name: data_fcp
    host: myhost
    data_center: mydatacenter
    fcp: {}

# Update OVF_STORE:
- ovirt_storage_domain:
    state: update_ovf_store
    name: domain

# Create ISO NFS storage domain
- ovirt_storage_domain:
    name: myiso
    domain_function: iso
    host: myhost
    data_center: mydatacenter
    nfs:
      address: 10.34.63.199
      path: /path/iso

# Remove storage domain
- ovirt_storage_domain:
    state: absent
    name: mystorage_domain
    format: true

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ Возвращаемое Описание
id
строка
При успехе, если домен хранилища найден.
ID домена хранилища, который управляется

Пример:
7de90f31-222c-436c-a1ca-7e655bd5b60c
storage_domain
словарь
При успехе, если домен хранилища найден.
Словарь всех атрибутов домена хранилища. Атрибуты домена хранилища можно найти на вашем экземпляре oVirt/RHV по следующему URL: http://ovirt.github.io/ovirt-engine-api-model/master/#types/storage_domain.



Состояние

  • Гарантия обратной совместимости интерфейса этого модуля не предоставляется. [превью]
  • Этот модуль поддерживается сообществом 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_domain_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API