openstack.cloud.os_volume_snapshot – Создание/удаление снимков томов Cinder
Примечание
Этот плагин входит в коллекцию openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в плейбуке укажите: openstack.cloud.os_volume_snapshot.
Описание
- Создание или удаление снимков томов блочного хранения Cinder
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать сокетная прослойка, прежде чем сбросить таймаут для API-вызовов. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| 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 булево |
| Разрешает или запрещает создание снимка тома, когда том подключён к экземпляру. |
| interface строка |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| region_name строка | Имя региона. | |
| state строка |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout целое число | По умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемого ресурса. |
| validate_certs булево |
| Необходимо ли проверять SSL-API-запросы. До 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, затем из стандартных переменных окружения, и, наконец, из явных параметров в плейбуках. Дополнительную информацию можно найти по адресу https://docs.openstack.org/openstacksdk/
Примеры
# Creates a snapshot on volume 'test_volume'
- name: create and delete snapshot
hosts: localhost
tasks:
- name: create snapshot
openstack.cloud.volume_snapshot:
state: present
cloud: mordred
availability_zone: az2
display_name: test_snapshot
volume: test_volume
- name: delete snapshot
openstack.cloud.volume_snapshot:
state: absent
cloud: mordred
availability_zone: az2
display_name: test_snapshot
volume: test_volume
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| snapshot словарь | успех | Экземпляр снимка после изменения Пример: {'display_name': 'test_snapshot', 'id': '837aca54-c0ee-47a2-bf9a-35e1b4fdac0c', 'name': 'test_snapshot', 'size': 2, 'status': 'available', 'volume_id': 'ec646a7c-6a35-4857-b38b-808105a24be6'} |
Авторы
- 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/os_volume_snapshot_module.html
