device.get_info

Get info for type device.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Device information query parameters specifying type and options.

Any of

• DeviceGetInfoDisk
• DeviceGetInfoOther

DeviceGetInfoDisk

Type: object
No Additional Properties

type Required

Type

Type: const

Get disk info.

Must be one of:

• "DISK"

Specific value: "DISK"

get_partitions

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

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 Required

Type

Type: enum (of string)

Get info for either serial devices or GPUs.

Must be one of:

• "SERIAL"
• "GPU"

Return value

Result

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

Any of

• Option 1
• Option 2
• Option 3
• Option 4

Type: object

Additional Properties

Each additional property must conform to the following schema

Type: string

Type: object

Additional Properties

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 Required

Name

Type: string

Device name for the serial port.

location Required

Location

Type: string

Physical location or path of the serial device.

drivername Required

Drivername

Type: string

Name of the kernel driver handling this serial device.

start Required

Start

Type: string

Starting address or identifier for the serial device.

size Required

Size

Type: integer

Size or capacity information for the serial device.

description Required

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

addr Required

GPUInfoAddr

Type: object

PCI address information for the GPU.

No Additional Properties

pci_slot Required

Pci Slot

Type: string

PCI slot identifier for the GPU.

domain Required

Domain

Type: string

PCI domain number.

bus Required

Bus

Type: string

PCI bus number.

slot Required

Slot

Type: string

PCI slot number.

description Required

Description

Type: string

Human-readable description of the GPU.

devices Required

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 Required

Pci Id

Type: string

PCI device identifier.

pci_slot Required

Pci Slot

Type: string

PCI slot location.

vm_pci_slot Required

Vm Pci Slot

Type: string

Virtual machine PCI slot mapping.

vendor Required

Vendor

GPU vendor name or null if unknown.

Any of

• Option 1
• Option 2

Type: string

Type: null

available_to_host Required

Available To Host

Type: boolean

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

uses_system_critical_devices Required

Uses System Critical Devices

Type: boolean

Whether the GPU uses devices critical for system operation.

critical_reason Required

Critical Reason

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

Any of

• Option 1
• Option 2

Type: string

Type: null

Additional Properties

Additional Properties of any type are allowed.

Type: object

Required roles: READONLY_ADMIN