openstack.cloud.os_volume – Создание/удаление томов Cinder
Примечание
Этот плагин является частью коллекции openstack.cloud (версия 1.2.1).
Для его установки используйте: ansible-galaxy collection install openstack.cloud.
Для использования в плейбуке укажите: openstack.cloud.os_volume.
Описание
- Создание или удаление блочных томов хранения cinder
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- openstacksdk
- openstacksdk >= 0.12.0
- python >= 3.6
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени слою сокетов следует ждать перед таймаутом вызовов API. Если это опущено, ничего не будет передано в библиотеку запросов. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменных зонах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, необходимые этому плагину авторизации. Этот параметр не требуется, если указано имя облака или присутствуют переменные среды OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, здесь должно быть указано имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone строка | Игнорируется. Присутствует для обратной совместимости | |
| bootable булево |
| Флаг bootable для тома. |
| 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 | |
| image строка | Имя или ID образа для загрузки с тома | |
| interface строка |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| metadata словарь | Метаданные тома | |
| region_name строка | Имя региона. | |
| scheduler_hints словарь | Подсказки планировщика, передаваемые API томов в виде словаря | |
| size целое число | Размер тома в ГБ. Этот параметр обязателен, когда параметр state равен 'present'. | |
| snapshot_id строка | ID снимка тома для создания из него | |
| state строка |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрошенного ресурса. |
| validate_certs булево |
| Необходимо ли проверять запросы SSL API. До Ansible 2.3 это значение по умолчанию было yes.псевдонимы: verify |
| volume строка | Имя или ID тома для создания из него | |
| volume_type строка | Тип тома для тома | |
| 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 new volume
- name: create a volume
hosts: localhost
tasks:
- name: create 40g test volume
openstack.cloud.volume:
state: present
cloud: mordred
availability_zone: az2
size: 40
display_name: test_volume
scheduler_hints:
same_host: 243e8d3c-8f47-4a61-93d6-7215c344b0c0
Авторы
- 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_module.html
