Spec-Zone.ru › Ansible 2.7

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

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

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

Обзор

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

Псевдонимы: ovirt_storage_domains

Требования

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

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

Параметры

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

псевдонимы: тип
fcp
-
Словарь со значениями для типа хранения Fibre Channel:
lun_id - идентификатор LUN.
override_luns - Если True, LUNы домена хранения FCP будут перезаписаны перед добавлением.
Обратите внимание, что эти параметры не идемпотентны.
fetch_nested
boolean
добавлен в 2.3
    Варианты:
  • нет
  • да
Если True, модуль получит дополнительные данные от API.
Он получит идентификаторы дисков ВМ, снимков и т. д. Пользователь может настроить получение других атрибутов вложенных сущностей, указав nested_attributes.
format
boolean
    Варианты:
  • нет
  • да
Если True, домен хранения будет отформатирован после удаления из oVirt/RHV.
Этот параметр актуален только когда state отсутствует.
glusterfs
-
Словарь со значениями для типа хранения GlusterFS:
address - Адрес сервера Gluster. Например: myserver.mydomain.com
path - Путь к точке монтирования. Например: /path/to/my/data
mount_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
-
Имя домена хранения для управления. (Не требуется, когда состояние импортировано)
nested_attributes
-
добавлен в 2.3
Указывает список атрибутов, которые должны быть получены от API.
Этот параметр применим только когда fetch_nested true.
nfs
-
Словарь со значениями для типа хранения NFS:
address - Адрес сервера NFS. Например: myserver.mydomain.com
path - Путь к точке монтирования. Например: /path/to/my/data
version - Версия NFS. Одна из: auto, v3, v4 или v4_1.
timeout - Время в десятых долях секунды ожидания ответа перед повтором запросов NFS. Диапазон 0–65535.
retrans - Количество попыток повтора запроса перед попыткой дальнейших действий по восстановлению. Диапазон 0–65535.
mount_options - Опция, которая будет передана при монтировании хранилища.
Обратите внимание, что эти параметры не идемпотентны.
poll_interval
-
По умолчанию:
3
Количество секунд, в течение которого модуль ждет, пока будет отправлен другой запрос опроса о статусе сущности.
posixfs
-
Словарь со значениями для типа хранения PosixFS:
path - Путь к точке монтирования. Например: /path/to/my/data
vfs_type - Тип виртуальной файловой системы.
mount_options - Опция, которая будет передана при монтировании хранилища.
Обратите внимание, что эти параметры не идемпотентны.
Состояние
-
    Варианты:
  • текущее ←
  • отсутствует
  • обслуживание
  • неприсоединённый
  • импортированный
  • update_ovf_store
Должно ли хранилище быть присутствующим/отсутствующим/в режиме обслуживания/неприсоединённым/импортированным/update_ovf_store
импортированный поддерживается с версии 2.4.
update_ovf_store поддерживается с версии 2.5, в настоящее время, если wait (true), мы не ждём обновления.
timeout
-
Значение по умолчанию:
180
Время в секундах, которое модуль должен ждать, пока экземпляр не перейдёт в желаемое состояние.
wait
boolean
    Варианты:
  • нет
  • да ←
True, если модуль должен ждать, пока сущность не перейдёт в желаемое состояние.
warning_low_space
-
добавлено в 2.5
Указывает минимальный процент свободного места в хранилище, при котором будет выведено предупреждение.
wipe_after_delete
boolean
добавлено в 2.5
    Варианты:
  • нет
  • да
Флаг булевого типа, указывающий, следует ли очищать данные хранилища после удаления.

Примечания

Примечание

  • Для использования этого модуля необходимо установить 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 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
строка
При успехе, если хранилище найдено.
Идентификатор хранилища, которое управляется.

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



Статус

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

Spec-Zone.ru

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