disk.query

Sent on disk changes.

Type: object

ADDED

DiskQueryAddedEvent

Type: object
No Additional Properties

id Required

Id

Type: string

Disk identifier.

fields Required

DiskEntry

Type: object

Event fields.

No Additional Properties

identifier Required

Identifier

Type: string

Unique identifier for the disk device.

name Required

Name

Type: string

System name of the disk device.

subsystem Required

Subsystem

Type: string

Storage subsystem type.

Examples:

"SCSI"

"ATA"

number Required

Number

Type: integer

Numeric identifier assigned to the disk.

serial Required

Serial

Type: string

Manufacturer serial number of the disk.

lunid Required

Lunid

Logical unit number identifier or null if not applicable.

Any of

• Option 1
• Option 2

Type: string

Type: null

size Required

Size

Total size of the disk in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

description Required

Description

Type: string

Human-readable description of the disk device.

transfermode Required

Transfermode

Type: string

Data transfer mode and capabilities of the disk.

hddstandby Required

Hddstandby

Type: enum (of string)

Hard disk standby timer in minutes or ALWAYS ON to disable standby.

Must be one of:

• "ALWAYS ON"
• "5"
• "10"
• "20"
• "30"
• "60"
• "120"
• "180"
• "240"
• "300"
• "330"

advpowermgmt Required

Advpowermgmt

Type: enum (of string)

Advanced power management level or DISABLED to turn off power management.

Must be one of:

• "DISABLED"
• "1"
• "64"
• "127"
• "128"
• "192"
• "254"

expiretime Required

Expiretime

Expiration timestamp for disk data or null if not applicable.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

model Required

Model

Manufacturer model name/number of the disk. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

rotationrate Required

Rotationrate

Disk rotation speed in RPM or null for SSDs and unknown devices.

Any of

• Option 1
• Option 2

Type: integer

Type: null

type Required

Type

Disk type classification or null if not determined.

Any of

• Option 1
• Option 2

Type: string

Type: null

zfs_guid Required

Zfs Guid

ZFS globally unique identifier for this disk or null if not used in ZFS.

Any of

• Option 1
• Option 2

Type: string

Type: null

bus Required

Bus

Type: string

System bus type the disk is connected to.

devname Required

Devname

Type: string

Device name in the operating system.

Example:

"/dev/sda"

enclosure Required

Physical enclosure information or null if not in an enclosure.

Any of

• DiskEntryEnclosure
• Option 2

DiskEntryEnclosure

Type: object
No Additional Properties

number Required

Number

Type: integer

Enclosure number where the disk is located.

slot Required

Slot

Type: integer

Physical slot position within the enclosure.

Type: null

pool Required

Pool

Name of the storage pool this disk belongs to. null if not part of any pool.

Any of

• Option 1
• Option 2

Type: string

Type: null

passwd

Passwd

Type: string

Disk encryption password (masked for security).

kmip_uid

Kmip Uid

KMIP (Key Management Interoperability Protocol) unique identifier or null.

Any of

• Option 1
• Option 2

Type: string

Type: null

sed Required

Sed

Whether the disk is SED (Self-Encrypting Drive) capable. null if not yet determined.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

sed_status

Sed Status

SED Status of the disk. null if not yet determined.

Any of

• Option 1
• Option 2

Type: string

Type: null

CHANGED

DiskQueryChangedEvent

Type: object
No Additional Properties

id Required

Id

Type: string

Disk identifier.

fields Required

DiskEntry

Type: object

Event fields.

No Additional Properties

identifier Required

Identifier

Type: string

Unique identifier for the disk device.

name Required

Name

Type: string

System name of the disk device.

subsystem Required

Subsystem

Type: string

Storage subsystem type.

Examples:

"SCSI"

"ATA"

number Required

Number

Type: integer

Numeric identifier assigned to the disk.

serial Required

Serial

Type: string

Manufacturer serial number of the disk.

lunid Required

Lunid

Logical unit number identifier or null if not applicable.

Any of

• Option 1
• Option 2

Type: string

Type: null

size Required

Size

Total size of the disk in bytes. null if not available.

Any of

• Option 1
• Option 2

Type: integer

Type: null

description Required

Description

Type: string

Human-readable description of the disk device.

transfermode Required

Transfermode

Type: string

Data transfer mode and capabilities of the disk.

hddstandby Required

Hddstandby

Type: enum (of string)

Hard disk standby timer in minutes or ALWAYS ON to disable standby.

Must be one of:

• "ALWAYS ON"
• "5"
• "10"
• "20"
• "30"
• "60"
• "120"
• "180"
• "240"
• "300"
• "330"

advpowermgmt Required

Advpowermgmt

Type: enum (of string)

Advanced power management level or DISABLED to turn off power management.

Must be one of:

• "DISABLED"
• "1"
• "64"
• "127"
• "128"
• "192"
• "254"

expiretime Required

Expiretime

Expiration timestamp for disk data or null if not applicable.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

model Required

Model

Manufacturer model name/number of the disk. null if not available.

Any of

• Option 1
• Option 2

Type: string

Type: null

rotationrate Required

Rotationrate

Disk rotation speed in RPM or null for SSDs and unknown devices.

Any of

• Option 1
• Option 2

Type: integer

Type: null

type Required

Type

Disk type classification or null if not determined.

Any of

• Option 1
• Option 2

Type: string

Type: null

zfs_guid Required

Zfs Guid

ZFS globally unique identifier for this disk or null if not used in ZFS.

Any of

• Option 1
• Option 2

Type: string

Type: null

bus Required

Bus

Type: string

System bus type the disk is connected to.

devname Required

Devname

Type: string

Device name in the operating system.

Example:

"/dev/sda"

enclosure Required

Physical enclosure information or null if not in an enclosure.

Any of

• DiskEntryEnclosure
• Option 2

DiskEntryEnclosure

Type: object
No Additional Properties

number Required

Number

Type: integer

Enclosure number where the disk is located.

slot Required

Slot

Type: integer

Physical slot position within the enclosure.

Type: null

pool Required

Pool

Name of the storage pool this disk belongs to. null if not part of any pool.

Any of

• Option 1
• Option 2

Type: string

Type: null

passwd

Passwd

Type: string

Disk encryption password (masked for security).

kmip_uid

Kmip Uid

KMIP (Key Management Interoperability Protocol) unique identifier or null.

Any of

• Option 1
• Option 2

Type: string

Type: null

sed Required

Sed

Whether the disk is SED (Self-Encrypting Drive) capable. null if not yet determined.

Any of

• Option 1
• Option 2

Type: boolean

Type: null

sed_status

Sed Status

SED Status of the disk. null if not yet determined.

Any of

• Option 1
• Option 2

Type: string

Type: null

REMOVED

DiskQueryRemovedEvent

Type: object
No Additional Properties

id Required

Id

Type: string

Disk identifier.

Required roles: READONLY_ADMIN