This function is used in Python Scripting.
The following feature is new in Ignition version 8.1.21
Click here to check out the other new features


Returns the roster corresponding to the given name.



  • Parameters

String name - The name of the roster to get the RosterModel object from.

  • Returns

RosterModel - The RosterModel object of the given roster name.

  • Scope

Gateway, Perspective Session

Code Examples
Code Snippet
# This example gets the RosterModel object from a roster called "some roster" when a Button is pressed and prints the object to the browser console.

roster = system.roster.getRoster("some roster")


system roster getRoster, roster.getRoster