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