openstack.cloud.server_volume модуль – Подключение/Отключение дисков к виртуальным машинам OpenStack
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.2.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 строка / обязательно | Имя или идентификатор сервера, к которому нужно подключить том. |
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 dictionary | Том, который только что был подключен Возвращается: При успехе, когда state имеет значение present |
|
attachments list / elements=string |
Информация о подключении экземпляра. Если этот том подключен к экземпляру сервера, список вложений включает в себя UUID подключенного сервера, UUID вложения, имя подключенного хоста (если есть), UUID тома, устройство и UUID устройства. В противном случае этот список пуст. Возвращается: при успехе |
|
availability_zone string |
Имя зоны доступности. Возвращается: при успехе |
|
consistency_group_id string |
UUID группы согласованности. Возвращается: при успехе |
|
created_at string |
Дата и время создания ресурса. Возвращается: при успехе |
|
description string |
Описание тома. Возвращается: при успехе |
|
extended_replication_status string |
Расширенный статус репликации на этом томе. Возвращается: при успехе |
|
group_id string |
ID группы. Возвращается: при успехе |
|
host string |
Текущий бэкэнд тома. Возвращается: при успехе |
|
id string |
UUID тома. Возвращается: при успехе |
|
image_id string |
Образ, на основе которого был создан том Возвращается: при успехе |
|
is_bootable string |
Включает или отключает атрибут загрузки. Вы можете загрузить экземпляр с загрузочного тома. Возвращается: при успехе |
|
is_encrypted boolean |
Если true, этот том зашифрован. Возвращается: при успехе |
|
metadata dictionary |
Объект метаданных. Содержит одну или несколько пар «ключ-значение» метаданных, связанных с томом. Возвращается: при успехе |
|
migration_id string |
ID тома, на основе которого основано это имя тома в бэкэнде. Возвращается: при успехе |
|
migration_status string |
Статус миграции этого тома (None означает, что миграция в настоящее время не выполняется). Возвращается: при успехе |
|
name string |
Имя тома. Возвращается: при успехе |
|
project_id string |
ID проекта, которому принадлежит том. Возвращается: при успехе |
|
replication_driver_data string |
Набор данных драйвером репликации Возвращается: при успехе |
|
replication_status string |
Статус репликации тома. Возвращается: при успехе |
|
scheduler_hints dictionary |
Подсказки планировщика для тома Возвращается: при успехе |
|
размер целое число |
Размер тома в гигабайтах (GiB). Возвращается при: успехе |
|
id_снимка строка |
Для создания тома из существующего снимка укажите UUID снимка тома. Том создаётся в той же доступной зоне и с тем же размером, что и снимок. Возвращается при: успехе |
|
id_источника_тома строка |
UUID исходного тома. API создаёт новый том с таким же размером, как у исходного тома, если не запрошен больший размер. Возвращается при: успехе |
|
состояние строка |
Состояние тома. Возвращается при: успехе |
|
обновлено_в строка |
Дата и время обновления ресурса. Возвращается при: успехе |
|
id_пользователя строка |
UUID пользователя. Возвращается при: успехе |
|
метаданные_изображения_тома словарь |
Список записей метаданных изображения. Включён только для томов, созданных из изображения или снимка тома, первоначально созданного из изображения. Возвращается при: успехе |
|
тип_тома строка |
Название связанного типа тома для тома. Возвращается при: успехе |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/openstack/cloud/server_volume_module.html
