Version:

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

Name Type Description
offline boolean

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

  • true
  • false
options map 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

Name Type Description
is_offline boolean Returns true if the system is offline, or false otherwise.
info map of string to strings Additional information.