Skip to main content
Version: 8.1

system.alarm.unshelve

This function is used in Python Scripting.

Description

Unshelves a list of alarms based on the source paths provided.

Client Permission Restrictions

Client Permission: Alarm Management

Client access to this scripting function is blocked to users that do not meet the role/zone requirements for the above permission type. This function is unaffected when run in the Gateway scope.

Syntax

system.alarm.unshelve(path)

Parameters

TypeParameterDescription
List[String]pathA list of possible source paths to search at. If a path ends in "/*", the results will include anything below that path.

Returns

Nothing

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Example #1
# Unshelve an Alarm at a Path

testPath = "prov:TAG_PROVIDER_NAME:/tag:TAG_PATH:/alm:ALARM_NAME"
system.alarm.unshelve(path= [testPath])