disk.query¶
Query disks.
The following extra options are supported:
include_expired (bool): Also include expired disks (default: false). passwords (bool): Don’t hide KMIP password for the disks (default: false). pools (bool): Join pool name for each disk (default: false).
No Additional Items
Tuple Validation
Parameter 1: filters
filters
Type: array Default: []List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional ItemsEach item of this array must be:
[
    [
        "name",
        "=",
        "bob"
    ]
]
[
    [
        "OR",
        [
            [
                [
                    "name",
                    "=",
                    "bob"
                ]
            ],
            [
                [
                    "name",
                    "=",
                    "larry"
                ]
            ]
        ]
    ]
]
Parameter 2: options
options
Type: objectQuery options customize the results returned by a query method. More complete documentation with examples
 are covered in the "Query methods" section of the TrueNAS API documentation. 
Extra
Type: object Default: {}Extra options are defined on a per-endpoint basis and are described in the documentation for the associated
 query method. 
Order By
Type: array of string Default: []An array of field names describing the manner in which query results should be ordered. The field names may
 also have one of more of the following special prefixes: - (reverse sort direction), nulls_first: (place
 any null values at the head of the results list), nulls_last: (place any null values at the tail of the
 results list). 
Each item of this array must be:
[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]
Select
Type: array Default: []An array of field names specifying the exact fields to include in the query return. The dot character .
 may be used to explicitly select only subkeys of the query result. 
Each item of this array must be:
No Additional Items
Each item of this array must be:
[
    "username",
    "Authentication.status"
]
Count
Type: boolean Default: falseReturn a numeric value representing the number of items that match the specified query-filters. 
Get
Type: boolean Default: falseReturn the JSON object of the first result matching the specified query-filters. The query fails
 if there specified query-filters return no results. 
Offset
Type: integer Default: 0This specifies the beginning offset of the results array. When combined with the limit query-option
 it may be used to implement pagination of large results arrays. WARNING: some query methods provide
 volatile results and the onus is on the developer to understand whether pagination is appropriate
 for a particular query API method. 
Limit
Type: integer Default: 0This specifies the maximum number of results matching the specified query-filters to return. When
 combined wtih the offset query-option it may be used to implement pagination of large results arrays.
 WARNING: some query methods provide volatile results and the onus is on the developer to understand whether
 pagination is appropriate for a particular query API method. 
Force Sql Filters
Type: boolean Default: falseResult
No Additional Items
Each item of this array must be:
DiskQueryResultItem
Type: objectNo Additional Properties
Identifier
Type: stringName
Type: stringSubsystem
Type: stringNumber
Type: integerSerial
Type: stringLunid
Size
Description
Type: stringTransfermode
Type: stringHddstandby
Type: enum (of string)Must be one of:
- "ALWAYS ON"
- "5"
- "10"
- "20"
- "30"
- "60"
- "120"
- "180"
- "240"
- "300"
- "330"
Advpowermgmt
Type: enum (of string)Must be one of:
- "DISABLED"
- "1"
- "64"
- "127"
- "128"
- "192"
- "254"
Expiretime
Model
Rotationrate
Type
Zfs Guid
Bus
Type: stringDevname
Type: stringDiskEntryEnclosure
Type: objectNo Additional Properties
Number
Type: integerSlot
Type: integerPool
Passwd
Type: stringKmip Uid
DiskQueryResultItem
Type: objectNo Additional Properties
Identifier
Type: stringName
Type: stringSubsystem
Type: stringNumber
Type: integerSerial
Type: stringLunid
Size
Description
Type: stringTransfermode
Type: stringHddstandby
Type: enum (of string)Must be one of:
- "ALWAYS ON"
- "5"
- "10"
- "20"
- "30"
- "60"
- "120"
- "180"
- "240"
- "300"
- "330"
Advpowermgmt
Type: enum (of string)Must be one of:
- "DISABLED"
- "1"
- "64"
- "127"
- "128"
- "192"
- "254"
Expiretime
Model
Rotationrate
Type
Zfs Guid
Bus
Type: stringDevname
Type: stringPool
Passwd
Type: stringKmip Uid
Required roles: DISK_READ