Модуль community.general.zfs_facts — сбор сведений о наборах данных ZFS

Примечание

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

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

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

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

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

Описание

Сбор фактов из свойств наборов данных ZFS.

Параметры

Параметр	Комментарии
depth integer	Задаёт глубину рекурсии. По умолчанию: `0`
name псевдонимы: ds, dataset string / обязательный	Имя набора данных ZFS.
parsable boolean	Указывает, следует ли отображать значения свойств в удобном для машинной обработки формате. Варианты: `false` ← (по умолчанию) `true`
properties string	Задаёт свойства набора данных, которые необходимо запросить, в виде списка с разделителями-запятыми. Дополнительные сведения о свойствах наборов данных см. на странице руководства zfs(1M). По умолчанию: `"all"`
recurse boolean	Указывает, следует ли рекурсивно отображать свойства всех дочерних объектов. Варианты: `false` ← (по умолчанию) `true`
type list / элементы=string	Задаёт типы наборов данных для отображения. Несколько значений необходимо указать в виде списка или через запятую. Значение `all` нельзя использовать вместе с другими значениями. Варианты: `"all"` ← (по умолчанию) `"filesystem"` `"volume"` `"snapshot"` `"bookmark"` По умолчанию: `["all"]`

Атрибуты

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

Примеры

- name: Gather facts about ZFS dataset rpool/export/home
  community.general.zfs_facts:
    dataset: rpool/export/home

- name: Report space usage on ZFS filesystems under data/home
  community.general.zfs_facts:
    name: data/home
    recurse: true
    type: filesystem

- ansible.builtin.debug:
    msg: 'ZFS dataset {{ item.name }} consumes {{ item.used }} of disk space.'
  with_items: '{{ ansible_zfs_datasets }}'

Возвращаемые факты

Факты, возвращаемые этим модулем, добавляются в факты узла hostvars или обновляют их; на них можно ссылаться по имени, как и на любые другие факты узла. Для их использования не требуется регистрация.

Ключ	Описание
zfs_datasets list / элементы=dictionary	Факты о наборах данных ZFS. Возвращается: всегда Пример: [{"aclinherit": "restricted", "aclmode": "discard", "atime": "on", "available": "43.8G", "canmount": "on", "casesensitivity": "sensitive", "checksum": "on", "compression": "off", "compressratio": "1.00x", "copies": "1", "creation": "Thu Jun 16 11:37 2016", "dedup": "off", "devices": "on", "exec": "on", "filesystem_count": "none", "filesystem_limit": "none", "logbias": "latency", "logicalreferenced": "18.5K", "logicalused": "3.45G", "mlslabel": "none", "mounted": "yes", "mountpoint": "/rpool", "name": "rpool", "nbmand": "off", "normalization": "none", "org.openindiana.caiman:install": "ready", "primarycache": "all", "quota": "none", "readonly": "off", "recordsize": "128K", "redundant_metadata": "all", "refcompressratio": "1.00x", "referenced": "29.5K", "refquota": "none", "refreservation": "none", "reservation": "none", "secondarycache": "all", "setuid": "on", "sharenfs": "off", "sharesmb": "off", "snapdir": "hidden", "snapshot_count": "none", "snapshot_limit": "none", "sync": "standard", "type": "filesystem", "used": "4.41G", "usedbychildren": "4.41G", "usedbydataset": "29.5K", "usedbyrefreservation": "0", "usedbysnapshots": "0", "utf8only": "off", "version": "5", "vscan": "off", "written": "29.5K", "xattr": "on", "zoned": "off"}]

Ключ

Описание

zfs_datasets

list / элементы=dictionary

Факты о наборах данных ZFS.

Возвращается: всегда

Пример: [{"aclinherit": "restricted", "aclmode": "discard", "atime": "on", "available": "43.8G", "canmount": "on", "casesensitivity": "sensitive", "checksum": "on", "compression": "off", "compressratio": "1.00x", "copies": "1", "creation": "Thu Jun 16 11:37 2016", "dedup": "off", "devices": "on", "exec": "on", "filesystem_count": "none", "filesystem_limit": "none", "logbias": "latency", "logicalreferenced": "18.5K", "logicalused": "3.45G", "mlslabel": "none", "mounted": "yes", "mountpoint": "/rpool", "name": "rpool", "nbmand": "off", "normalization": "none", "org.openindiana.caiman:install": "ready", "primarycache": "all", "quota": "none", "readonly": "off", "recordsize": "128K", "redundant_metadata": "all", "refcompressratio": "1.00x", "referenced": "29.5K", "refquota": "none", "refreservation": "none", "reservation": "none", "secondarycache": "all", "setuid": "on", "sharenfs": "off", "sharesmb": "off", "snapdir": "hidden", "snapshot_count": "none", "snapshot_limit": "none", "sync": "standard", "type": "filesystem", "used": "4.41G", "usedbychildren": "4.41G", "usedbydataset": "29.5K", "usedbyrefreservation": "0", "usedbysnapshots": "0", "utf8only": "off", "version": "5", "vscan": "off", "written": "29.5K", "xattr": "on", "zoned": "off"}]

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

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

Ключ	Описание
name string	Имя набора данных ZFS. Возвращается: при успехе Пример: `"rpool/var/spool"`
parsable boolean	Указывает, следует ли предоставлять вывод в удобном для машинной обработки формате. Возвращается: если `parsable=True` Пример: `true`
recurse boolean	Указывает, следует ли рекурсивно обходить набор данных ZFS. Возвращается: если `recurse=True` Пример: `true`

Авторы

Adam Števko (@xen0l)

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

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