openstack.cloud.volume_backup – Добавление/Удаление резервной копии тома

Примечание

Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).

Для его установки используйте: ansible-galaxy collection install openstack.cloud.

Для использования в книге задач укажите: openstack.cloud.volume_backup.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Добавление или удаление резервной копии тома в OTC.

Требования

Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.

openstacksdk
openstacksdk >= 0.12.0
python >= 3.6

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_timeout целое число		Сколько времени должна ждать сокетная связь перед тем, как истечёт время ожидания для вызовов API. Если это опущено, библиотеке запросов ничего не будет передано.
auth словарь		Словарь, содержащий информацию об авторизации, необходимую стратегии плагина аутентификации облака. Для стандартного плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина аутентификации. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type строка		Имя плагина аутентификации для использования. Если облако использует что-то отличное от аутентификации по паролю, здесь должно быть указано имя плагина, а содержимое параметра auth должно быть соответствующим образом обновлено.
availability_zone строка		Игнорируется. Присутствует для обратной совместимости
ca_cert строка		Путь к пакету сертификатов CA, который можно использовать для проверки запросов SSL API. псевдонимы: cacert
client_cert строка		Путь к клиенту сертификату для использования в рамках транзакции SSL. псевдонимы: cert
client_key строка		Путь к ключу клиента для использования в рамках транзакции SSL. псевдонимы: key
cloud сырые данные		Именованное облако или конфигурация облака для работы с ним. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или присутствуют переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, аналогичную той, которая находится в разделе clouds.yaml.
display_description строка		Строка, описывающая резервную копию псевдонимы: description
display_name строка / обязательный		Имя, которое должно быть дано резервной копии псевдонимы: name
force булево	Варианты: нет ← да	Указывает, нужно ли создать резервную копию, даже если том подключён.
incremental булево	Варианты: нет ← да	Режим резервного копирования
interface строка	Варианты: admin internal public ←	Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type
metadata словарь		Метаданные для резервной копии
region_name строка		Название региона.
snapshot строка		Имя или идентификатор моментального снимка для резервного копирования
state строка	Варианты: present ← absent	Ресурс должен быть присутствующим или отсутствующим.
timeout целое число	По умолчанию: 180	Сколько времени Ansible должно ждать запрашиваемого ресурса.
validate_certs булево	Варианты: нет ← да	Необходимо ли проверять запросы SSL API. До Ansible 2.3 это по умолчанию было `yes`. псевдонимы: verify
volume строка		Имя или ID тома. Требуется, когда состояние равно True.
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: Create backup
  openstack.cloud.volume_backup:
    display_name: test_volume_backup
    volume: "test_volume"

- name: Create backup from snapshot
  openstack.cloud.volume_backup:
    display_name: test_volume_backup
    volume: "test_volume"
    snapshot: "test_snapshot"

- name: Delete volume backup
  openstack.cloud.volume_backup:
    display_name: test_volume_backup
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ		Возвращаемое значение	Описание
backup сложное		При успешном выполнении, когда `state=present`	Словарь, описывающий кластер.
	id строка	успех	Уникальный UUID. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69
	name строка	успех	Имя, заданное балансировщику нагрузки. Пример: elb_test
id строка		При успешном выполнении, когда `state=present`	Идентификатор резервной копии тома. Пример: 39007a7e-ee4f-4d13-8283-b4da2e037c69

Авторы

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_module.html