action warn

action warn Structure: Warn users of imminent host affecting action.

action warn structure
seconds integer: optional
image string: optional, length 1..1024
message string: optional, length 1..1024
context array of notification context: optional

Description

Notify active users of the host that an action is about to perform that will affect the host.

warn inserts an entry in the Notifications's warn queue. Interested clients observe this queue and display a prominent warning to users current active on the host.

This action must be included before shut down, log out, restart, and other significant actions.

Fields

seconds

Seconds to display the warning.

The warning will be active for this many seconds. While active the warning will appear in Notifications's warning queue.

Avoid including this value. A global default is used when this value is omitted. Administrators and users prefer consistent warning periods.

image

A Universal Image Identifer.

image is a Universal Image Identifer (UII). The image may be used in association with the warning for any user interface.

message

Warning message.

context

Additional context for warning clients.

Back to action warn.