Skip to main content
admin_offline(offline=None, options=)[source]

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

Parameters

offline (bool) –

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

  • True

  • False

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • flush_to_disk – Flush to disk when going offline. Allowed values are:

    • true

    • false

The default value is an empty dict ( ).

Returns

A dict with the following entries–

is_offline (bool) –

Returns true if the system is offline, or false otherwise.

info (dict of str to str) –

Additional information.