os_volume - Создание/Удаление томов Cinder
Новая версия с 2.0.
Описание
- Создание или удаление блочных хранилищ Cinder
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout | Сколько времени слой сокета должен ожидать перед истечением времени ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку запросов. | |
| auth | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для стандартного плагина password он должен содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры. Этот параметр не требуется, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | |
| auth_type | Имя плагина авторизации для использования. Если облако использует что-то кроме аутентификации по паролю, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | Игнорируется. Присутствует для обратной совместимости | |
| cacert | Путь к файлу сертификата CA, который может использоваться для проверки запросов API SSL. | |
| cert | Путь к клиенту сертификат для использования в процессе SSL-транзакции. | |
| cloud | Имя облака или конфигурация облака для работы. Если cloud является строкой, она ссылается на конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если задан параметр auth или присутствуют переменные окружения OpenStack OS_* . Если cloud является словарем, он содержит полную конфигурацию облака, как в разделе clouds.yaml. | |
| display_description | Строка, описывающая том | |
| display_name обязательно | Имя тома | |
| image | Имя или идентификатор образа для загрузки из тома | |
| interface (добавлено в 2.3) |
| Тип URL-адреса конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| key | Путь к клиенту ключ для использования в процессе SSL-транзакции. | |
| region_name | Имя региона. | |
| scheduler_hints (добавлено в 2.4) | Подсказки планировщика, передаваемые API томов в виде словаря | |
| size | Размер тома в ГБ. Этот параметр требуется, когда параметр state равен 'present'. | |
| snapshot_id | Идентификатор снимка тома для создания из него | |
| state |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемый ресурс. |
| verify bool |
| Нужно ли проверять запросы API SSL. До версии 2.3 значение по умолчанию было True. псевдонимы: validate_certs |
| volume (добавлено в 2.3) | Имя или идентификатор тома для создания из него | |
| volume_type | Тип тома для тома | |
| 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 new volume
- name: create a volume
hosts: localhost
tasks:
- name: create 40g test volume
os_volume:
state: present
cloud: mordred
availability_zone: az2
size: 40
display_name: test_volume
scheduler_hints:
same_host: 243e8d3c-8f47-4a61-93d6-7215c344b0c0
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в Техническом обслуживании и поддержке модулей.
Список других модулей, поддерживаемых сообществом Ansible, см. здесь.
Автор
- Monty Taylor (@emonty)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_module.html
