Модуль openstack.cloud.volume_snapshot – создание/удаление снимков томов Cinder

Примечание

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

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

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

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

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создание или удаление снимков блочных томов 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.
ca_cert псевдонимы: cacert string	Путь к пакету сертификатов CA, который можно использовать для проверки запросов 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	Описание снимка
force boolean	Разрешает или запрещает создание снимка тома, подключённого к экземпляру. Варианты: `false` ← (по умолчанию) `true`
interface псевдонимы: endpoint_type string	Тип URL конечной точки, получаемый из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name псевдонимы: display_name string / обязательный	Имя снимка
region_name string	Название региона.
sdk_log_level string	Уровень журналирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается.
state string	Следует ли `present` или `absent` снимок. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout integer	Время ожидания Ansible для запрошенного ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify boolean	Следует ли проверять запросы API по SSL. До Ansible 2.3 значением по умолчанию было `true`. Варианты: `false` `true`
volume string	Имя или идентификатор тома, для которого создаётся снимок. Обязателен, если значение state — `present`.
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/

Примеры

- name: create snapshot
  openstack.cloud.volume_snapshot:
    state: present
    cloud: mordred
    name: test_snapshot
    volume: test_volume
- name: delete snapshot
  openstack.cloud.volume_snapshot:
    state: absent
    cloud: mordred
    name: test_snapshot
    volume: test_volume

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

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

Ключ	Описание
snapshot dictionary	То же, что и `volume_snapshot`; сохранено для обратной совместимости. Возвращается: При успешном выполнении, если `state=present`
volume_snapshot dictionary	Экземпляр снимка Возвращается: success
created_at string	Время создания снимка. Возвращается: success
description string	Описание снимка. Возвращается: success
id string	Уникальный UUID. Возвращается: success Пример: `"39007a7e-ee4f-4d13-8283-b4da2e037c69"`
is_forced boolean	Указывает, следует ли создавать снимок, даже если том подключён. Возвращается: success
metadata dictionary	Метаданные снимка. Возвращается: success
name string	Имя снимка. Возвращается: success
progress string	Текущий процент готовности снимка. Возвращается: success
project_id string	Идентификатор проекта, с которым связан этот снимок. Возвращается: success
size integer	Размер тома в ГБ. Возвращается: success
status string	Статус снимка. Возвращается: success
updated_at string	Время обновления снимка. Возвращается: success
volume_id string	Идентификатор тома. Возвращается: success

Авторы

Специальная группа OpenStack Ansible

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

© 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_snapshot_module.html