os_volume - Создание/удаление томов Cinder
Новое в версии 2.0.
Обзор
- Создание или удаление томов хранения блоков cinder
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- python >= 2.6
- python >= 2.7
- shade
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| 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 | По умолчанию: None | Строка, описывающая том |
| display_name обязательно | Имя тома | |
| image | По умолчанию: None | Имя или идентификатор образа для загрузки с тома |
| interface (добавлено в 2.3) |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| key | Путь к ключу клиента для использования в рамках транзакции SSL. | |
| region_name | Название региона. | |
| scheduler_hints (добавлено в 2.4) | По умолчанию: None | Подсказки планировщика, переданные в API томов в виде словаря |
| size | По умолчанию: None | Размер тома в ГБ. Этот параметр требуется, когда параметр state равен 'present'. |
| snapshot_id | По умолчанию: None | Идентификатор снимка тома для создания из него |
| state |
| Ресурс должен быть присутствующим или отсутствующим. |
| timeout | По умолчанию: 180 | Сколько времени Ansible должно ждать запрошенного ресурса. |
| verify |
| Необходимо ли проверять запросы SSL API. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| volume (добавлено в 2.3) | По умолчанию: None | Имя или идентификатор тома для создания из него |
| volume_type | По умолчанию: None | Тип тома для тома |
| wait |
| Должен ли 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
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Автор
- 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.5/modules/os_volume_module.html
