VMware 4817V62 Administration Guide - Page 246

Running Scripts as Alarm Actions, Alarm Environment Variables

Page 246 highlights

vSphere Basic System Administration If the alarm was triggered by an event, the information in Table 21-20 is also included in the body of the email. Table 21-20. Event Details in Email Detail Description Event Details VMODL event type name. Summary Alarm summary, including the event type, alarm name, and target object. Date Time and date the alarm was triggered. UserName Person who initiated the action that caused the event to be created. Events caused by an internal system activity do not have a UserName value. Host Host on which the alarm was triggered. Resource Pool Resource pool on which the alarm was triggered. Datacenter Datacenter on which the alarm was triggered. Arguments Arguments passed with the alarm and their values. Running Scripts as Alarm Actions You can write scripts and attach them to alarms so that when the alarm triggers, the script runs. Use the alarm environment variables to define complex scripts and attach them to multiple alarms or inventory objects. For example, you can write a script that enters the following trouble ticket information into an external system when an alarm is triggered: n Alarm name n Object on which the alarm was triggered n Event that triggered the alarm n Alarm trigger values When you write the script, include the following environment variables in the script: n VMWARE_ALARM_NAME n VMWARE_ALARM_TARGET_NAME n VMWARE_ALARM_EVENTDESCRIPTION n VMWARE_ALARM_ALARMVALUE You can attach the script to any alarm on any object without changing the script. Alarm Environment Variables To simplify script configuration for alarm actions, VMware provides environment variables for VMware alarms. Table 21-21 lists the default environment variables defined for alarms. Use these variables to define more complex scripts and attach them to multiple alarms or inventory objects so the action occurs when the alarm triggers. Table 21-21. Alarm Environment Variables Variable Name Variable Description Supported Alarm Type VMWARE_ALARM_NAME VMWARE_ALARM_ID Name of the triggered alarm. MOID of the triggered alarm. Condition, State, Event Condition, State, Event 246 VMware, Inc.

  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24
  • 25
  • 26
  • 27
  • 28
  • 29
  • 30
  • 31
  • 32
  • 33
  • 34
  • 35
  • 36
  • 37
  • 38
  • 39
  • 40
  • 41
  • 42
  • 43
  • 44
  • 45
  • 46
  • 47
  • 48
  • 49
  • 50
  • 51
  • 52
  • 53
  • 54
  • 55
  • 56
  • 57
  • 58
  • 59
  • 60
  • 61
  • 62
  • 63
  • 64
  • 65
  • 66
  • 67
  • 68
  • 69
  • 70
  • 71
  • 72
  • 73
  • 74
  • 75
  • 76
  • 77
  • 78
  • 79
  • 80
  • 81
  • 82
  • 83
  • 84
  • 85
  • 86
  • 87
  • 88
  • 89
  • 90
  • 91
  • 92
  • 93
  • 94
  • 95
  • 96
  • 97
  • 98
  • 99
  • 100
  • 101
  • 102
  • 103
  • 104
  • 105
  • 106
  • 107
  • 108
  • 109
  • 110
  • 111
  • 112
  • 113
  • 114
  • 115
  • 116
  • 117
  • 118
  • 119
  • 120
  • 121
  • 122
  • 123
  • 124
  • 125
  • 126
  • 127
  • 128
  • 129
  • 130
  • 131
  • 132
  • 133
  • 134
  • 135
  • 136
  • 137
  • 138
  • 139
  • 140
  • 141
  • 142
  • 143
  • 144
  • 145
  • 146
  • 147
  • 148
  • 149
  • 150
  • 151
  • 152
  • 153
  • 154
  • 155
  • 156
  • 157
  • 158
  • 159
  • 160
  • 161
  • 162
  • 163
  • 164
  • 165
  • 166
  • 167
  • 168
  • 169
  • 170
  • 171
  • 172
  • 173
  • 174
  • 175
  • 176
  • 177
  • 178
  • 179
  • 180
  • 181
  • 182
  • 183
  • 184
  • 185
  • 186
  • 187
  • 188
  • 189
  • 190
  • 191
  • 192
  • 193
  • 194
  • 195
  • 196
  • 197
  • 198
  • 199
  • 200
  • 201
  • 202
  • 203
  • 204
  • 205
  • 206
  • 207
  • 208
  • 209
  • 210
  • 211
  • 212
  • 213
  • 214
  • 215
  • 216
  • 217
  • 218
  • 219
  • 220
  • 221
  • 222
  • 223
  • 224
  • 225
  • 226
  • 227
  • 228
  • 229
  • 230
  • 231
  • 232
  • 233
  • 234
  • 235
  • 236
  • 237
  • 238
  • 239
  • 240
  • 241
  • 242
  • 243
  • 244
  • 245
  • 246
  • 247
  • 248
  • 249
  • 250
  • 251
  • 252
  • 253
  • 254
  • 255
  • 256
  • 257
  • 258
  • 259
  • 260
  • 261
  • 262
  • 263
  • 264
  • 265
  • 266
  • 267
  • 268
  • 269
  • 270
  • 271
  • 272
  • 273
  • 274
  • 275
  • 276
  • 277
  • 278
  • 279
  • 280
  • 281
  • 282
  • 283
  • 284
  • 285
  • 286
  • 287
  • 288
  • 289
  • 290
  • 291
  • 292
  • 293
  • 294
  • 295
  • 296
  • 297
  • 298
  • 299
  • 300
  • 301
  • 302
  • 303
  • 304
  • 305
  • 306
  • 307
  • 308
  • 309
  • 310
  • 311
  • 312
  • 313
  • 314
  • 315
  • 316
  • 317
  • 318
  • 319
  • 320
  • 321
  • 322
  • 323
  • 324
  • 325
  • 326
  • 327
  • 328
  • 329
  • 330
  • 331
  • 332
  • 333
  • 334
  • 335
  • 336
  • 337
  • 338
  • 339
  • 340
  • 341
  • 342
  • 343
  • 344
  • 345
  • 346
  • 347
  • 348
  • 349
  • 350
  • 351
  • 352
  • 353
  • 354
  • 355
  • 356
  • 357
  • 358
  • 359
  • 360
  • 361
  • 362
  • 363
  • 364

