os_volume_snapshot - Создание/удаление снимков томов Cinder
Новое в версии 2.6.
Описание
- Создание или удаление снимков томов хранилища cinder.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени (в секундах) должна ожидать транспортный уровень перед таймаутом для API-запросов. Если это значение опущено, ничего не будет передано в библиотеку requests. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать любые параметры, необходимые плагину авторизации. Этот параметр не нужен, если предоставлен заданный облачный конфигурационный файл или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, а содержимое параметра auth должно быть обновлено соответственно. | |
| availability_zone | Зона доступности для создания снимка. | |
| cacert | Путь к пакету сертификатов CA, который может использоваться при проверке SSL-запросов к API. | |
| cert | Путь к клиенту сертификату для использования в рамках SSL-транзакции. | |
| cloud | Имя облака или конфигурация облака для работы. Если cloud является строкой, она ссылается на заданную конфигурацию облака, определенную в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен auth или присутствуют переменные окружения OpenStack OS_*. Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| display_description | Значение по умолчанию: null | Строка, описывающая снимок псевдонимы: описание |
| display_name обязательно | Имя снимка псевдонимы: имя | |
| force bool |
| Разрешает или запрещает создание снимка тома, когда том подключен к экземпляру. |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога сервиса. псевдонимы: тип_конечной_точки |
| key | Путь к ключу клиента для использования в рамках SSL-транзакции. | |
| region_name | Имя региона. | |
| state |
| Ресурс должен быть присутствовать или отсутствовать. |
| timeout | Значение по умолчанию: 180 | Сколько времени Ansible должно ждать запрашиваемого ресурса. |
| verify bool |
| Нужно ли проверять SSL API-запросы. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| volume обязательно | Имя или идентификатор тома для создания/удаления снимка. | |
| wait bool |
| Должен ли Ansible ждать, пока запрашиваемый ресурс завершит работу. |
Примечания
Примечание
- Можно использовать стандартные переменные окружения OpenStack, такие как
OS_USERNAME, вместо предоставления явных значений. - Информация об авторизации управляется os-client-config, что означает, что значения могут поступать из файла конфигурации yaml в /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды, а затем, наконец, из явных параметров в задачах. Дополнительную информацию можно найти по адресу http://docs.openstack.org/developer/os-client-config
Примеры
# 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': 'доступен', 'display_name': 'test_snapshot'} |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Более подробную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, которые также поддерживаются сообществом Ansible, см. здесь.
Автор
- 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.6/modules/os_volume_snapshot_module.html
