# disk.query

Sent on disk changes.

Type: object

##

#### DiskQueryAddedEvent

Type: object
No Additional Properties

##

#### Id

Type: string

Disk identifier.

##

#### DiskEntry

Type: object

Event fields.

No Additional Properties

##

#### Identifier

Type: string

Unique identifier for the disk device.

##

#### Name

Type: string

System name of the disk device.

##

#### Subsystem

Type: string

Storage subsystem type.

Examples:

    "SCSI"

    "ATA"

##

#### Number

Type: integer

Numeric identifier assigned to the disk.

##

#### Serial

Type: string

Manufacturer serial number of the disk.

##

#### Lunid

Logical unit number identifier or `null` if not applicable.

## Any of

Type: string
Type: null

##

#### Size

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

## Any of

Type: integer
Type: null

##

#### Description

Type: string

Human-readable description of the disk device.

##

#### Transfermode

Type: string

Data transfer mode and capabilities of the disk.

##

#### 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

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

Expiration timestamp for disk data or `null` if not applicable.

## Any of

Type: stringFormat: date-time
Type: null

##

#### Model

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

## Any of

Type: string
Type: null

##

#### Rotationrate

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

## Any of

Type: integer
Type: null

##

#### Type

Disk type classification or `null` if not determined.

## Any of

Type: string
Type: null

##

#### Zfs Guid

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

## Any of

Type: string
Type: null

##

#### Bus

Type: string

System bus type the disk is connected to.

##

#### Devname

Type: string

Device name in the operating system.

Example:

    "/dev/sda"

##

Physical enclosure information or `null` if not in an enclosure.

## Any of

#### DiskEntryEnclosure

Type: object
No Additional Properties

##

#### Number

Type: integer

Enclosure number where the disk is located.

##

#### Slot

Type: integer

Physical slot position within the enclosure.

Type: null

##

#### Pool

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

## Any of

Type: string
Type: null

##

#### Passwd

Type: string

Disk encryption password (masked for security).

##

#### Kmip Uid

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

## Any of

Type: string
Type: null

##

#### Sed

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

## Any of

Type: boolean
Type: null

##

#### Sed Status

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

## Any of

Type: string
Type: null

##

#### DiskQueryChangedEvent

Type: object
No Additional Properties

##

#### Id

Type: string

Disk identifier.

##

#### DiskEntry

Type: object

Event fields.

No Additional Properties

##

#### Identifier

Type: string

Unique identifier for the disk device.

##

#### Name

Type: string

System name of the disk device.

##

#### Subsystem

Type: string

Storage subsystem type.

Examples:

    "SCSI"

    "ATA"

##

#### Number

Type: integer

Numeric identifier assigned to the disk.

##

#### Serial

Type: string

Manufacturer serial number of the disk.

##

#### Lunid

Logical unit number identifier or `null` if not applicable.

## Any of

Type: string
Type: null

##

#### Size

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

## Any of

Type: integer
Type: null

##

#### Description

Type: string

Human-readable description of the disk device.

##

#### Transfermode

Type: string

Data transfer mode and capabilities of the disk.

##

#### 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

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

Expiration timestamp for disk data or `null` if not applicable.

## Any of

Type: stringFormat: date-time
Type: null

##

#### Model

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

## Any of

Type: string
Type: null

##

#### Rotationrate

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

## Any of

Type: integer
Type: null

##

#### Type

Disk type classification or `null` if not determined.

## Any of

Type: string
Type: null

##

#### Zfs Guid

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

## Any of

Type: string
Type: null

##

#### Bus

Type: string

System bus type the disk is connected to.

##

#### Devname

Type: string

Device name in the operating system.

Example:

    "/dev/sda"

##

Physical enclosure information or `null` if not in an enclosure.

## Any of

#### DiskEntryEnclosure

Type: object
No Additional Properties

##

#### Number

Type: integer

Enclosure number where the disk is located.

##

#### Slot

Type: integer

Physical slot position within the enclosure.

Type: null

##

#### Pool

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

## Any of

Type: string
Type: null

##

#### Passwd

Type: string

Disk encryption password (masked for security).

##

#### Kmip Uid

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

## Any of

Type: string
Type: null

##

#### Sed

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

## Any of

Type: boolean
Type: null

##

#### Sed Status

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

## Any of

Type: string
Type: null

##

#### DiskQueryRemovedEvent

Type: object
No Additional Properties

##

#### Id

Type: string

Disk identifier.

Required roles: READONLY_ADMIN