summaryrefslogtreecommitdiffstats
path: root/doc/ceph-volume/zfs/inventory.rst
blob: fd00325b6a8852012af06d1d7ea952bf263357e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
.. _ceph-volume-zfs-inventory:

``inventory``
=============
The ``inventory`` subcommand queries a host's disc inventory through GEOM and provides
hardware information and metadata on every physical device.

This only works on a FreeBSD platform.

By default the command returns a short, human-readable report of all physical disks.

For programmatic consumption of this report pass ``--format json`` to generate a
JSON formatted report. This report includes extensive information on the
physical drives such as disk metadata (like model and size), logical volumes
and whether they are used by ceph, and if the disk is usable by ceph and
reasons why not.

A device path can be specified to report extensive information on a device in
both plain and json format.