os_volume_snapshot – Создание/удаление снимков томов Cinder
Новая версия с 2.6.
Описание
- Создание или удаление снимков блочных хранилищ томов cinder
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Время ожидания сокета при вызовах API до истечения времени ожидания. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина password он будет содержать auth_url, username, password, project_name и любую информацию о доменах (например, os_user_domain_name или os_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 строка добавлен в 2.3 |
| Тип 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
os_volume_snapshot:
state: present
cloud: mordred
availability_zone: az2
display_name: test_snapshot
volume: test_volume
- name: delete snapshot
os_volume_snapshot:
state: absent
cloud: mordred
availability_zone: az2
display_name: test_snapshot
volume: test_volume
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| snapshot словарь | успех | Экземпляр снимка после изменения Пример: {'id': '837aca54-c0ee-47a2-bf9a-35e1b4fdac0c', 'name': 'test_snapshot', 'volume_id': 'ec646a7c-6a35-4857-b38b-808105a24be6', 'size': 2, 'status': 'available', 'display_name': 'test_snapshot'} |
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [предварительный]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- Mario Santos (@ruizink)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/os_volume_snapshot_module.html
