Package com.vmware.vim25.mo

Class AlarmManager

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.AlarmManager

public class AlarmManager
extends ManagedObject

Constructor Summary

Constructors

Constructor	Description
AlarmManager(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Modifier and Type	Method	Description
void	acknowledgeAlarm(Alarm alarm, ManagedEntity entity)
boolean	areAlarmActionsEnabled(ManagedEntity entity)	Whether or not alarm actions are available on the given ManagedEntity
void	clearTriggeredAlarms(AlarmFilterSpec filter)
Alarm	create(ManagedEntity entity, AlarmSpec spec)
Alarm	createAlarm(ManagedEntity me, AlarmSpec as)	Create an alarm against the given managed entity using the alarm specification
void	disableAlarm(Alarm alarm, ManagedEntity entity)
void	enableAlarm(Alarm alarm, ManagedEntity entity)
Alarm[]	getAlarm(ManagedEntity me)
boolean	getAlarmActionsEnabled(ManagedEntity entity)
AlarmState[]	getAlarmState(ManagedEntity me)
AlarmExpression[]	getDefaultExpression()
AlarmDescription	getDescription()
void	setAlarmActionsEnabled(ManagedEntity entity, boolean enabled)
void	setAlarmStatus(Alarm alarm, ManagedEntity entity, String status)	Set the status of an alarm for the given managed entity.

Methods inherited from class com.vmware.vim25.mo.ManagedObject

convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setCachedProperty, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AlarmManager

public AlarmManager(ServerConnection serverConnection,
 ManagedObjectReference mor)

Method Details

getDefaultExpression

public AlarmExpression[] getDefaultExpression()

getDescription

public AlarmDescription getDescription()

acknowledgeAlarm

public void acknowledgeAlarm(Alarm alarm,
 ManagedEntity entity)
                      throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

clearTriggeredAlarms

public void clearTriggeredAlarms(AlarmFilterSpec filter)
                          throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

create

public Alarm create(ManagedEntity entity,
 AlarmSpec spec)
             throws DuplicateName,
InvalidName,
RuntimeFault,
RemoteException

Throws:

DuplicateName

InvalidName

RuntimeFault

RemoteException

disableAlarm

public void disableAlarm(Alarm alarm,
 ManagedEntity entity)
                  throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

enableAlarm

public void enableAlarm(Alarm alarm,
 ManagedEntity entity)
                 throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

getAlarmActionsEnabled

public boolean getAlarmActionsEnabled(ManagedEntity entity)
                               throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

setAlarmActionsEnabled

public void setAlarmActionsEnabled(ManagedEntity entity,
 boolean enabled)
                            throws RuntimeFault,
RemoteException

Throws:

RuntimeFault

RemoteException

areAlarmActionsEnabled

public boolean areAlarmActionsEnabled(ManagedEntity entity)
                               throws RuntimeFault,
RemoteException

Whether or not alarm actions are available on the given ManagedEntity

Parameters:

entity - The ManagedEntity to query.

Returns:

true if alarm actions are available

Throws:

RuntimeFault - if any unhandled runtime fault occurs

RemoteException

Since:

4.0

createAlarm

public Alarm createAlarm(ManagedEntity me,
 AlarmSpec as)
                  throws InvalidName,
DuplicateName,
RuntimeFault,
RemoteException

Create an alarm against the given managed entity using the alarm specification

Parameters:

me - The ManagedEntity to alarm against.

as - The AlarmSpec used to generate the alarm.

Returns:

The new Alarm created

Throws:

InvalidName - if the alarm name exceeds the max length or is empty.

DuplicateName - if an alarm with the same name already exists.

RuntimeFault - if any unhandled runtime fault occurs

RemoteException

getAlarm

public Alarm[] getAlarm(ManagedEntity me)
                 throws RuntimeFault,
RemoteException

Parameters:

me -

Returns:

Throws:

RuntimeFault

RemoteException

getAlarmState

public AlarmState[] getAlarmState(ManagedEntity me)
                           throws RuntimeFault,
RemoteException

Parameters:

me -

Returns:

Throws:

RuntimeFault

RemoteException

setAlarmStatus

public void setAlarmStatus(Alarm alarm,
 ManagedEntity entity,
 String status)
                    throws RuntimeFault,
RemoteException

Set the status of an alarm for the given managed entity. SetAlarmStatus is an undocumented SOAP operation that is not part of the published VMware WSDL — it was discovered via the Onyx and doublecloud proxies and is the only way to programmatically reset an alarm's ManagedEntityStatus from red back to green.

Parameters:

alarm - The Alarm to set the status of.

entity - The ManagedEntity the alarm applies to.

status - The string status corresponding to a ManagedEntityStatus to set.

Throws:

RuntimeFault - if any unhandled runtime fault occurs

RemoteException

Since:

4.x added to yavija for 5.5b.07