File: ActionParameter.rst

package info (click to toggle)
python-pyvmomi 6.7.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 14,980 kB
  • sloc: python: 9,206; xml: 77; makefile: 9
file content (42 lines) | stat: -rw-r--r-- 1,291 bytes parent folder | download | duplicates (5)
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
.. _vim.action.Action: ../../../vim/action/Action.rst

.. _vim.action.Action.ActionParameter: ../../../vim/action/Action/ActionParameter.rst

vim.action.Action.ActionParameter
=================================
  These constant strings can be used as parameters in user-specified email subject and body templates as well as in scripts. The action processor in VirtualCenter substitutes the run-time values for the parameters. For example, an email subject provided by the client could be the string:"Alarm - {alarmName} Description:\n{eventDescription}". Or a script action provided could be:"myScript {alarmName}"
  :contained by: `vim.action.Action`_

  :type: `vim.action.Action.ActionParameter`_

  :name: alarm

values:
--------

target
   The object of the entity where the alarm is assocaited.

eventDescription
   The event description.

newStatus
   The status after the alarm is triggered.

alarm
   The object of the triggering alarm.

oldStatus
   The status prior to the alarm being triggered.

declaringSummary
   A summary of declarations made during the triggering of the alarm.

alarmName
   The name of the triggering alarm.

targetName
   The name of the entity where the alarm is triggered.

triggeringSummary
   A summary of information involved in triggering the alarm.