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 | Строка, описывающая снимок Псевдонимы: description |
| display_name - / обязательно | Имя снимка Псевдонимы: name | |
| force boolean |
| Разрешает или запрещает создание снимка тома, когда том подключен к экземпляру. |
| interface - добавлено в 2.3 |
| Тип URL конечной точки для извлечения из каталога служб. Псевдонимы: endpoint_type |
| key - | Путь к ключу клиента для использования в рамках SSL транзакции. | |
| region_name - | Имя региона. | |
| state - |
| Ресурс должен быть present или absent. |
| timeout - | По умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемого ресурса. |
| verify boolean |
| Необходимо ли проверять SSL API-запросы. До версии 2.3 по умолчанию было True. Псевдонимы: validate_certs |
| volume - / обязательно | Имя или ID тома для создания/удаления снимка | |
| wait boolean |
| Должен ли 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'} |
Статус
- Не гарантируется обратная совместимость интерфейса модуля. [preview]
- Этот модуль поддерживается сообществом 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.7/modules/os_volume_snapshot_module.html
