Skip to main content
Version: 7.9

system.alarm.getShelvedPaths

This function is used in Python Scripting.

Description​

Returns a list of ShelvedPath objects, which each represent a shelved alarm.

Client Permission Restrictions​

This scripting function has no Client Permission restrictions.

Syntax​

system.alarm.getShelvedPaths()

Parameters​

Nothing

Returns​

List - A list of ShelvedPath objects. ShelvedPath objects can be examined with getExpiration, getHitCount, getPath, getShelveTime, getUser, and isExpired.

Scope​

All, Client, or Gateway

Code Examples​

Example #1
# The following code prints a list of the shelved alarms paths and prints them to the console.
paths = system.alarm.getShelvedPaths()
for p in paths:
   print "Path: %s, Shelved by: %s, expires: %s, is expired? %s" % (p.getPath(), p.getUser(), p.getExpiration(), p.isExpired())