os_volume – Создание/удаление томов Cinder
Новое в версии 2.0.
Описание
- Создание или удаление томов хранения cinder.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- openstacksdk
- python >= 2.7
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_timeout целое число | Сколько времени должна ждать система сокетов, прежде чем истечет время ожидания для вызовов API. Если этот параметр опущен, он не будет передан в библиотеку requests. | |
| auth словарь | Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password, он будет содержать auth_url, username, password, project_name и любую информацию о доменных зонах (например, os_user_domain_name или os_project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать параметры, требуемые этим плагином авторизации. Этот параметр не требуется, если предоставлен именованное облако или присутствуют переменные среды OpenStack OS_*. | |
| auth_type строка | Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, имя плагина должно быть указано здесь, и содержимое параметра auth должно быть соответствующим образом обновлено. | |
| availability_zone - | Игнорируется. Присутствует для обратной совместимости. | |
| ca_cert строка | Путь к пакету CA-сертификатов, который можно использовать для проверки запросов API SSL. псевдонимы: 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 - | Строка, описывающая том. | |
| display_name - / обязательно | Имя тома. | |
| image - | Имя или ID образа для загрузки с тома. | |
| interface строка добавлено в 2.3 |
| Тип URL конечной точки для извлечения из каталога служб. псевдонимы: endpoint_type |
| metadata - добавлено в 2.8 | Метаданные для тома. | |
| region_name строка | Имя региона. | |
| scheduler_hints - добавлено в 2.4 | Подсказки планировщика, передаваемые в API томов в виде словаря. | |
| size - | Размер тома в ГБ. Этот параметр обязателен, когда параметр state равен 'present'. | |
| snapshot_id - | ID моментального снимка тома для создания из него. | |
| state - |
| Ресурс должен присутствовать или отсутствовать. |
| timeout целое число | Значение по умолчанию: 180 | Сколько времени Ansible должен ждать запрашиваемый ресурс. |
| validate_certs булево |
| Должны ли проверяться запросы API SSL. До версии Ansible 2.3 значение по умолчанию было yes. псевдонимы: verify |
| volume - добавлено в 2.3 | Имя или 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
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. [сообщество]
Авторы
- 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.8/modules/os_volume_module.html
