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

InitShutdownScriptEntry

Type: object
No Additional Properties

Type

Type: enum (of string)

Type of init/shutdown script to execute.

  • COMMAND: Execute a single command
  • SCRIPT: Execute a script file
Must be one of:
  • "COMMAND"
  • "SCRIPT"

Command

Default: ""

Must be given if type="COMMAND".

Type: string
Type: null

Script

Default: ""

Must be given if type="SCRIPT".

Type: string
Type: null

When

Type: enum (of string)
  • "PREINIT": Early in the boot process before all services have started.
  • "POSTINIT": Late in the boot process when most services have started.
  • "SHUTDOWN": On shutdown.
Must be one of:
  • "PREINIT"
  • "POSTINIT"
  • "SHUTDOWN"

Enabled

Type: boolean Default: true

Whether the init/shutdown script is enabled to execute.

Timeout

Type: integer Default: 10

An integer time in seconds that the system should wait for the execution of the script/command.

A hard limit for a timeout is configured by the base OS, so when a script/command is set to execute on SHUTDOWN, the hard limit configured by the base OS is changed adding the timeout specified by script/command so it can be ensured that it executes as desired and is not interrupted by the base OS's limit.

Comment

Type: string Default: ""

Optional comment describing the purpose of this script.

Must be at most 255 characters long

Id

Type: integer

Unique identifier for the init/shutdown script.


*Required roles:* SYSTEM_CRON_READ