You're currently browsing the Ignition 8.0 docs. Click here to view the latest docs.

This function is used in Python Scripting.


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.


system.alarm.createRoster(name, description)

  • Parameters

String name - The name for the new roster

String description - A description for the new roster. Required, but can be blank.

  • Returns


  • Scope

Gateway, Vision Client, Perspective Session

Code Examples
Code In Action - Creating a New Roster
# This example creates a new roster
name = 'MyRoster'
description = 'A roster created by scripting'
system.alarm.createRoster(name, description) 

system alarm createRoster, alarm.createRoster

  • No labels