Operating system message notification

An operating system message notification is emitted by the API to report new or refreshed operating system messages.

In addition to the common fields, the following are also included:

Field name Type Description
os-messages Array of objects An array of nested os-message-info objects, the format of which is described in the next table. The order in which these objects appear in this array reflects the temporal order in which the messages were created.

Each nested os-message-info object has the following fields and values:

Field name Type Description
sequence-number Long The sequence number assigned to this operating system message by the HMC. Although sequence numbers may wrap over time, this number can be considered a unique identifier for the message.
message-text String The text of the new or refreshed operating system message.
message-id Long The message identifier of the operating system message.
timestamp Timestamp The timestamp represents the date and time when the operating system message was created. A value of -1 is returned if this information is not available from the corresponding operating system.
sound-alarm Boolean Specifies whether the operating system message should cause the alarm to be sounded (true) or not (false).
is-priority Boolean Specifies whether the operating system message is a priority message (true) or not (false). A priority message indicates a critical condition that requires immediate attention.
is-held Boolean Specifies whether the operating system message is a held message (true) or not (false). A held message is one that requires a response.
prompt-text String Specifies the prompt text that is associated with this operating system message or null indicating that there is no prompt text for this operating system message. The prompt text is used when responding to a message. The response is to be sent as an operating system command where the command is prefixed with the prompt text and followed by the response to the message.
os-name String (1-8) Specifies the name of the operating system that generated this operating system message or null indicating there is no operating system name associated with this operating system message. This name is determined by the operating system itself and may be unrelated to the name of the partition in which the operating system is running.