Модуль openstack.cloud.volume_backup – Добавление/Удаление резервной копии тома
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.
Для использования в playbook, укажите: openstack.cloud.volume_backup.
Краткое описание
- Добавление или удаление резервной копии тома в OpenStack.
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- 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 должно быть обновлено соответствующим образом. |
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 | Строка, описывающая резервную копию |
force boolean | Указывает, следует ли создавать резервную копию, даже если том присоединен. Варианты:
|
interface aliases: endpoint_type string | Тип URL конечной точки для извлечения из каталога служб. Варианты:
|
is_incremental aliases: incremental boolean | Режим резервного копирования Варианты:
|
metadata dictionary | Метаданные для резервной копии |
name aliases: display_name string / required | Имя, которое должно быть присвоено резервной копии |
region_name string | Имя региона. |
sdk_log_level string | Уровень логирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается |
snapshot string | Имя или ID снимка, резервную копию которого необходимо создать. |
state string | Должен ли ресурс присутствовать или отсутствовать. Варианты:
|
timeout integer | Как долго ansible должен ждать запрашиваемый ресурс. По умолчанию: |
validate_certs aliases: verify boolean | Следует ли проверять запросы к API SSL. До Ansible 2.3 это по умолчанию было Варианты:
|
volume string | Имя или ID тома. Обязательно, когда state — |
wait boolean | Должен ли ansible ждать, пока запрашиваемый ресурс не будет готов. Варианты:
|
Примечания
Примечание
- Этот модуль не поддерживает обновления существующих резервных копий.
- Вместо предоставления явных значений могут использоваться стандартные переменные среды OpenStack, такие как
OS_USERNAME. - Информация об авторизации управляется openstacksdk, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в пьесах. Более подробную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
- name: Create backup
openstack.cloud.volume_backup:
name: test_volume_backup
volume: "test_volume"
- name: Create backup from snapshot
openstack.cloud.volume_backup:
name: test_volume_backup
snapshot: "test_snapshot"
volume: "test_volume"
- name: Delete volume backup
openstack.cloud.volume_backup:
name: test_volume_backup
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
backup dictionary | То же, что и Возвращается: При успешном выполнении, когда |
volume_backup dictionary | Словарь, описывающий резервную копию тома. Возвращается: При успешном выполнении, когда |
|
availability_zone string |
Зона доступности резервной копии. Возвращается: успех |
|
container string |
Имя контейнера. Возвращается: успех |
|
created_at string |
Время создания резервной копии. Возвращается: успех |
|
data_timestamp string |
Время, когда данные на томе были сохранены впервые. Если это резервная копия с тома, она будет совпадать с Возвращается: успех |
|
description string |
Описание резервной копии. Возвращается: успех |
|
fail_reason string |
Причина сбоя резервного копирования. Возвращается: успех |
|
force boolean |
Принудительное резервное копирование. Возвращается: успех |
|
has_dependent_backups boolean |
Если это значение истинно, существуют другие резервные копии, зависящие от этой резервной копии. Возвращается: успех |
|
id string |
Уникальный UUID. Возвращается: успех Пример: |
|
is_incremental boolean |
Свойство инкрементального резервного копирования. Возвращается: успех |
|
links list / elements=string |
Список ссылок, связанных с этим томом. Возвращается: успех |
|
metadata dictionary |
Метаданные резервной копии. Возвращается: успех |
|
name string |
Имя резервной копии. Возвращается: успех |
|
object_count integer |
Количество объектов резервной копии. Возвращается: успех |
|
project_id string |
UUID проекта-владельца. Возвращается: успех |
|
size integer |
Размер тома в гибибайтах (GiB). Возвращается: успех |
|
snapshot_id string |
ID снимка. Возвращается: успех |
|
status string |
Статус резервной копии. Возвращается: успех |
|
updated_at string |
Время обновления резервной копии. Возвращается: успех |
|
user_id string |
UUID владельца проекта. Возвращается: успех |
|
volume_id string |
Идентификатор тома. Возвращено: success |
Ссылки на коллекцию
© 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_backup_module.html