Files
deb-python-pyvmomi/docs/vim/alarm/AlarmSpec.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation
This external documentation for pyVmomi was generated using Googly Docs
(aka Google Standard Documentation) which renders very cleanly in
GitHub. Internal documentation for a class should be done in Sphinx
format because tools like pyCharm and Eclipse can use that documentation
as a hint for code completion.

Note: External docs as Googly Docs, internal docs as Sphinx.

Closes bug#15
2014-06-17 14:07:42 -04:00

1.6 KiB

vim.alarm.AlarmSpec

Parameters for alarm creation.

extends

vmodl.DynamicData

Attributes:

name (str):

Name of the alarm.

systemName (str, optional):

System name of the alarm.This is set only for predefined Alarms - i.e. Alarms created by the server automatically. Editing or renaming Alarms from the UI does not affect this value, and user-created Alarms do not have a systemName at all.The purpose of this field is to identify system-created Alarms reliably, even if they are edited by users.

description (str):

Description of the alarm.

enabled (bool):

Flag to indicate whether or not the alarm is enabled or disabled.

expression (vim.alarm.AlarmExpression):

Top-level alarm expression that defines trigger conditions.

action (vim.alarm.AlarmAction, optional):

Action to perform when the alarm is triggered.

actionFrequency (int, optional):

Frequency in seconds, which specifies how often appropriate actions should repeat when an alarm does not change state.

setting (vim.alarm.AlarmSetting, optional):

Tolerance and maximum frequency settings.