deb-python-pyvmomi/docs/vim/alarm/AlarmManager.rst

vim.alarm.AlarmManager

The alarm manager is a singleton object for managing alarms within a service instance.

Attributes

defaultExpression ([vim.alarm.AlarmExpression]):

privilege: System.View

The default setting for each alarm expression, used to populate the initial client wizard screen.

description (vim.alarm.AlarmDescription):

privilege: System.View

The static descriptive strings used in alarms.

Methods

CreateAlarm(entity, spec):

Creates an alarm.In addition to the Alarm.Create privilege, may also require the Global.ScriptAction if a RunScriptAction action is specified in the AlarmSpec.

Privilege:

Args:

entity (vim.ManagedEntity):

The entity with which the alarm is associated.

spec (vim.alarm.AlarmSpec):

The specification for the new alarm.

Returns:

vim.alarm.Alarm:

A reference to the Alarm object created by the operation.

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.

GetAlarm(entity):

Available alarms defined on the entity. These alarms do not include any inherited alarms; that is, alarms associated with parent entities.

Privilege:

System.View

Args:

entity (vim.ManagedEntity, optional):

The entity. If not set, alarms are returned for all visible entities.

Returns:

[vim.alarm.Alarm]:

A reference to the Alarm objects returned by the operation.

AreAlarmActionsEnabled(entity):

Returns true if alarm actions are enabled on the specified managed entity. since: vSphere API 4.0

Privilege:

Args:

entity (vim.ManagedEntity):

The managed entity to look up.

Returns:

bool:

EnableAlarmActions(entity, enabled):

Enables or disables alarms on the specified managed entity. since: vSphere API 4.0

Privilege:

Args:

entity (vim.ManagedEntity):

The managed entity on which to set a schedule.

enabled (bool):

true, if alarms are enabled during the schedule.

Returns:

None

GetAlarmState(entity):

The state of instantiated alarms on the entity.

Privilege:

Args:

entity (vim.ManagedEntity):

The entity.

Returns:

[vim.alarm.AlarmState]:

The state of instantiated alarms.

Raises:

vmodl.fault.InvalidRequest:

if the referenced entity is null.

vmodl.fault.ManagedObjectNotFound:

if the referenced entity is invalid.

AcknowledgeAlarm(alarm, entity):

Acknowledge the alarm on a managed entity. The actions associated with the alarm will not fire until the alarm's next distinct occurrence; that is, until after the alarm has entered the green or gray states at least once. Calling this method on an acknowledged or non-triggered alarm. since: vSphere API 4.0

Privilege:

Args:

alarm (vim.alarm.Alarm):

The Alarm to acknowledge.

entity (vim.ManagedEntity):

The ManagedEntity for which to acknowledge the Alarm.

Returns:

None

Raises:

vmodl.fault.InvalidRequest:

if the referenced alarm/entity is null

vmodl.fault.InvalidArgument:

if the tuple doesn't exist.

vmodl.fault.ManagedObjectNotFound:

if the referenced alarm/entity is invalid.