Модуль openstack.cloud.volume_backup_info – Получение резервных копий
Примечание
Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.
Для использования в playbook, укажите: openstack.cloud.volume_backup_info.
Краткое описание
- Получение информации о резервной копии из облака Openstack.
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
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, который может быть использован в качестве части проверки запросов API SSL. |
client_cert псевдонимы: cert строка | Путь к клиентскому сертификату, используемому в качестве части транзакции SSL. |
client_key псевдонимы: key строка | Путь к клиентскому ключу, используемому в качестве части транзакции SSL. |
cloud любой | Именованное облако или конфигурация облака для работы. Если cloud - строка, она ссылается на именованную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или если присутствуют переменные среды OpenStack OS_*. Если cloud - словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. |
interface псевдонимы: endpoint_type строка | Тип URL конечной точки для получения из каталога служб. Варианты:
|
name строка | Имя резервной копии. |
region_name строка | Имя региона. |
sdk_log_level строка | Уровень логирования OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается |
timeout целое число | Как долго ansible должен ждать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify логическое | Следует ли проверять запросы API SSL. До Ansible 2.3 это значение по умолчанию было Варианты:
|
volume строка | Имя или ID тома. |
wait логическое | Должен ли 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 |
Если это значение истинно, существуют другие резервные копии, зависящие от этой резервной копии. Возвращается: успех |
|
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 |
ID тома. Возвращается: успех |
Ссылки на сборку
© 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_info_module.html
