openstack.cloud.volume_backup_info – Получение резервных копий
Примечание
Этот плагин входит в состав коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в playbook, укажите: openstack.cloud.volume_backup_info.
Описание
- Получение информации о резервных копиях из облака Openstack.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Время ожидания сокета при тайм-ауте API-запросов. Если этот параметр опущен, библиотеке запросов ничего не будет передано. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии подключаемого модуля авторизации облака. Для стандартного подключаемого модуля «пароль» он будет содержать значения «auth_url», «username», «password», «project_name» и любую информацию о доменах (например, «user_domain_name» или «project_domain_name»), если облако их поддерживает. Для других подключаемых модулей этот параметр должен содержать все необходимые параметры подключаемого модуля авторизации. Этот параметр не требуется, если предоставлен указанный облачный ресурс или присутствуют переменные среды OpenStack OS_*. | |
| auth_type строка | Имя подключаемого модуля авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, здесь должно быть указано имя подключаемого модуля, и содержимое параметра «auth» должно быть соответствующим образом обновлено. | |
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости. | |
| ca_cert строка | Путь к пакету сертификатов CA, который может быть использован для проверки запросов API SSL. псевдонимы: cacert | |
| client_cert строка | Путь к клиенту сертификату для использования в рамках транзакции SSL. псевдонимы: cert | |
| client_key строка | Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key | |
| cloud необработанные данные | Именованное облако или конфигурация облака для работы. Если «cloud» — строка, она ссылается на именованную конфигурацию облака, определённую в файле openstack clouds.yaml. Предоставляет значения по умолчанию для «auth» и «auth_type». Этот параметр не требуется, если предоставлен «auth» или присутствуют переменные среды OpenStack OS_*. Если «cloud» — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| interface строка |
| Тип URL конечной точки для получения из каталога служб. псевдонимы: endpoint_type |
| name строка | Имя резервной копии. | |
| region_name строка | Имя региона. | |
| timeout целое число | По умолчанию: 180 | Время ожидания Ansible для запрошенного ресурса. |
| validate_certs логическое значение |
| Требуется ли проверка запросов API SSL. Перед Ansible 2.3 это значение по умолчанию было yes.псевдонимы: verify |
| volume строка | Имя тома. | |
| wait логическое значение |
| Ansible должен ожидать завершения запрошенного ресурса? |
Примечания
Примечание
- Можно использовать стандартные переменные среды OpenStack, такие как
OS_USERNAME, вместо явного указания значений. - Информация об авторизации управляется openstacksdk, что означает, что значения могут быть взяты из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, и, наконец, из явных параметров в playbooks. Дополнительную информацию можно найти на https://docs.openstack.org/openstacksdk/
Примеры
# Get backups.
- openstack.cloud.volume_backup_info:
register: backup
- openstack.cloud.volume_backup_info:
name: my_fake_backup
register: backup
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| volume_backups список / элементы=словарь | всегда. | Список словарей, описывающих резервные копии томов. | |
| availability_zone строка | успех | Зона доступности резервной копии. | |
| created_at строка | успех | Время создания резервной копии. | |
| description строка | успех | Описание резервной копии. | |
| id строка | успех | Уникальный UUID. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69 | |
| is_incremental логическое значение | успех | Свойство инкрементальной резервной копии. | |
| metadata словарь | успех | Метаданные резервной копии. | |
| name строка | успех | Имя резервной копии. | |
| snapshot_id строка | успех | ID моментального снимка. | |
| status строка | успех | Статус резервной копии. | |
| updated_at строка | успех | Время обновления резервной копии. | |
| volume_id строка | успех | ID тома. | |
Авторы
- OpenStack Ansible SIG
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/openstack/cloud/volume_backup_info_module.html
