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

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_timeout целое число	Сколько времени должно ждать сокет-слой перед таймаутом вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов.
auth словарь	Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, требуемые плагином авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка	Имя плагина авторизации для использования. Если облако использует что-то помимо парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть обновлено соответственно.
ca_cert псевдонимы: cacert строка	Путь к пакету CA Cert, который может использоваться для проверки запросов SSL API.
client_cert псевдонимы: cert строка	Путь к клиенту сертификату для использования в рамках транзакции SSL.
client_key псевдонимы: key строка	Путь к клиентскому ключу для использования в рамках транзакции SSL.
cloud любой	Именованное облако или конфигурация облака для работы с ним. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или присутствуют переменные окружения OpenStack OS_* . Если cloud — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
description псевдонимы: display_description строка	Строка, описывающая снимок.
force булево	Разрешает или запрещает создание снимка тома, когда том подключен к экземпляру. Варианты: `false` ← (по умолчанию) `true`
interface псевдонимы: endpoint_type строка	Тип URL конечной точки для извлечения из каталога служб. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name псевдонимы: display_name строка / обязательный	Имя снимка
region_name строка	Имя региона.
sdk_log_level строка	Уровень логирования OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path строка	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается.
state строка	Должен ли снимок быть `present` или `absent`. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs псевдонимы: verify булево	Нужно ли проверять запросы API SSL. До Ansible 2.3 по умолчанию было `true`. Варианты: `false` `true`
volume строка	Имя или ID тома для создания снимка. Требуется, когда 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 словарь	То же, что и `volume_snapshot`, сохранено для обратной совместимости. Возвращается: При успехе, когда `state=present`
volume_snapshot словарь	Экземпляр снимка Возвращается: успех
created_at строка	Время создания снимка. Возвращается: успех
description строка	Описание снимка. Возвращается: успех
id строка	Уникальный UUID. Возвращается: успех Пример: `"39007a7e-ee4f-4d13-8283-b4da2e037c69"`
is_forced логическое	Указывает, нужно ли создавать снимок, даже если том подключен. Возвращается: успех
metadata словарь	Метаданные снимка. Возвращается: успех
name строка	Имя снимка. Возвращается: успех
progress строка	Процент завершения снимка на данный момент. Возвращается: успех
project_id строка	Идентификатор проекта, с которым связан этот снимок. Возвращается: успех
size целое число	Размер тома в ГБ. Возвращается: успех
status строка	Статус снимка. Возвращается: успех
updated_at строка	Время обновления снимка. Возвращается: успех
volume_id строка	Идентификатор тома. Возвращается: успех

Авторы

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