Spec-Zone.ru › Ansible

Модуль openstack.cloud.volume — создание и удаление томов Cinder

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля могут потребоваться дополнительные зависимости; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: openstack.cloud.volume.

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

Обзор

  • Создание или удаление блочных томов хранилища Cinder

Требования

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

  • python >= 3.6
  • openstacksdk >= 1.0.0

Параметры

Параметр

Комментарии

api_timeout

integer

Сколько времени уровень сокетов должен ожидать ответа перед истечением времени ожидания вызовов API. Если параметр не указан, библиотеке requests ничего не передаётся.

auth

dictionary

Словарь с данными аутентификации, необходимыми используемой в облаке стратегией модуля аутентификации. Для модуля password, используемого по умолчанию, словарь должен содержать auth_url, username, password, project_name и данные о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других модулей этот параметр должен содержать все необходимые им параметры. Этот параметр не требуется, если указано именованное облако или доступны переменные окружения OpenStack OS_*.

auth_type

string

Имя используемого модуля аутентификации. Если в облаке используется не аутентификация по паролю, здесь следует указать имя модуля и соответствующим образом изменить содержимое параметра auth.

availability_zone

string

Зона доступности.

ca_cert

псевдонимы: cacert

string

Путь к пакету сертификатов центра сертификации, который можно использовать для проверки запросов API через SSL.

client_cert

псевдонимы: cert

string

Путь к сертификату клиента для использования в транзакции SSL.

client_key

псевдонимы: key

string

Путь к ключу клиента для использования в транзакции SSL.

cloud

any

Именованное облако или конфигурация облака, с которыми будет выполняться работа. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Параметр задаёт значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или доступны переменные окружения OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml.

description

псевдонимы: display_description

string

Строка с описанием тома

image

string

Имя или идентификатор образа для загрузки с тома

Взаимоисключающий параметр с snapshot и volume

interface

псевдонимы: endpoint_type

string

Тип URL конечной точки, выбираемой из каталога служб.

Варианты:

  • "admin"
  • "internal"
  • "public" ← (по умолчанию)

is_bootable

псевдонимы: bootable

boolean

Флаг загрузочного тома.

Варианты:

  • false ← (по умолчанию)
  • true

is_multiattach

boolean

Можно ли совместно использовать том.

Чтобы разрешить подключение этого тома к нескольким серверам, установите для is_multiattach значение true.

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

По умолчанию в Cinder для is_multiattach установлено значение false.

Варианты:

  • false
  • true

metadata

dictionary

Метаданные тома

name

псевдонимы: display_name

string / обязательный

Имя тома

region_name

string

Имя региона.

scheduler_hints

dictionary

Подсказки планировщику, передаваемые API томов в виде словаря

sdk_log_level

string

Уровень ведения журнала OpenStackSDK

Варианты:

  • "INFO" ← (по умолчанию)
  • "DEBUG"

sdk_log_path

string

Путь к файлу журнала OpenStackSDK. Если путь пуст, журнал не ведётся.

size

integer

Размер тома в ГБ. Этот параметр обязателен, если параметр state имеет значение ‘present’.

snapshot

псевдонимы: snapshot_id

string

Имя или идентификатор снимка тома, на основе которого нужно создать том

Взаимоисключающий параметр с image и volume

state

string

Должен ли ресурс присутствовать или отсутствовать.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

timeout

integer

Сколько времени Ansible должен ожидать запрошенный ресурс.

По умолчанию: 180

validate_certs

псевдонимы: verify

boolean

Нужно ли проверять запросы API через SSL.

До Ansible 2.3 значение по умолчанию было true.

Варианты:

  • false
  • true

volume

string

Имя или идентификатор тома, на основе которого нужно создать том

Взаимоисключающий параметр с image и snapshot

volume_type

string

Тип тома

wait

boolean

Должен ли Ansible ожидать завершения операции над запрошенным ресурсом.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

  • Вместо явного указания значений можно использовать стандартные переменные окружения OpenStack, например OS_USERNAME.
  • Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из файла конфигурации YAML /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных окружения и, наконец, из явно указанных параметров в сценариях. Дополнительную информацию см. на странице https://docs.openstack.org/openstacksdk/

