List of filters for query results. See API documentation for "Query Methods" for more guidance.
No Additional Items[
[
"name",
"=",
"bob"
]
]
[
[
"OR",
[
[
[
"name",
"=",
"bob"
]
],
[
[
"name",
"=",
"larry"
]
]
]
]
]
Query options including pagination, ordering, and additional parameters.
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.
SYSCTL: var is a sysctl name (e.g. kernel.watchdog) and value is its corresponding value (e.g. 0).UDEV: var is a udev rules file name (e.g. 10-disable-usb, .rules suffix will be appended automatically) and value is its contents (e.g. BUS=="usb", OPTIONS+="ignore_device").ZFS: var is a ZFS kernel module parameter name (e.g. zfs_dirty_data_max_max) and value is its value (e.g. 783091712).Name or identifier of the system parameter to tune.
Value to assign to the tunable parameter.
Optional descriptive comment explaining the purpose of this tunable.
Whether this tunable is active and should be applied.
If false, then initramfs will not be updated after creating a ZFS tunable and you will need to run system boot update_initramfs manually.
Unique identifier for the tunable configuration.
Original system value of the parameter before this tunable was applied.
SYSCTL: var is a sysctl name (e.g. kernel.watchdog) and value is its corresponding value (e.g. 0).UDEV: var is a udev rules file name (e.g. 10-disable-usb, .rules suffix will be appended automatically) and value is its contents (e.g. BUS=="usb", OPTIONS+="ignore_device").ZFS: var is a ZFS kernel module parameter name (e.g. zfs_dirty_data_max_max) and value is its value (e.g. 783091712).Name or identifier of the system parameter to tune.
Value to assign to the tunable parameter.
Optional descriptive comment explaining the purpose of this tunable.
Whether this tunable is active and should be applied.
If false, then initramfs will not be updated after creating a ZFS tunable and you will need to run system boot update_initramfs manually.
Unique identifier for the tunable configuration.
Original system value of the parameter before this tunable was applied.