Модуль openstack.cloud.volume_manage — управление томами и снятие с управления
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать его в сценарии, укажите: openstack.cloud.volume_manage.
Краткое описание
- Управление томами в OpenStack и снятие их с управления.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Описание |
|---|---|
api_timeout целое число | В течение какого времени уровень сокетов должен ожидать ответ перед истечением времени ожидания вызовов API. Если параметр не указан, библиотеке requests ничего не передаётся. |
auth словарь | Словарь с данными аутентификации, необходимыми выбранной стратегии плагина аутентификации облака. Для плагина password, используемого по умолчанию, здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые соответствующему плагину аутентификации. Этот параметр не требуется, если указано именованное облако или присутствуют переменные среды OpenStack OS_*. |
auth_type строка | Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя плагина и соответствующим образом обновить содержимое параметра auth. |
availability_zone строка | Зона доступности. |
bootable логическое значение | Флаг загрузочного тома. Варианты:
|
ca_cert псевдонимы: cacert строка | Путь к пакету сертификатов ЦС, который можно использовать для проверки запросов к API по SSL. |
client_cert псевдонимы: cert строка | Путь к сертификату клиента, используемому при SSL-соединении. |
client_key псевдонимы: key строка | Путь к ключу клиента, используемому при SSL-соединении. |
cloud любой тип | Именованное облако или конфигурация облака, с которыми следует работать. Если cloud — строка, она ссылается на именованную конфигурацию облака, заданную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или присутствуют переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml. |
description строка | Строка с описанием тома |
host строка | Узел Cinder, на котором расположен существующий том Формат: «host@backend-name#pool» Обязателен, если значение state — |
interface псевдонимы: endpoint_type строка | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
metadata словарь | Метаданные тома |
name строка / обязательный | Имя тома, управление которым требуется снять, или новое имя тома, который требуется взять под управление Если значение state — |
region_name строка | Название региона. |
sdk_log_level строка | Уровень журналирования OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся |
source_id строка | Идентификатор существующего тома |
source_name строка | Имя существующего тома |
state строка | Должен ли ресурс присутствовать или отсутствовать. Варианты:
|
timeout целое число | В течение какого времени Ansible должен ожидать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify логическое значение | Нужно ли проверять запросы к API по SSL. До Ansible 2.3 значением по умолчанию было Варианты:
|
volume_type строка | Тип тома |
wait логическое значение | Должен ли Ansible ожидать завершения операции с запрошенным ресурсом. Варианты:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например
OS_USERNAME. - Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из файла конфигурации YAML /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно заданных параметров сценариев. Дополнительные сведения см. на странице https://docs.openstack.org/openstacksdk/
Примеры
- name: Manage volume
openstack.cloud.volume_manage:
name: newly-managed-vol
source_name: manage-me
host: host@backend-name#pool
- name: Unmanage volume
openstack.cloud.volume_manage:
name: "5c831866-3bb3-4d67-a7d3-1b90880c9d18"
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
volume dictionary | Представление объекта тома в Cinder Возвращается: всегда |
|
attachments list / elements=string |
Информация о подключении к экземпляру. Для неподключённого тома это поле всегда пусто. Возвращается: при успехе |
|
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 |
Имя типа, связанного с томом. Возвращается: при успехе |
Ссылки на коллекцию
© 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_manage_module.html