Примеры

# Creates a new volume
- name: create 40g test volume
  openstack.cloud.volume:
    state: present
    cloud: mordred
    availability_zone: az2
    size: 40
    name: test_volume
    scheduler_hints:
      same_host: 243e8d3c-8f47-4a61-93d6-7215c344b0c0

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

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

Ключ

Описание

volume

dictionary

Представление объекта тома в Cinder

Возвращается: всегда

attachments

list / elements=string

Информация о подключении к экземпляру. Если этот том подключён к экземпляру сервера, список attachments включает UUID подключённого сервера, UUID подключения, имя подключённого хоста (если есть), UUID тома, устройство и UUID устройства. В противном случае список пуст.

Возвращается: при успешном выполнении

availability_zone

string

Имя зоны доступности.

Возвращается: при успешном выполнении

consistency_group_id

string

UUID группы согласованности.

Возвращается: при успешном выполнении

created_at

string

Дата и время создания ресурса.

Возвращается: при успешном выполнении

description

string

Описание тома.

Возвращается: при успешном выполнении

extended_replication_status

string

Расширенный статус репликации этого тома.

Возвращается: при успешном выполнении

group_id

string

Идентификатор группы.

Возвращается: при успешном выполнении

host

string

Текущая серверная часть тома.

Возвращается: при успешном выполнении

id

string

UUID тома.

Возвращается: при успешном выполнении

image_id

string

Образ, на основе которого создан том

Возвращается: при успешном выполнении

is_bootable

string

Включает или отключает атрибут загрузочного тома. Из загрузочного тома можно запустить экземпляр.

Возвращается: при успешном выполнении

is_encrypted

boolean

Если значение равно true, том зашифрован.

Возвращается: при успешном выполнении

is_multiattach

boolean

Можно ли подключить этот том к нескольким серверам.

Возвращается: при успешном выполнении

metadata

dictionary

Объект метаданных. Содержит одну или несколько пар ключ-значение метаданных, связанных с томом.

Возвращается: при успешном выполнении

migration_id

string

Идентификатор тома, на основе которого задано имя этого тома в серверной части.

Возвращается: при успешном выполнении

migration_status

string

Статус миграции этого тома (значение None означает, что в данный момент миграция не выполняется).

Возвращается: при успешном выполнении

name

string

Имя тома.

Возвращается: при успешном выполнении

project_id

string

Идентификатор проекта, которому принадлежит том.

Возвращается: при успешном выполнении

replication_driver_data

string

Данные, заданные драйвером репликации

Возвращается: при успешном выполнении

replication_status

string

Статус репликации тома.

Возвращается: при успешном выполнении

scheduler_hints

dictionary

Подсказки планировщику для тома

Возвращается: при успешном выполнении

size

integer

Размер тома в гибибайтах (ГиБ).

Возвращается: при успешном выполнении

snapshot_id

string

Чтобы создать том на основе существующего снимка, укажите UUID снимка тома. Том создаётся в той же зоне доступности и имеет тот же размер, что и снимок.

Возвращается: при успешном выполнении

source_volume_id

string

UUID исходного тома. API создаёт новый том того же размера, что и исходный, если не запрошен больший размер.

Возвращается: при успешном выполнении

status

string

Статус тома.

Возвращается: при успешном выполнении

updated_at

string

Дата и время обновления ресурса.

Возвращается: при успешном выполнении

user_id

string

UUID пользователя.

Возвращается: при успешном выполнении

volume_image_metadata

dictionary

Список записей метаданных образа. Включается только для томов, созданных из образа или из снимка тома, изначально созданного из образа.

Возвращается: при успешном выполнении

volume_type

string

Имя типа, связанного с томом.

Возвращается: при успешном выполнении

Авторы

  • OpenStack Ansible SIG

Ссылки на коллекцию

  • Отслеживание ошибок
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/volume_module.html

Spec-Zone.ru

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