Модуль openstack.cloud.server_volume — подключение и отключение томов виртуальных машин OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для работы с этим модулем потребуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.server_volume.
Краткое описание
- Подключение и отключение томов виртуальных машин OpenStack
Требования
Следующие требования необходимы на хосте, на котором выполняется этот модуль.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Комментарии |
|---|---|
api_timeout целое число | Время ожидания на уровне сокета перед истечением времени ожидания вызовов API. Если параметр не указан, библиотеке requests ничего не передаётся. |
auth словарь | Словарь с данными аутентификации, необходимыми для используемой облачной стратегии модуля аутентификации. Для стандартного модуля password здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других модулей этот параметр должен содержать необходимые им параметры. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*. |
auth_type строка | Имя используемого модуля аутентификации. Если облако использует не парольную аутентификацию, укажите здесь имя модуля и соответственно измените содержимое параметра auth. |
ca_cert псевдонимы: cacert строка | Путь к пакету сертификатов CA, который можно использовать для проверки запросов API SSL. |
client_cert псевдонимы: cert строка | Путь к клиентскому сертификату, используемому при SSL-транзакции. |
client_key псевдонимы: key строка | Путь к клиентскому ключу, используемому при SSL-транзакции. |
cloud любой тип | Именованное облако или конфигурация облака, с которым нужно работать. Если cloud — строка, она ссылается на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу файла clouds.yaml. |
device строка | Устройство, которое нужно подключить. По умолчанию имя устройства определяется автоматически. |
interface псевдонимы: endpoint_type строка | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
region_name строка | Имя региона. |
sdk_log_level строка | Уровень журналирования OpenStackSDK Варианты:
|
sdk_log_path строка | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается. |
server строка / обязательный | Имя или ID сервера, к которому нужно подключить том. |
state строка | Должен ли ресурс присутствовать или отсутствовать. Варианты:
|
timeout целое число | Как долго Ansible должен ожидать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify логический | Следует ли проверять запросы API SSL. До Ansible 2.3 значением по умолчанию было Варианты:
|
volume строка / обязательный | Имя или ID тома, который нужно подключить к серверу. |
wait логический | Должен ли Ansible ожидать завершения операции с запрошенным ресурсом. Варианты:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например
OS_USERNAME. - Обработка данных аутентификации выполняется openstacksdk, поэтому значения могут поступать из файла конфигурации yaml /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно заданных параметров в плейбуках. Дополнительная информация доступна по адресу https://docs.openstack.org/openstacksdk/
Примеры
- name: Attaches a volume to a compute host
openstack.cloud.server_volume:
state: present
cloud: mordred
server: Mysql-server
volume: mysql-data
device: /dev/vdb
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
volume словарь | Только что подключённый том. Возвращается: при успешном выполнении, если state имеет значение present |
|
attachments список / элементы=строка |
Сведения о подключении экземпляра. Если этот том подключён к экземпляру сервера, список attachments содержит UUID подключённого сервера, UUID подключения, имя подключённого хоста (если есть), UUID тома, устройство и UUID устройства. В противном случае список пуст. Возвращается: при успешном выполнении |
|
availability_zone строка |
Имя зоны доступности. Возвращается: при успешном выполнении |
|
consistency_group_id строка |
UUID группы согласованности. Возвращается: при успешном выполнении |
|
created_at строка |
Дата и время создания ресурса. Возвращается: при успешном выполнении |
|
description строка |
Описание тома. Возвращается: при успешном выполнении |
|
extended_replication_status строка |
Расширенный статус репликации этого тома. Возвращается: при успешном выполнении |
|
group_id строка |
ID группы. Возвращается: при успешном выполнении |
|
host строка |
Текущая серверная часть тома. Возвращается: при успешном выполнении |
|
id строка |
UUID тома. Возвращается: при успешном выполнении |
|
image_id строка |
Образ, на основе которого создан том. Возвращается: при успешном выполнении |
|
is_bootable строка |
Включает или отключает атрибут загрузочного тома. Экземпляр можно загрузить с загрузочного тома. Возвращается: при успешном выполнении |
|
is_encrypted логический |
Если значение равно true, том зашифрован. Возвращается: при успешном выполнении |
|
metadata словарь |
Объект метаданных. Содержит одну или несколько пар «ключ — значение», связанных с томом. Возвращается: при успешном выполнении |
|
migration_id строка |
ID тома, на основе которого задано имя этого тома на серверной части. Возвращается: при успешном выполнении |
|
migration_status строка |
Статус миграции этого тома (значение None означает, что миграция в данный момент не выполняется). Возвращается: при успешном выполнении |
|
name строка |
Имя тома. Возвращается: при успешном выполнении |
|
project_id строка |
ID проекта, которому принадлежит том. Возвращается: при успешном выполнении |
|
replication_driver_data строка |
Данные, заданные драйвером репликации. Возвращается: при успешном выполнении |
|
replication_status строка |
Статус репликации тома. Возвращается: при успешном выполнении |
|
scheduler_hints словарь |
Подсказки планировщика для тома. Возвращается: при успешном выполнении |
|
size целое число |
Размер тома в гибибайтах (GiB). Возвращается: при успешном выполнении |
|
snapshot_id строка |
Чтобы создать том на основе существующего снимка, укажите UUID снимка тома. Том создаётся в той же зоне доступности и того же размера, что и снимок. Возвращается: при успешном выполнении |
|
source_volume_id строка |
UUID исходного тома. API создаёт новый том того же размера, что и исходный, если не запрошен больший размер. Возвращается: при успешном выполнении |
|
status строка |
Статус тома. Возвращается: при успешном выполнении |
|
updated_at строка |
Дата и время обновления ресурса. Возвращается: при успешном выполнении |
|
user_id строка |
UUID пользователя. Возвращается: при успешном выполнении |
|
volume_image_metadata словарь |
Список записей метаданных образа. Включается только для томов, созданных из образа или из снимка тома, изначально созданного из образа. Возвращается: при успешном выполнении |
|
volume_type строка |
Имя связанного с томом типа тома. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/openstack/cloud/server_volume_module.html
