Query 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.
No Additional PropertiesExtra options are defined on a per-endpoint basis and are described in the documentation for the associated query method.
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).
[
"size",
"-devname",
"nulls_first:-expiretime"
]
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.
[
"username",
"Authentication.status"
]
Return a numeric value representing the number of items that match the specified query-filters.
Return the JSON object of the first result matching the specified query-filters. The query fails if there specified query-filters return no results.
This 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.
This 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 use of SQL for result filtering to reduce response time. May not work for all methods.
Unique identifier for the iSCSI target.
Name of the iSCSI target (maximum 120 characters).
Must be at least 1 characters long
Must be at most 120 characters long
Optional alias name for the iSCSI target.
Protocol mode for the target.
ISCSI: iSCSI protocol onlyFC: Fibre Channel protocol onlyBOTH: Both iSCSI and Fibre Channel protocolsFibre Channel may only be selected on TrueNAS Enterprise-licensed systems with a suitable Fibre Channel HBA.
Array of portal-initiator group associations for this target.
No Additional ItemsID of the iSCSI portal to use for this target group.
ID of the authorized initiator group or null to allow any initiator.
Authentication method for this target group.
ID of the authentication credential or null if no authentication.
Array of network addresses allowed to access this target.
No Additional ItemsRelative target ID number assigned by the system.
Optional iSCSI-specific parameters for this target.
Maximum number of queued commands per iSCSI session.
32: Standard queue depth for most use cases128: Higher queue depth for performance-critical applications