openstack.cloud.volume_info модуль – Получение информации о томах

Примечание

Этот модуль является частью коллекции openstack.cloud (версия 2.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install openstack.cloud. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

Для использования в playbook укажите: openstack.cloud.volume_info.

Обзор
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Получение информации о блочном хранилище в openstack

Требования

Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.

python >= 3.6
openstacksdk >= 1.0.0

Параметры

Параметр	Комментарии
all_projects boolean	Возвращать ли тома всех проектов Варианты: `false` `true`
api_timeout integer	Сколько времени должно ожидать сокет-слой перед истечением времени ожидания для вызовов API. Если этот параметр опущен, библиотеке запросов ничего не будет передано.
auth dictionary	Словарь, содержащий информацию об авторизации, необходимую стратегии плагина авторизации облака. Для плагина по умолчанию password он должен содержать auth_url, username, password, project_name и любую информацию о доменах (например, user_domain_name или project_domain_name), если облако их поддерживает. Для других плагинов этот параметр должен содержать необходимые параметры плагина авторизации. Этот параметр не нужен, если указано имя облака или присутствуют переменные окружения OpenStack OS_*.
auth_type string	Имя плагина авторизации для использования. Если облако использует что-то кроме парольной аутентификации, здесь следует указать имя плагина, и содержимое параметра auth должно быть соответствующим образом обновлено.
ca_cert aliases: cacert string	Путь к пакету CA Cert, который можно использовать при проверке SSL-запросов к API.
client_cert aliases: cert string	Путь к клиенту сертификату для использования в рамках SSL-транзакции.
client_key aliases: key string	Путь к ключу клиента для использования в рамках SSL-транзакции.
cloud any	Наименованное облако или конфигурация облака для работы. Если cloud — строка, она ссылается на именованную конфигурацию облака, как определено в файле OpenStack clouds.yaml. Предоставляет значения по умолчанию для auth и auth_type. Этот параметр не нужен, если указан auth или если присутствуют переменные окружения OpenStack OS_. Если cloud* — словарь, он содержит полную конфигурацию облака, как в разделе clouds.yaml.
details boolean	Предоставлять ли дополнительную информацию о томах Варианты: `false` `true`
interface aliases: endpoint_type string	Тип URL конечной точки для извлечения из каталога сервиса. Варианты: `"admin"` `"internal"` `"public"` ← (по умолчанию)
name string	Имя тома
region_name string	Имя региона.
sdk_log_level string	Уровень ведения журнала OpenStackSDK Варианты: `"INFO"` ← (по умолчанию) `"DEBUG"`
sdk_log_path string	Путь к файлу журнала OpenStackSDK. Если пусто, журнал не записывается
status string	Статус тома для фильтрации по `available`, например
timeout integer	Сколько времени Ansible должен ждать запрашиваемого ресурса. По умолчанию: `180`
validate_certs aliases: verify boolean	Нужно ли проверять SSL-запросы API. До Ansible 2.3 значение по умолчанию было `true`. Варианты: `false` `true`
wait boolean	Должен ли Ansible ждать завершения запрашиваемого ресурса. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Можно использовать стандартные переменные окружения 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": [], "availability_zone": "nova", "consistency_group_id": null, "created_at": "2017-11-15T10:51:19.000000", "description": "", "extended_replication_status": null, "group_id": "402ac6ed-527f-4781-8484-7ff4467e34f5", "host": null, "id": "103ac6ed-527f-4781-8484-7ff4467e34f5", "image_id": null, "is_bootable": true, "is_encrypted": false, "metadata": {"readonly": "False"}, "migration_id": null, "migration_status": null, "name": "", "project_id": "cab34702154a42fc96ed9403c691c76e", "replication_driver_data": null, "replication_status": "disabled", "scheduler_hints": {}, "size": 9, "snapshot_id": null, "source_volume_id": null, "status": "available", "updated_at": "2017-11-15T10:51:19.000000", "user_id": "ac303ed-527f-4781-8484-7ff4467e34f5", "volume_image_metadata": {"checksum": "a14e113deeee3a3392462f167ed28cb5", "container_format": "bare", "disk_format": "raw", "family": "centos-7", "image_id": "afcf3320-1bf8-4a9a-a24d-5abd639a6e33", "image_name": "CentOS-7-x86_64-GenericCloud-1708", "latest": "centos-7-latest", "min_disk": "0", "min_ram": "0", "official": "True", "official-image": "True", "size": "8589934592"}, "volume_type": null}]
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 пользователя. Возвращается: успешно
метаданные_изображения_тома словарь	Список записей метаданных изображения. Включается только для томов, созданных из изображения или из снимка тома, первоначально созданного из изображения. Возвращается: успешно
тип_тома строка	Имя связанного типа тома для тома. Возвращается: успешно

Авторы

Sagi Shnaidman (@sshnaidm)

Ссылки на сборку

© 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/volume_info_module.html