tunable.get_instance ==================== Returns instance matching `id`. If `id` is not found, Validation error is raised. Please see `query` method documentation for `options`. .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer
Parameter 2: options

options

Type: object Default: {}

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 Properties

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).

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

Example:

[
        "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.

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

Example:

[
        "username",
        "Authentication.status"
    ]

Count

Type: boolean Default: false

Return a numeric value representing the number of items that match the specified query-filters.

Get

Type: boolean Default: false

Return 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: 0

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.

Limit

Type: integer Default: 0

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 Sql Filters

Type: boolean Default: false

Force use of SQL for result filtering to reduce response time. May not work for all methods.

TunableEntry

Type: object
No Additional Properties

Type

Type: enum (of string) Default: "SYSCTL"
  • 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).
Must be one of:
  • "SYSCTL"
  • "UDEV"
  • "ZFS"

Var

Type: string

Name or identifier of the system parameter to tune.

Value

Type: string

Value to assign to the tunable parameter.

Comment

Type: string Default: ""

Optional descriptive comment explaining the purpose of this tunable.

Enabled

Type: boolean Default: true

Whether this tunable is active and should be applied.

Update Initramfs

Type: boolean Default: true

If false, then initramfs will not be updated after creating a ZFS tunable and you will need to run system boot update_initramfs manually.

Id

Type: integer

Unique identifier for the tunable configuration.

Orig Value

Type: string

Original system value of the parameter before this tunable was applied.


*Required roles:* SYSTEM_TUNABLE_READ