openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
dbad63e88d06b08d4f1aac358ad3a7f953396ae1
deb-python-pyvmomi/docs/vim/alarm/Alarm.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
Raw Blame History

vim.alarm.Alarm

This managed object type defines an alarm that is triggered and an action that occurs due to the triggered alarm when certain conditions are met on a specific ManagedEntity object.

extends

vim.ExtensibleManagedObject

Attributes

info (vim.alarm.AlarmInfo):
privilege: System.View

Information about this alarm.

Methods

RemoveAlarm():

Removes the alarm.

Privilege:

Alarm.Delete

Args:

Returns:

None

ReconfigureAlarm(spec):

Reconfigures the alarm properties. This operation requires access privileges on the entity with which the alarm is associated.In addition to the Alarm.Edit privilege, may also require the Global.ScriptAction if a RunScriptAction action is specified in the AlarmSpec.

Privilege:

Alarm.Edit

Args:
spec (vim.alarm.AlarmSpec):

The new specification for the alarm.

Returns:

None

Raises:

vim.fault.InvalidName:

if the alarm name is empty or too long.

vim.fault.DuplicateName:

if an alarm with the name already exists.

vmodl.fault.InvalidArgument:

if the specification is invalid.