os_volume – Создание/удаление объёмов Cinder
Новая версия 2.0.
Описание
- Создание или удаление объёмов хранилища 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, который можно использовать для проверки запросов 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 boolean |
| Нужно ли проверять запросы API SSL. До версии 2.3 по умолчанию было True. псевдонимы: validate_certs |
| volume - добавлено в 2.3 | Имя или идентификатор объёма для создания из него. | |
| volume_type - | Тип объёма для объёма. | |
| 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 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. [community]
Авторы
- 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.7/modules/os_volume_module.html