os_volume - Создание/удаление томов Cinder
Новая версия с 2.0.
Описание
- Создание или удаление томов хранения cinder.
Требования (для хоста, выполняющего модуль)
- python >= 2.6
- python >= 2.7
- shade
Параметры
| параметр | обязательный | значение по умолчанию | допустимые значения | комментарии |
|---|---|---|---|---|
| api_timeout | нет | None | Сколько времени должна ждать сокетная часть, прежде чем произойдет таймаут вызова API. Если это значение опущено, ничего не будет передано в библиотеку requests. | |
| auth | нет | Словарь, содержащий информацию об авторизации, необходимую для стратегии плагина авторизации облака. Для плагина по умолчанию password, он должен содержать auth_url, username, password, project_name и любую информацию о доменах, если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*. | ||
| auth_type | нет | password | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной авторизации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone | нет | Игнорируется. Присутствует для обратной совместимости. | ||
| cacert | нет | None | Путь к пакету сертификатов CA, который может использоваться для проверки запросов API SSL. | |
| cert | нет | None | Путь к клиенту сертификат, используемый в рамках транзакции SSL. | |
| cloud | нет | Используемое облако. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если предоставлен параметр auth или присутствуют переменные окружения OpenStack OS_*. | ||
| display_description | нет | None | Строка, описывающая том. | |
| display_name | да | Имя тома. | ||
| endpoint_type | нет | public |
| Тип URL конечной точки для извлечения из каталога службы. |
| image | нет | None | Имя или идентификатор образа для загрузки с тома. | |
| key | нет | None | Путь к ключу клиента, используемому в рамках транзакции SSL. | |
| region_name | нет | Имя региона. | ||
| scheduler_hints (добавлен в 2.4)
| нет | None | Подсказки планировщика, передаваемые API томов в формате словаря. | |
| size | нет | None | Размер тома в ГБ. Этот параметр обязателен, когда параметр state равен 'present'. | |
| snapshot_id | нет | None | Идентификатор снимка тома для создания. | |
| state | нет | present |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout | нет | 180 | Сколько времени Ansible должен ждать запрошенного ресурса. | |
| validate_certs | нет | Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: verify | ||
| volume (добавлен в 2.3)
| нет | None | Имя или идентификатор тома для создания. | |
| volume_type | нет | None | Тип тома. | |
| wait | нет | yes |
| Должен ли Ansible ждать, пока запрошенный ресурс завершится? |
Примеры
# 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
Примечания
Примечание
- Могут использоваться стандартные переменные окружения 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
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Для получения помощи в разработке модулей, если вы заинтересованы, прочитайте Community Information & Contributing, Testing Ansible и Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/os_volume_module.html