---
title: "system.roster.createRoster"
description: "Creates a roster with the given name and description, if it does not already exist."
---

# system.roster.createRoster

> Creates a roster with the given name and description, if it does not already exist.

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

## Description
This function was designed to run in the Gateway and in Perspective sessions. If creating rosters from Vision clients, use [system.alarm.createRoster](../system-alarm/system-alarm-createRoster.md) instead

## Syntax
`system.roster.createRoster(name, description)`

### Parameters
Type | Parameter | Description 
------- | ------- | ------
String| `name` | The name of the roster to create.
String| `description` | The description for the roster. May be None, but the parameter is mandatory.

### Returns
Nothing
### Scope
Gateway, Perspective Session

## Code Examples

```python title="Code Snippet"
# Create an empty roster with a description.
system.roster.createRoster("rosterEast", "East plant user roster")
 
 
# Create an empty roster roster without a description.
system.roster.createRoster("rosterWest", None)
```