disk.details

Return detailed information for all disks on the system.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object
No Additional Properties

Join Partitions

Type: boolean Default: false

When True will return all partitions currently
written to disk.

NOTE: this is an expensive operation.

Type

Type: enum (of string) Default: "BOTH"

If USED, only disks that are IN USE will be returned.
If UNUSED, only disks that are NOT IN USE are returned.
If BOTH, used and unused disks will be returned.

Must be one of:
  • "USED"
  • "UNUSED"
  • "BOTH"

Result


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


Required roles: REPORTING_READ