device.get_info

Get info for type device.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data


DeviceGetInfoDisk

Type: object
No Additional Properties

Type

Type: const

Get disk info.

Must be one of:
  • "DISK"
Specific value: "DISK"

Get Partitions

Type: boolean Default: false

If set, query partition information for the disks.
NOTE: This can be expensive on systems with a large number of disks present.

Serials Only

Type: boolean Default: false

If set, query ONLY serial information for the disks (overrides get_partitions).

DeviceGetInfoOther

Type: object
No Additional Properties

Type

Type: enum (of string)

Get info for either serial devices or GPUs.

Must be one of:
  • "SERIAL"
  • "GPU"

Result


Return an object if type="DISK" or an array otherwise.

Type: object

Each additional property must conform to the following schema

Type: string
Type: object

Each additional property must conform to the following schema

Type: object
Type: array of object
No Additional Items
Each item of this array must be:

SerialInfo

Type: object
No Additional Properties

Name

Type: string

Location

Type: string

Drivername

Type: string

Start

Type: string

Size

Type: integer

Description

Type: string
Type: array of object
No Additional Items
Each item of this array must be:

GPUInfo

Type: object

GPUInfoAddr

Type: object
No Additional Properties

Pci Slot

Type: string

Domain

Type: string

Bus

Type: string

Slot

Type: string

Description

Type: string

Devices

Type: array of object
No Additional Items
Each item of this array must be:

GPUInfoDevice

Type: object
No Additional Properties

Pci Id

Type: string

Pci Slot

Type: string

Vm Pci Slot

Type: string

Vendor


Type: string
Type: null

Available To Host

Type: boolean

Uses System Critical Devices

Type: boolean

Critical Reason


Type: string
Type: null

Additional Properties of any type are allowed.

Type: object


Required roles: READONLY_ADMIN