disk.details ============ Return detailed information for all disks on the system. .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Disk query parameters specifying which disks to return and options.

 No Additional Properties

Join Partitions

Type: boolean Default: false

Return all partitions currently written to disk.

NOTE: This is an expensive operation.

Type

Type: enum (of string) Default: "BOTH"
  • USED: Only disks that are IN USE will be returned.
  • UNUSED: Only disks that are NOT IN USE are returned.
  • BOTH: Used and unused disks will be returned.
Must be one of:
  • "USED"
  • "UNUSED"
  • "BOTH"

Result


Array of disk information or object with disk details depending on query options.

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


*Required roles:* REPORTING_READ