Administration: System Offline

Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.

Input Parameter Description

NameTypeDescription
offlineboolean

Set to true if desired state is offline. The supported values are:

  • true
  • false
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
flush_to_disk

Flush to disk when going offline The supported values are:

  • true
  • false

Output Parameter Description

NameTypeDescription
is_offlinebooleanReturns true if the system is offline, or false otherwise.
infomap of string to stringsAdditional information.