Table Of Contents

Previous topic

initshutdownscript.delete

Next topic

initshutdownscript.query

initshutdownscript.get_instance

Returns instance matching id. If id is not found, Validation error is raised.

Please see query method documentation for options.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer
Parameter 2: options

options

Type: object Default: {}
No Additional Properties

Relationships

Type: boolean Default: true

Extend

Default: null

Type: string
Type: null

Extend Context

Default: null

Type: string
Type: null

Prefix

Default: null

Type: string
Type: null

Extra

Type: object Default: {}

Order By

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

Select

Type: array Default: []
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

Count

Type: boolean Default: false

Get

Type: boolean Default: false

Offset

Type: integer Default: 0

Limit

Type: integer Default: 0

Force Sql Filters

Type: boolean Default: false

InitShutdownScriptEntry

Type: object
No Additional Properties

Type

Type: enum (of string)
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

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: ""

Must be at most 255 characters long

Id

Type: integer


Required roles: