Using Active Upgrade Environment Variables; Table 3-5. Environment Variables For Custom Actions - NEC Express5800/320Ma User Manual

Configuring Custom Actions
Related Topics
•
"Programming Notes for Custom Actions" on page 3-15
•
"Configuring Custom Actions" on page 3-12

Using Active Upgrade Environment Variables

You can optionally use the environment variables specified in
that you write for a custom action. These environment variables are useful if you want
to write a conditional statement in your program that, for example, runs only on a
particular side of the system or only during a particular stage of the Active Upgrade
process.

Table 3-5. Environment Variables for Custom Actions

Environment Variable
ACTIVE_UPGRADE_SIDE
ACTIVE_UPGRADE_STATE
ACTIVE_UPGRADE_REQUEST
ACTIVE_UPGRADE_HW_SPLIT
By default, these environment variables are available to any child process of the Active
Upgrade console, including executable files for custom actions. However, if necessary,
you can also pass the environment variables to your executable files as arguments.
For example, to pass only the ACTIVE_UPGRADE_SIDE variable to an executable
file, append the following string to the Arguments for the custom action on the Custom
Actions page:
%ACTIVE_UPGRADE_SIDE%
3-16 Express5800/320Ma: Active Upgrade™ User's Guide
Description
Describes the side of the system on which the program
is running.
Values: Production, Upgrade
Describes the current upgrade state.
Values: Idle, PrepareSplit, Split, PrepareMerge, Merge,
Commit, Abort
Describes the current task that the Active Upgrade
console is executing.
Values: Idle, CheckReadiness, PrepareSplit,
ExecuteSplit, PrepareMerge, ExecuteMerge, Commit,
Abort, Start, Stop, Backup
Describes whether or not the system is running in split
mode.
Values: Yes, No
Table 3-5 in any program