A Console Shutting Down notification is emitted by the API to report that the console application
is about to be shut down or restarted
Characteristic |
Description |
Destination |
The per-session object notification topic for each API session that is
authorized to receive the notification. |
In addition to the common JMS message headers described above, the following additional message
property is provided to allow for message selection:
Message property name |
Description |
notification-type |
Contains the value "console-shutting-down". |
The body of a Console Shutting Down notification message is a JSON representation of an object
that contains the following fields and values:
Field name |
Type |
Description |
console-type |
String Enum |
Type of console:
- "hmc" - A Hardware Management Console (HMC).
- "se" - A Support Element Console (SE).
|
invoker |
String Enum |
The invoker of the shutdown or restart:
- "user" - Initiated by a user action
- "automation" - Initiated through an automation interface.
- "firmware" - Initiated by firmware.
- "other" - Some other invoker.
|
reason |
String Enum |
The reason for the shutdown:
- "firmware-update" - A firmware update is being performed.
- "problem-recovery" - Restart is needed to recover from a problem.
- "repair" - The restart is the result of a repair action.
- "switch" - The restart was part of a primary/alternate switch operation.
- "other" - Some other reason.
|
shutdown-type |
String Enum |
The type of shutdown being performed:
- "application" - An application restart only.
- "restart" - A total console restart (i.e. reboot).
- "shutdown" - A complete shutdown of the console without a restart.
- "power-off" - A shutdown of the console followed by a power off of the console
hardware.
|
component |
String Enum |
The name of the Console component that initiated the shutdown or restart:
- "firmware-management" - Manages the firmware for the system.
- "problem-analysis" - Analyzes potential problems encountered for the system.
- "serviceability" - Performs service actions for the system.
- "pri-alt-support-element" - Manages the execution of the redundant Support Elements.
- "other" - Some other component.
|
delay-tolerance |
Integer |
The time in seconds that the Console will allow for shutdown delays before the
shutdown associated with the notification occurs:
- 0 - Delays for this shutdown are not allowed.
- > 0 - The maximum time, in seconds, the shutdown can be delayed.
- < 0 - Any valid delay time is allowed.
|
time-until-start |
Integer |
The time in seconds until the associated shutdown or restart operation will be
started:
- 0 - The operation will be started immediately.
- > 0 - The amount of time an application has before the operation starts.
- < 0 - The operation will be started when there are no remaining applications delaying the
shutdown.
|