Skip to end of metadata
Go to start of metadata

This function is used in Python Scripting.

Description

Will return a list of the available Alarm Notification Pipelines in a project.

The legacy behavior of this function (7.9 and prior) did not have any parameters, and it would always check all projects for pipelines. See the Upgrade Guide for more details.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.alarm.listPipelines([projectName])

  • Parameters

String projectName - The project to check alarm pipelines for. If omitted, will look for a project named "alarm-pipelines". [optional]

  • Returns

List[String] - A list of pipeline names. The list will be empty if no pipelines exist. Unsaved name changes will not be reflected in the list.

  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code In Action - Listing the Alarm Pipelines in a Project
# This script will print a list of all alarm pipeline names in the “alarm-pipelines” project.
pipelines = system.alarm.listPipelines()
for pipeline in pipelines:
	print pipeline

Output
Emergency_Pipeline
Test
SMS_Pipeline


Keywords

system alarm listPipelines, alarm.listPipelines