Модуль openstack.cloud.volume_backup_info — получение резервных копий
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для работы с этим модулем необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в сценарии, укажите: openstack.cloud.volume_backup_info.
Краткое описание
- Получение сведений о резервных копиях из облака 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. |
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
name string | Имя резервной копии. |
region_name string | Имя региона. |
sdk_log_level string | Уровень ведения журнала OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не ведется. |
timeout integer | Сколько времени Ansible должен ожидать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify boolean | Следует ли проверять запросы API по SSL. До Ansible 2.3 значением по умолчанию было Варианты:
|
volume string | Имя или идентификатор тома. |
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: Get all backups
openstack.cloud.volume_backup_info:
- name: Get backup 'my_fake_backup'
openstack.cloud.volume_backup_info:
name: my_fake_backup
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
volume_backups list / elements=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_info_module.html