Модуль community.general.lxd_storage_volume_info — получение сведений о томах хранилища LXD

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

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

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать коллекцию в плейбуке, укажите: community.general.lxd_storage_volume_info.

Добавлено в community.general 12.1.0

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Получение сведений о томах хранилища LXD в указанном пуле хранилища.
Модуль возвращает сведения обо всех томах или об указанном томе в пуле.

Параметры

Параметр	Комментарии
client_cert псевдонимы: cert_file путь	Путь к файлу сертификата клиента. Если параметр не указан, по умолчанию используется `$HOME/.config/lxc/client.crt`.
client_key псевдонимы: key_file путь	Путь к файлу ключа сертификата клиента. Если параметр не указан, по умолчанию используется `$HOME/.config/lxc/client.key`.
name строка	Имя конкретного тома хранилища, сведения о котором нужно получить. Если параметр не указан, возвращаются сведения обо всех томах в пуле.
pool строка / обязательный	Имя пула хранилища, в котором нужно найти тома. Этот параметр обязателен.
project строка	Проект тома хранилища. См. https://documentation.ubuntu.com/lxd/en/latest/projects/.
snap_url строка	Путь к сокету домена Unix, если LXD установлен с помощью менеджера пакетов snap. По умолчанию: `"unix:/var/snap/lxd/common/lxd/unix.socket"`
trust_password строка	Пароль доверия клиента. Перед запуском этого модуля необходимо задать этот пароль на сервере LXD с помощью следующей команды: `lxc config set core.trust_password <some random password>` См. https://www.stgraber.org/2016/04/18/lxd-api-direct-interaction/. Если задано значение `trust_password`, модуль отправляет запрос на аутентификацию перед отправкой любых запросов.
type строка	Фильтр томов по типу. К распространённым типам относятся `container`, `virtual-machine`, `image` и `custom`. Если параметр не указан, возвращаются тома всех типов.
url строка	Путь к сокету домена Unix или URL-адрес https сервера LXD. По умолчанию: `"unix:/var/lib/lxd/unix.socket"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз статуса изменений, не изменяя целевой объект.
diff_mode	Поддержка: нет Это действие не изменяет состояние.	В режиме сравнения изменений возвращает сведения о том, что изменилось (или что, возможно, требуется изменить в `check_mode`).

Примеры

- name: Get information about all volumes in the default storage pool
  community.general.lxd_storage_volume_info:
    pool: default
  register: result

- name: Get information about a specific volume
  community.general.lxd_storage_volume_info:
    pool: default
    name: my-volume
  register: result

- name: Get information about all custom volumes in a pool
  community.general.lxd_storage_volume_info:
    pool: default
    type: custom
  register: result

- name: Get volume information via HTTPS connection
  community.general.lxd_storage_volume_info:
    url: https://127.0.0.1:8443
    trust_password: mypassword
    pool: default
    name: my-volume
  register: result

- name: Get volume information for a specific project
  community.general.lxd_storage_volume_info:
    project: myproject
    pool: default
  register: result

- name: Get container volumes only
  community.general.lxd_storage_volume_info:
    pool: default
    type: container
  register: result

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
logs список / элементы=словарь	Журналы запросов и ответов. Возвращается: при запуске ansible-playbook с параметром -vvvv. Пример: `[{"request": {"json": null, "method": "GET", "timeout": null, "url": "/1.0/storage-pools/default/volumes"}, "response": {"json": {"status": "Success", "type": "sync"}}, "type": "sent request"}]`
storage_volumes список / элементы=словарь	Список томов хранилища LXD. Возвращается: при успешном выполнении Пример: `[{"config": {"size": "10GiB"}, "content_type": "filesystem", "description": "My custom volume", "location": "none", "name": "my-volume", "type": "custom", "used_by": []}]`
config словарь	Конфигурация тома хранилища. Возвращается: при успешном выполнении
content_type строка	Тип содержимого тома (файловая система или блочное устройство). Возвращается: при успешном выполнении
description строка	Описание тома хранилища. Возвращается: при успешном выполнении
location строка	Расположение участника кластера, на котором находится том. Возвращается: при успешном выполнении
name строка	Имя тома хранилища. Возвращается: при успешном выполнении
type строка	Тип тома хранилища. Возвращается: при успешном выполнении
used_by список / элементы=строка	Список ресурсов, использующих этот том хранилища. Возвращается: при успешном выполнении

Авторы

Sean McAvoy (@smcavoy)

Ссылки на коллекцию

© 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/community/general/lxd_storage_volume_info_module.html