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
No Additional Items
No Additional Properties
No Additional Items
No Additional Items
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: objectDefault:
{
"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: trueExtend
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
No Additional Items
Each item of this array must be:
Type: object
Count
Type: boolean Default: falseGet
Type: boolean Default: falseOffset
Type: integer Default: 0Limit
Type: integer Default: 0Force Sql Filters
Type: boolean Default: falseResult
Type: array of object
No Additional Items
No Additional Items
Each item of this array must be:
Enclosure2QueryResultItem
Type: objectAdditional Properties of any type are allowed.
Type: objectEnclosure2QueryResultItem
Type: objectAdditional Properties of any type are allowed.
Type: object
Type: integer
Required roles: ENCLOSURE_READ