Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию openstack.cloud (версия 2.2.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. Если этот параметр опущен, ничего не будет передано в библиотеку запросов.

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

aliases: cacert

string

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

client_cert

aliases: cert

string

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

client_key

aliases: key

string

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

cloud

any

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

description

aliases: display_description

string

Строка, описывающая том

image

string

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

Взаимоисключающий с snapshot и volume

interface

aliases: endpoint_type

string

Тип URL-адреса конечной точки для извлечения из каталога служб.

Варианты:

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

is_bootable

aliases: bootable

boolean

Флаг загрузки для тома.

Варианты:

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

is_multiattach

boolean

Будет ли том доступен для общего использования или нет.

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

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

Значение is_multiattach по умолчанию в Cinder — false.

Варианты:

  • false
  • true

metadata

dictionary

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

name

aliases: display_name

string / required

Имя тома

region_name

string

Имя региона.

scheduler_hints

dictionary

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

sdk_log_level

string

Уровень логирования OpenStackSDK

Варианты:

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

sdk_log_path

string

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

размер

целое число

Размер тома в ГБ. Этот параметр требуется, когда параметр состояние равен ‘present’.

снимок

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

строка

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

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

состояние

строка

Должен ли ресурс быть present или absent.

Варианты:

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

таймаут

целое число

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

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

проверка_сертификатов

псевдонимы: проверка

логическое значение

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

До Ansible 2.3 это по умолчанию true.

Варианты:

  • false
  • true

том

строка

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

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

тип_тома

строка

Тип тома для тома.

ждать

логическое значение

Должен ли 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

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

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

Key

Description

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

ID группы.

Возвращается: успех

host

string

Текущий бэкэнд тома.

Возвращается: успех

id

string

UUID тома.

Возвращается: успех

image_id

string

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

Возвращается: успех

is_bootable

string

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

Возвращается: успех

is_encrypted

boolean

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

Возвращается: успех

is_multiattach

boolean

Может ли этот том быть прикреплен к более чем одному серверу.

Возвращается: успех

metadata

dictionary

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

Возвращается: успех

migration_id

string

ID тома, на основе которого построено это имя тома на бэкэнде.

Возвращается: успех

migration_status

string

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

Возвращается: успех

name

string

Имя тома.

Возвращается: успех

project_id

string

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

Возвращается: успех

replication_driver_data

string

Набор данных драйвером репликации

Возвращается: успех

replication_status

string

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

Возвращается: успех

scheduler_hints

dictionary

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

Возвращается: успех

размер

целое число

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

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

snapshot_id

строка

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

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

source_volume_id

строка

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

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

статус

строка

Статус тома.

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

updated_at

строка

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

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

user_id

строка

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

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

volume_image_metadata

словарь

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

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

тип_тома

строка

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

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

Авторы

  • OpenStack Ansible SIG

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

  • Система отслеживания задач
  • Репозиторий (исходники)

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

Spec-Zone.ru

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