Scripting Object - VcAlarm

Scripting-object corresponding to
Alarm
Attribute of
VcAlarmEventArgument, VcAlarmInfo, VcAlarmState, VcCDCAlarmChange, VcEventFilterSpec, VcTaskFilterSpec, VcTaskReasonAlarm
Parameter to
acknowledgeAlarm, setAlarmStatus
Returned by
createAlarm, createPrivateAlarm, getAlarm, queryPrivateAlarms

Scripting Object Description

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 {@link vim.ManagedEntity ManagedEntity} object.

Attributes

Name Type Description
availableFieldVcCustomFieldDef []

@since VI API 2.5
idString

@since Unknown
infoVcAlarmInfo

@since VI API 2.5
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
valueVcCustomFieldValue []

@since VI API 2.5
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, reconfigureAlarm, removeAlarm, setCustomValue

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

reconfigureAlarm

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. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcAlarmSpec


Return Value

Type Description
None

removeAlarm

Removes the alarm. @since VI API 2.5

Parameters

NameTypeDescription
None

Return Value

Type Description
None

setCustomValue

Assigns a value to a custom field. The setCustomValue method requires whichever updatePrivilege is defined as one of the {@link CustomFieldsManager.FieldDef#fieldInstancePrivileges} for the CustomFieldDef whose value is being changed. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None