system.shutdown

Shuts down the operating system.

An “added” event of name “system” and id “shutdown” is emitted when shutdown is initiated.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: reason

reason

Type: string

Reason for the system shutdown.

Must be at least 1 characters long

Parameter 2: options

options

Type: object

Options for controlling the shutdown process.

No Additional Properties

delay

Delay

Default: null

Delay in seconds before shutting down. null for immediate shutdown.

Any of

• Option 1
• Option 2

Type: integer

Type: null

Return value

Result

Type: null

Returns null on successful shutdown initiation.

Required roles: FULL_ADMIN