---
title: "system.alarm.createRoster"
description: "This function creates a new roster. Users may be added to the roster through the Gateway or the Roster Management component"
---

# system.alarm.createRoster

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

This function is used in **Python Scripting**.

## Description
## Client Permission Restrictions
[Permission Type](ignition-modules\vision\vision-project-properties\vision-project-properties.md#vision-permissions-properties): 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
Type | Parameter | Description 
------- | ------- | ------- 
String | `name` | The name for the new roster
String | `description` | A description for the new roster. Required, but can be blank.

### Returns
Nothing

### Scope
Gateway, Vision Client, Perspective Session

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