Skip to main content
Version: 8.1

system.alarm.createRoster

This function is used in Python Scripting.

Description

This function creates a new roster. Users may be added to the roster through the Gateway or the Roster Management component

Client Permission Restrictions

Permission Type: 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.createRoster(name, description)

Parameters

TypeParameterDescription
StringnameThe name for the new roster
StringdescriptionA description for the new roster. Required, but can be blank.

Returns

Nothing

Scope

Gateway, Vision Client, Perspective Session

Code Examples

Example #1
# This example creates a new roster
name = 'MyRoster'
description = 'A roster created by scripting'
system.alarm.createRoster(name, description)