If the alarm was triggered by an event, the information in
Table 21-20
is also included in the body of the email.
Table 21-20.
Event Details in Email
Detail
Description
Event Details
VMODL event type name.
Summary
Alarm summary, including the event type, alarm name, and target object.
Date
Time and date the alarm was triggered.
UserName
Person who initiated the action that caused the event to be created. Events caused by an
internal system activity do not have a UserName value.
Host
Host on which the alarm was triggered.
Resource Pool
Resource pool on which the alarm was triggered.
Datacenter
Datacenter on which the alarm was triggered.
Arguments
Arguments passed with the alarm and their values.
Running Scripts as Alarm Actions
You can write scripts and attach them to alarms so that when the alarm triggers, the script runs.
Use the alarm environment variables to define complex scripts and attach them to multiple alarms or inventory
objects. For example, you can write a script that enters the following trouble ticket information into an external
system when an alarm is triggered:
n
Alarm name
n
Object on which the alarm was triggered
n
Event that triggered the alarm
n
Alarm trigger values
When you write the script, include the following environment variables in the script:
n
VMWARE_ALARM_NAME
n
VMWARE_ALARM_TARGET_NAME
n
VMWARE_ALARM_EVENTDESCRIPTION
n
VMWARE_ALARM_ALARMVALUE
You can attach the script to any alarm on any object without changing the script.
Alarm Environment Variables
To simplify script configuration for alarm actions, VMware provides environment variables for VMware
alarms.
Table 21-21
lists the default environment variables defined for alarms. Use these variables to define more
complex scripts and attach them to multiple alarms or inventory objects so the action occurs when the alarm
triggers.
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
vSphere Basic System Administration
246
VMware, Inc.