NEC Express5800/R320a-E4 User Manual page 302

5-142 Installing and Using Utilities
Using Active Upgrade Environment Variables
You can optionally use the environment variables specified in the below table in any executable that
you write for a custom action. These environment variables are useful if you want to write a
conditional statement in your executable that, for example, runs only on a particular side of the
system or only during a particular stage of the Active Upgrade process.
Environment Variables for Custom Actions
Environment Variable
ACTIVE_UPGRADE_SIDE
ACTIVE_UPGRADE_STATE
ACTIVE_UPGRADE_REQUEST
ACTIVE_UPGRADE_HW_SPLIT
If you want these environment variables to be available to your executables, you must pass the
variables to each executable in which you will use them.
For example, to pass only the ACTIVE_UPGRADE_SIDE variable to an executable, append the
following string to the Arguments for the custom action on the Custom Actions page:
%ACTIVE_UPGRADE_SIDE%
To pass multiple variables, add a space between each variable, as follows:
%ACTIVE_UPGRADE_SIDE% %ACTIVE_UPGRADE_REQUEST%
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 next upgrade task that the Active Upgrade
Console will execute.
Values: Idle, CheckReadiness, PrepareSplit, ExecuteSplit,
PrepareMerge, ExecuteMerge, Commit, Abort, Start, Stop,
Backup
Describes whether or not the ft series system is running in
split mode.
Values: Yes, No