Модуль openstack.cloud.volume_backup — добавление/удаление резервной копии тома
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования. Подробнее см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.volume_backup.
Краткое описание
- Добавление или удаление резервной копии тома в OpenStack.
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- 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 | Указывает, следует ли создавать резервную копию, даже если том подключён. Варианты:
|
interface псевдонимы: endpoint_type string | Тип URL конечной точки, который следует получить из каталога служб. Варианты:
|
is_incremental псевдонимы: incremental boolean | Режим резервного копирования Варианты:
|
metadata dictionary | Метаданные резервной копии |
name псевдонимы: display_name string / обязательный | Имя, которое необходимо присвоить резервной копии |
region_name string | Имя региона. |
sdk_log_level string | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведётся. |
snapshot string | Имя или идентификатор снимка, для которого создаётся резервная копия. |
state string | Должен ли ресурс присутствовать или отсутствовать. Варианты:
|
timeout integer | Время ожидания ansible для запрошенного ресурса. По умолчанию: |
validate_certs псевдонимы: verify boolean | Следует ли проверять запросы API SSL. До Ansible 2.3 значение по умолчанию было Варианты:
|
volume string | Имя или идентификатор тома. Обязателен, если значение 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 |
Если значение равно true, от этой резервной копии зависят другие резервные копии. Возвращается: при успешном выполнении |
|
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 |
Идентификатор снимка. Возвращается: при успешном выполнении |
|
status string |
Состояние резервной копии. Возвращается: при успешном выполнении |
|
updated_at string |
Время обновления резервной копии. Возвращается: при успешном выполнении |
|
user_id string |
UUID владельца проекта. Возвращается: при успешном выполнении |
|
volume_id 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_backup_module.html