Модуль community.general.lxd_storage_pool_info — получение информации о пулах хранения LXD

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.lxd_storage_pool_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 строка	Имя конкретного пула хранения, сведения о котором требуется получить. Если не указано, возвращаются сведения обо всех пулах хранения.
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 список / элементы=строка	Фильтрация пулов хранения по драйверу/типу (например, `dir`, `zfs`, `btrfs`, `lvm` или `ceph`). Если не указано, возвращаются все типы пулов хранения. Можно указать один тип или список типов. По умолчанию: `[]`
url строка	Путь к доменному сокету Unix или URL-адрес https для сервера LXD. По умолчанию: `"unix:/var/lib/lxd/unix.socket"`

Атрибуты

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

Примеры

- name: Get information about all storage pools
  community.general.lxd_storage_pool_info:
  register: result

- name: Get information about a specific storage pool
  community.general.lxd_storage_pool_info:
    name: default
  register: result

- name: Get information about all ZFS storage pools
  community.general.lxd_storage_pool_info:
    type:
      - zfs
      - ceph
  register: result

- name: Get information about ZFS and BTRFS storage pools
  community.general.lxd_storage_pool_info:
    type:
      - zfs
      - btrfs
  register: result

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

- name: Get storage pool information for a specific project
  community.general.lxd_storage_pool_info:
    project: myproject
  register: result

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

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

Ключ	Описание
logs список / элементы=словарь	Журналы запросов и ответов. Возвращается: если ansible-playbook запущен с параметром -vvvv. Пример: `[{"request": {"json": null, "method": "GET", "timeout": null, "url": "/1.0/storage-pools"}, "response": {"json": {"status": "Success", "type": "sync"}}, "type": "sent request"}]`
storage_pools список / элементы=словарь	Список пулов хранения LXD. Возвращается: при успешном выполнении Пример: `[{"config": {"source": "/var/lib/lxd/storage-pools/default"}, "description": "Default storage pool", "driver": "dir", "locations": ["none"], "name": "default", "status": "Created", "used_by": ["/1.0/instances/container1"]}]`
config словарь	Конфигурация пула хранения. Возвращается: при успешном выполнении
description строка	Описание пула хранения. Возвращается: при успешном выполнении
driver строка	Драйвер/тип пула хранения. Возвращается: при успешном выполнении
locations список / элементы=строка	Расположение участников кластера для этого пула. Возвращается: при успешном выполнении
name строка	Имя пула хранения. Возвращается: при успешном выполнении
status строка	Текущий статус пула хранения. Возвращается: при успешном выполнении
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_pool_info_module.html