system.alarm.getRosters

Description

This function returns a mapping of roster names to a list of usernames contained in the roster.

Syntax

system.alarm.getRosters()

Parameters

None

Returns

PyDict - A dictionary that maps roster names to a List of usernames in the roster. The List of usernames may be empty if no users have been added to the roster.

Scope

All

Code Examples

Code In Action

# this script will get all the rosters and list the users in them
rosters = system.alarm.getRosters()
for key, values in rosters.iteritems():
	# key is the roster name, values is a dict of usernames
	print 'Roster', key, 'contains these users:'
	for value in values:
		print '  ', value

Output

Roster Admins contains these users:
   admin
Roster Supervisors contains these users:
   asmith
   jdoe