Модуль openstack.cloud.volume_info — получение информации о томах
Примечание
Этот модуль входит в коллекцию openstack.cloud (версия 2.5.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install openstack.cloud. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: openstack.cloud.volume_info.
Краткое описание
- Получение информации о блочном хранилище в OpenStack
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- python >= 3.6
- openstacksdk >= 1.0.0
Параметры
Параметр | Описание |
|---|---|
all_projects boolean | Возвращать ли тома во всех проектах Варианты:
|
api_timeout integer | Сколько времени уровень сокетов должен ждать ответа перед истечением времени ожидания вызовов API. Если параметр не указан, в библиотеку requests ничего не передаётся. |
auth dictionary | Словарь с данными аутентификации, необходимыми для выбранной стратегии плагина аутентификации облака. Для плагина password, используемого по умолчанию, здесь указываются auth_url, username, password, project_name и сведения о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать все параметры, необходимые соответствующему плагину аутентификации. Этот параметр не требуется, если указано именованное облако или заданы переменные среды OpenStack OS_*. |
auth_type string | Имя используемого плагина аутентификации. Если облако использует не парольную аутентификацию, здесь следует указать имя плагина и соответствующим образом изменить содержимое параметра auth. |
ca_cert псевдонимы: cacert string | Путь к пакету сертификатов центра сертификации, который можно использовать для проверки запросов SSL API. |
client_cert псевдонимы: cert string | Путь к сертификату клиента, используемому при обмене данными по SSL. |
client_key псевдонимы: key string | Путь к ключу клиента, используемому при обмене данными по SSL. |
cloud any | Именованное облако или конфигурация облака, с которой будет выполняться работа. Если cloud — строка, она указывает на именованную конфигурацию облака, определённую в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не требуется, если указан auth или заданы переменные среды OpenStack OS_*. Если cloud — словарь, он содержит полную конфигурацию облака, аналогичную разделу в clouds.yaml. |
details boolean | Предоставлять ли дополнительную информацию о томах Варианты:
|
interface псевдонимы: endpoint_type string | Тип URL конечной точки, получаемой из каталога служб. Варианты:
|
name string | Имя тома |
region_name string | Имя региона. |
sdk_log_level string | Уровень журналирования OpenStackSDK Варианты:
|
sdk_log_path string | Путь к файлу журнала OpenStackSDK. Если значение пустое, журнал не записывается |
status string | Состояние тома, по которому можно фильтровать, например, |
timeout integer | Сколько времени Ansible должен ждать запрошенный ресурс. По умолчанию: |
validate_certs псевдонимы: verify boolean | Проверять ли запросы SSL API. До Ansible 2.3 значение по умолчанию было Варианты:
|
wait boolean | Должен ли Ansible ждать завершения операции с запрошенным ресурсом. Варианты:
|
Примечания
Примечание
- Вместо явного указания значений можно использовать стандартные переменные среды OpenStack, например
OS_USERNAME. - Данные аутентификации обрабатываются openstacksdk. Это означает, что значения могут поступать из YAML-файла конфигурации /etc/ansible/openstack.yaml, /etc/openstack/clouds.yaml или ~/.config/openstack/clouds.yaml, затем из стандартных переменных среды и, наконец, из явно заданных параметров в плейбуках. Дополнительные сведения см. на странице https://docs.openstack.org/openstacksdk/
Примеры
- openstack.cloud.volume_info:
- openstack.cloud.volume_info:
name: myvolume
- openstack.cloud.volume_info:
all_projects: true
- openstack.cloud.volume_info:
all_projects: true
details: false
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
volumes list / elements=dictionary | Тома в проекте (проектах) Возвращается: всегда Пример: |
|
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 |
Идентификатор группы. Возвращается: при успехе |
|
host string |
Текущая серверная система тома. Возвращается: при успехе |
|
id string |
UUID тома. Возвращается: при успехе |
|
image_id string |
Образ, на основе которого создан том Возвращается: при успехе |
|
is_bootable string |
Включает или отключает атрибут загрузочного тома. Из загрузочного тома можно загрузить экземпляр. Возвращается: при успехе |
|
is_encrypted boolean |
Если значение истинно, том зашифрован. Возвращается: при успехе |
|
metadata dictionary |
Объект метаданных. Содержит одну или несколько пар ключей и значений метаданных, связанных с томом. Возвращается: при успехе |
|
migration_id string |
Идентификатор тома, на основе которого задано имя этого тома в серверной системе. Возвращается: при успехе |
|
migration_status string |
Состояние миграции этого тома (значение None означает, что миграция в данный момент не выполняется). Возвращается: при успехе |
|
name string |
Имя тома. Возвращается: при успехе |
|
project_id string |
Идентификатор проекта, которому принадлежит том. Возвращается: при успехе |
|
replication_driver_data string |
Данные, заданные драйвером репликации Возвращается: при успехе |
|
replication_status string |
Состояние репликации тома. Возвращается: при успехе |
|
scheduler_hints dictionary |
Подсказки планировщика для тома Возвращается: при успехе |
|
size integer |
Размер тома в гибибайтах (ГиБ). Возвращается: при успехе |
|
snapshot_id string |
Чтобы создать том на основе существующего снимка, укажите UUID снимка тома. Том создаётся в той же зоне доступности и того же размера, что и снимок. Возвращается: при успехе |
|
source_volume_id string |
UUID исходного тома. API создаёт том того же размера, что и исходный, если не запрошен больший размер. Возвращается: при успехе |
|
status string |
Состояние тома. Возвращается: при успехе |
|
updated_at string |
Дата и время обновления ресурса. Возвращается: при успехе |
|
user_id string |
UUID пользователя. Возвращается: при успехе |
|
volume_image_metadata dictionary |
Список записей метаданных образа. Включается только для томов, созданных из образа или из снимка тома, первоначально созданного из образа. Возвращается: при успехе |
|
volume_type string |
Имя типа, связанного с томом. Возвращается: при успехе |
Ссылки на коллекцию
© 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/volume_info_module.html