VMware provides command-line parameters that function as a substitute for the default alarm environment variables. You can use these parameters when running a script as an alarm action for a condition, state, or event alarm.

The command-line parameters enable you to pass alarm information without having to change an alarm script. For example, you can use these parameters when you have an external program for which you do not have the source. You can pass in the necessary data by using the substitution parameters, which take precedence over the environment variables. You pass the parameters through the Configuration dialog box in the alarm definition wizard or on a command line.

Table 1. Command-Line Parameters for Alarm Action Scripts

Variable

Description

{eventDescription}

The text of the alarmStatusChange event. The {eventDescription} variable is supported only for Condition and State alarms.

{targetName}

The name of the entity on which the alarm is triggered.

{alarmName}

The name of the alarm that is triggered.

{triggeringSummary}

A summary of the alarm trigger values.

{declaringSummary}

A summary of the alarm declaration values.

{oldStatus}

The alarm status before the alarm is triggered.

{newStatus}

The alarm status after the alarm is triggered.

{target}

The inventory object on which the alarm is set.