# device.get_info

Get info for `type` device.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: data

#### data

Device information query parameters specifying type and options.

## Any of

#### DeviceGetInfoDisk

Type: object
No Additional Properties

##

#### Type

Type: const

Get disk info.

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.

## Any of

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

Device name for the serial port.

##

#### Location

Type: string

Physical location or path of the serial device.

##

#### Drivername

Type: string

Name of the kernel driver handling this serial device.

##

#### Start

Type: string

Starting address or identifier for the serial device.

##

#### Size

Type: integer

Size or capacity information for the serial device.

##

#### Description

Type: string

Human-readable description of the serial device.

Type: array of object
No Additional Items

##### Each item of this array must be:

#### GPUInfo

Type: object

##

#### GPUInfoAddr

Type: object

PCI address information for the GPU.

No Additional Properties

##

#### Pci Slot

Type: string

PCI slot identifier for the GPU.

##

#### Domain

Type: string

PCI domain number.

##

#### Bus

Type: string

PCI bus number.

##

#### Slot

Type: string

PCI slot number.

##

#### Description

Type: string

Human-readable description of the GPU.

##

#### Devices

Type: array of object

Array of PCI devices associated with this GPU.

No Additional Items

##### Each item of this array must be:

#### GPUInfoDevice

Type: object
No Additional Properties

##

#### Pci Id

Type: string

PCI device identifier.

##

#### Pci Slot

Type: string

PCI slot location.

##

#### Vm Pci Slot

Type: string

Virtual machine PCI slot mapping.

##

#### Vendor

GPU vendor name or `null` if unknown.

## Any of

Type: string
Type: null

##

#### Available To Host

Type: boolean

Whether the GPU is available for use by the host system.

##

#### Uses System Critical Devices

Type: boolean

Whether the GPU uses devices critical for system operation.

##

#### Critical Reason

Reason why GPU is considered critical or `null` if not critical.

## Any of

Type: string
Type: null

##

Additional Properties of any type are allowed.

Type: object

Required roles: READONLY_ADMIN