Skip to main content

DiskInventoryEntry

devicestringrequired
sizeBytesinteger<int64>required
modelstring
serialstring
wwnstring
bootbooleanrequired
failedboolean
weakIdentityboolean
unraidStickboolean

True when this disk is the Unraid USB stick (a vfat filesystem labelled UNRAID). Hoserva only reads it for a migration and never assigns it a role: every role assignment, and registering, mounting, formatting or enabling it as a backup destination as an external disk, is refused with 409 unraid_stick, so a client offers it no role. Ejecting a stick registered before it was recognised still works, so it can be taken offline.

filesystemstring

Cached filesystem type from udev (ID_FS_TYPE), never probed in a way that wakes a standby disk.

labelstring

Cached filesystem label from udev (ID_FS_LABEL).

smartStatusstring

SMART summary from a standby-respecting poll. standby when the disk was left asleep; ok or failing from a real read.

containsDataboolean

True when udev reports an existing filesystem on the disk.

looksLikeUnraidboolean

True when the disk is laid out the way Unraid lays out an array or pool disk: an MBR or GPT partition table whose partition 1 starts at sector 64 and holds XFS, btrfs or ext4. A real Unraid array carries no filesystem label, so the layout is the only sign. Read from sysfs and udev's cache; the disk is never mounted to look for super.dat. A hint for a warning, never a role.

cachePartitions object[]

Only on the boot disk: its spare partitions that may be assigned the cache role. A partition is listed when it is on the boot disk, typed as Linux data, carries no filesystem signature in udev's cache, is not mounted, swap, named in /etc/fstab or a systemd mount or swap unit, or held open by another device, and has a by-id link and a PARTUUID. Derived from sysfs, udev, by-id and the files above without opening the device; the blank probe runs only when the partition is picked.

  • Array [
  • devicestringrequired

    The partition's kernel device, for example /dev/nvme0n1p3.

    sizeBytesinteger<int64>required
    byIdNamestring

    The partition's /dev/disk/by-id link name, the identity it is formatted and mounted by.

    partUuidstring

    The partition table's identifier for it, re-checked immediately before formatting.

    reasonstringrequired

    Why it qualifies: spare_boot_partition — an unused partition of the boot disk that nothing mounts, swaps on or names.

    Possible values: [spare_boot_partition]

  • ]
  • DiskInventoryEntry
    {
    "device": "string",
    "sizeBytes": 0,
    "model": "string",
    "serial": "string",
    "wwn": "string",
    "boot": true,
    "failed": true,
    "weakIdentity": true,
    "unraidStick": true,
    "filesystem": "string",
    "label": "string",
    "smartStatus": "string",
    "containsData": true,
    "looksLikeUnraid": true,
    "cachePartitions": [
    {
    "device": "string",
    "sizeBytes": 0,
    "byIdName": "string",
    "partUuid": "string",
    "reason": "spare_boot_partition"
    }
    ]
    }