Unshelve.Severity() method
- Last UpdatedJul 19, 2024
- 1 minute read
The Unshelve.Severity() method unshelves all shelved alarms of a specified alarm severity that belong to the same specified provider and alarm group.
Syntax
AlarmClient.Unshelve.Severity("ProviderName","GroupName",Severity,"Duration=<Duration>;Reason="+"<Reason>"+"UnShelved"+"<Description>"+";");
Parameters
ProviderName
Node and provider name combination that specifies the origin of alarm monitoring.
GroupName
Alarm group or area name whose alarms are monitored by the Alarm Control.
Severity
Single-digit (1-4) alarm severity.
Duration
Duration must be set to 0 to unshelve alarms.
Reason
Explanation up to 200 characters for unshelving the active alarms of the specified severity.
An explanation is optional to unshelve alarms and the Reason parameter can be specified as Reason="" to indicate a null explanation.
Example
AlarmClient1.Unshelve.Severity("\Galaxy","Area_001",3,"Duration=0;Reason="+""""+"UnShelved"+""""+";");
Remarks
For more information about unshelving alarms, see Unshelve Alarms.