enclosure2.query

Query detected enclosures on TrueNAS hardware.

Returns an array of enclosure objects representing the head unit (controller) and any attached JBODs or JBOFs. Each entry contains hardware identification, physical layout information, and per-slot element details including disk mappings and status.

Note

This method only returns results on TrueNAS-sold hardware. An empty array is returned on generic or non-TrueNAS systems.

Results are sorted with controller enclosures first, then by enclosure ID.

Examples:

Query all enclosures:

[]

Query only the controller (head unit):

[
    [["controller", "=", true]]
]

Query a specific enclosure by ID:

[
    [["id", "=", "5b0bd6d1a30714bf"]],
    {"get": true}
]
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: filters

filters

Type: array Default: []
No Additional Items
Each item of this array must be:
Type: object
Parameter 2: options

options

Type: object
Default:
{ "relationships": true, "extend": null, "extend_context": null, "prefix": null, "extra": {}, "order_by": [], "select": [], "count": false, "get": false, "offset": 0, "limit": 0, "force_sql_filters": false }

No Additional Properties

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string
Type: null

Extend Context

Default: null

Type: string
Type: null

Prefix

Default: null

Type: string
Type: null

Extra

Type: object Default: {}

Order By

Type: array of string Default: []
No Additional Items
Each item of this array must be:
Type: string

Select

Type: array Default: []
No Additional Items
Each item of this array must be:

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

Count

Type: boolean Default: false

Get

Type: boolean Default: false

Offset

Type: integer Default: 0

Value must be greater or equal to 0

Limit

Type: integer Default: 0

Value must be greater or equal to 0 and lesser or equal to 10000

Force Sql Filters

Type: boolean Default: false

Result


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

Enclosure2Entry

Type: object

Additional Properties of any type are allowed.

Type: object

Enclosure2Entry

Type: object

Additional Properties of any type are allowed.

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


Required roles: ENCLOSURE_READ