Installation guide

Table 21-21. Alarm Environment Variables
Variable Name Variable Description
Supported Alarm
Type
VMWARE_ALARM_NAME Name of the triggered alarm. Condition, State,
Event
VMWARE_ALARM_ID MOID of the triggered alarm. Condition, State,
Event
VMWARE_ALARM_TARGET_NAME Name of the entity on which the
alarm triggered.
Condition, State,
Event
VMWARE_ALARM_TARGET_ID MOID of the entity on which the
alarm triggered.
Condition, State,
Event
VMWARE_ALARM_OLDSTATUS Old status of the alarm. Condition, State,
Event
VMWARE_ALARM_NEWSTATUS New status of the alarm. Condition, State,
Event
VMWARE_ALARM_TRIGGERINGSUMMARY Multiline summary of the alarm. Condition, State,
Event
VMWARE_ALARM_DECLARINGSUMMARY Single-line declaration of the alarm
expression.
Condition, State,
Event
VMWARE_ALARM_ALARMVALUE Value that triggered the alarm. Condition, State
VMWARE_ALARM_EVENTDESCRIPTION Description text of the alarm status
change event.
Condition, State
VMWARE_ALARM_EVENTDESCRIPTION Description of the event that
triggered the alarm.
Event
VMWARE_ALARM_EVENT_USERNAME User name associated with the event. Event
VMWARE_ALARM_EVENT_DATACENTER Name of the datacenter in which the
event occurred.
Event
VMWARE_ALARM_EVENT_COMPUTERESOURCE Name of the cluster or resource pool
in which the event occurred.
Event
VMWARE_ALARM_EVENT_HOST Name of the host on which the event
occurred.
Event
VMWARE_ALARM_EVENT_VM Name of the virtual machine on
which the event occurred.
Event
VMWARE_ALARM_EVENT_NETWORK Name of the network on which the
event occurred.
Event
VMWARE_ALARM_EVENT_DATASTORE Name of the datastore on which the
event occurred.
Event
VMWARE_ALARM_EVENT_DVS Name of the vNetwork Distributed
Switch on which the event occurred.
Event
Alarm Command-Line Parameters
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, 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 vSphere Client Alarm Actions Configuration
dialog box or on a command line.
vSphere Basic System Administration
252 VMware, Inc.