{
  "changes": [],
  "conditions": [],
  "fieldGroups": [
    {
      "id": "device",
      "title": "Device"
    },
    {
      "id": "driver",
      "title": "Driver"
    },
    {
      "id": "state",
      "title": "State"
    }
  ],
  "fieldPrefix": "sparklogs.data.devices.",
  "fields": [
    {
      "doc": "The OS's name for this device node, opaque and meaningful only on this host: never parse it. Stable across reboots where the OS gives a stable name. Windows: the device instance id, lowercased.",
      "group": "device",
      "name": "device",
      "type": "string"
    },
    {
      "doc": "The name the OS shows for this device. Windows: the friendly name, else the device description, in the system language. Absent when the OS has neither.",
      "group": "device",
      "name": "display_name",
      "type": "string"
    },
    {
      "doc": "A normalized kind for grouping and icons: `processor`, `storage`, `network`, `display`, `audio`, `camera`, `input`, `usb`, `bluetooth`, `printer`, `portable`, `power`, `sensor`, `security`, `firmware`, `port`, `system`, `software` or `other`. More values may be added. Windows: from the setup class. Absent when the device has no class.",
      "group": "device",
      "name": "device_type",
      "type": "string"
    },
    {
      "doc": "The Windows setup class. Absent when the device has none, and on other OSes.",
      "group": "device",
      "name": "class",
      "type": "string"
    },
    {
      "doc": "The manufacturer the OS records. Windows: the text in the driver's INF, which can name the driver's author and not the hardware's maker. Absent when there is none.",
      "group": "device",
      "name": "manufacturer",
      "type": "string"
    },
    {
      "doc": "Who enumerated this node, a bus or a software enumerator, lowercased (Windows `DEVPKEY_Device_EnumeratorName`: `pci`, `usb`, `acpi`, `root`, `swd`, ...). Not the physical link: a storage device's link is `storage_devices.transport`.",
      "group": "device",
      "name": "bus",
      "type": "string"
    },
    {
      "doc": "The vendor id in this node's own name, lowercased, on `pci`, `usb` and `hid` nodes. Read it with `bus`: PCI and USB ids are separate registries. Absent on other buses, and when the name holds none.",
      "group": "device",
      "name": "vendor_id",
      "type": "string"
    },
    {
      "doc": "The product or device id in this node's own name, lowercased, on `pci`, `usb` and `hid` nodes. Read it with `vendor_id` and `bus`. Absent on other buses, and when the name holds none.",
      "group": "device",
      "name": "product_id",
      "type": "string"
    },
    {
      "doc": "The bus's own standard class code, lowercased. Read it with `bus`. `pci`: the class code, such as `020000`. `usb`: class, subclass and protocol, such as `03-01-02`. `hid`: usage page and usage, such as `0001-0002`. Absent on other buses, and when the device reports none.",
      "group": "device",
      "name": "hardware_class",
      "type": "string"
    },
    {
      "doc": "Whether this device is left out of the default device view. Windows: hidden in Device Manager's default view. A hidden device is a row only while it reports a fault, so it arrives with the fault and leaves when the fault clears.",
      "group": "device",
      "name": "hidden",
      "type": "bool"
    },
    {
      "doc": "The nearest ancestor that is itself a row. Absent at the top of a tree. Links to the `devices` row with this `instance`.",
      "group": "device",
      "name": "parent_device",
      "type": "string"
    },
    {
      "doc": "When the OS first installed this device, in UTC. Windows only. Absent when not recorded.",
      "group": "device",
      "name": "install_ts",
      "type": "string",
      "unit": "timestamp"
    },
    {
      "doc": "Link to the `kernel_drivers` row of the driver running this device. Absent when there is no such row to link: no driver, or a driver that is part of the OS kernel or runs outside it. Absent is not proof of no driver. A value with no matching row means that driver is not listed now. Windows: the function driver's service.",
      "group": "driver",
      "name": "kernel_driver",
      "type": "string"
    },
    {
      "doc": "Link to the `drivers` row of the package bound to this device. Windows only. Absent when no package is bound.",
      "group": "driver",
      "name": "driver_package",
      "type": "string"
    },
    {
      "doc": "The device's run state as far as this OS can say: `started`, `not_started`, `disabled` (turned off by an administrator or policy; Windows problem 22), `problem`. More values may be added. `not_started` is normal for a device that needs no running driver, and its share differs by OS, so use `problem` to find faults.",
      "group": "state",
      "name": "status",
      "type": "string"
    },
    {
      "doc": "The OS's name for what is wrong (Windows: the CM_PROB name in snake case; `unknown` for one this build does not name). Absent is not proof of health on an OS that keeps no record of a failure.",
      "group": "state",
      "name": "problem",
      "type": "string"
    },
    {
      "doc": "Device Manager's \"Code N\". Windows only. Absent when the device node reports no problem, which does not mean the device started: read `status` for that.",
      "group": "state",
      "name": "problem_code",
      "type": "integer"
    },
    {
      "doc": "The NTSTATUS behind the problem, when Windows records one. Absent otherwise.",
      "group": "state",
      "name": "problem_status_code",
      "type": "integer"
    },
    {
      "doc": "The name of `problem_status_code`, such as `STATUS_UNSUCCESSFUL`. Absent when the code has no known name.",
      "group": "state",
      "name": "problem_status_name",
      "type": "string"
    },
    {
      "doc": "The code table `problem_status_code` belongs to: `ntstatus`. Absent with the code.",
      "group": "state",
      "name": "problem_status_space",
      "type": "string"
    }
  ],
  "name": "Devices",
  "occurrences": [],
  "page": "/docs/it-fleet-intelligence/reference/topics/devices",
  "status": "live",
  "summary": "The hardware devices present on the host, with their status, problem codes and links to their drivers.",
  "topic": "devices"
}