Spec-Zone.ru › Ansible 2.9

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

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

Описание

  • Модуль для управления доменными хранилищами в 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
булево
    Варианты:
  • нет
  • да
Логическое удаление хранилища. Если true, сохраняет данные хранилища для импорта.
Этот параметр актуален только при отсутствии state.
discard_after_delete
булево
добавлено в 2.5
    Варианты:
  • нет
  • да
Если Истина, блоки хранилища будут удалены при удалении. Включено по умолчанию.
Этот параметр актуален только для блочных хранилищ.
domain_function
-
    Варианты:
  • данные ←
  • iso
  • экспорт
Функция хранилища.
Этот параметр не идемпотентный, изменить функцию хранилища нельзя.

псевдонимы: тип
fcp
-
Словарь со значениями для типа хранилища Fibre Channel:
Обратите внимание, что эти параметры не идемпотентны.
lun_id
-
Идентификатор LUN.
override_luns
булево
    Варианты:
  • нет
  • да
Если Истина, LUN хранилища FCP будут переопределены перед добавлением.
fetch_nested
булево
    Варианты:
  • нет
  • да
Если Истина, модуль извлечёт дополнительные данные из 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 для хранилища.
END_OF_DOCUMENT_MARKER
target_lun_map
-
added in 2.5
Список словарей, содержащих целевые объекты и LUN.
username
-
Имя пользователя CHAP для входа в целевой объект.
localfs
-
added in 2.4
Словарь со значениями для типа хранения localfs:
Обратите внимание, что эти параметры не идемпотентны.
path
-
Путь к точке монтирования. Например: /path/to/my/data
managed_block_storage
-
added in 2.9
Словарь со значениями для типа управляемого блочного хранилища
Примечание: доступно с ovirt 4.3
driver_options
-
Параметры, передаваемые при создании домена хранения с использованием драйвера cinder.
Список словарей, содержащих name и value параметров драйвера.
driver_sensitive_options
-
Параметры, содержащие конфиденциальную информацию, передаваемые при создании домена хранения с использованием драйвера cinder.
Список словарей, содержащих name и value параметров конфиденциальных настроек драйвера.
name
-
Имя домена хранилища для управления. (Не требуется, когда состояние imported)
nested_attributes
list
Указывает список атрибутов, которые необходимо извлечь из 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
integer
По умолчанию:
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
integer
По умолчанию:
180
Время в секундах, которое модуль должен ждать, пока экземпляр не перейдет в нужное состояние.
wait
boolean
    Варианты:
  • no
  • yes ←
yes Указывает, должен ли модуль ждать, пока сущность перейдет в нужное состояние.
warning_low_space
-
added in 2.5
Указывает минимальный процент свободного места в домене хранилища, при котором будет выведено предупреждение.
wipe_after_delete
boolean
added in 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

# Create managed storage domain
# Available from ovirt 4.3 and ansible 2.9
- ovirt_storage_domain:
    name: my_managed_domain
    host: myhost
    data_center: mydatacenter
    managed_block_storage:
      driver_options:
        - name: rbd_pool
          value: pool1
        - name: rbd_user
          value: admin
        - name: volume_driver
          value: cinder.volume.drivers.rbd.RBDDriver
        - name: rbd_keyring_conf
          value: /etc/ceph/keyring
      driver_sensitive_options:
        - name: secret_password
          value: password

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

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

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

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

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



Статус

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

Spec-Zone.ru

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