Method GetAlarmProperty

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

GetAlarmProperty(AlarmID, string)

Retrieves the value of the specified custom alarm property.

public string GetAlarmProperty(AlarmID alarmID, string propertyName)

Parameters

alarmID AlarmID

The alarm ID

propertyName string

The name of the alarm property.

Returns

string

The value of the specified alarm property.

Examples

string propertyValue = engine.GetAlarmProperty(new AlarmID(new AlarmTreeID(200, 400, 59851), 59853), "SourceDetail");

Exceptions

ArgumentException

Alarm not found.

GetAlarmProperty(int, int, string)

Retrieves the value of the specified custom alarm property.

[Obsolete("Please use the overload that takes an AlarmID object (still supported in <= 10.6 on non-swarming systems)")]
public string GetAlarmProperty(int dataMinerID, int alarmID, string propertyName)

Parameters

dataMinerID int

The DataMiner Agent ID.

alarmID int

The alarm ID.

propertyName string

The name of the alarm property.

Returns

string

The value of the specified alarm property.

Examples

string propertyValue = engine.GetAlarmProperty(200, 59851, "SourceDetail");

Remarks

Although this method is obsolete, it will still work on a DMS without Swarming enabled until 10.6.

Exceptions

ArgumentException

Alarm not found.

GetAlarmProperty(int, int, int, string)

Retrieves the value of the specified custom alarm property.

public string GetAlarmProperty(int dataMinerID, int elementID, int alarmID, string propertyName)

Parameters

dataMinerID int

The DataMiner Agent ID.

elementID int

The element ID.

alarmID int

The alarm ID.

propertyName string

The name of the alarm property.

Returns

string

The value of the specified alarm property.

Examples

string propertyValue = engine.GetAlarmProperty(200, 400, 59851, "SourceDetail");

Remarks

For performance reasons, we recommend using the overload that takes an AlarmID instead.

Exceptions

ArgumentException

Alarm not found.