list_roles

Use the list_roles command to check Active Directory and return a list of roles defined in the currently selected zone. If executed in a script, this command outputs its list to stdout so that the output appears in the shell where the script is executed. The command does not return a Tcl list back to the executing script. Use get_roles to return a Tcl list.

You can only use list_roles to return role information for classic4 and hierarchical zones.

Zone type

Classic and hierarchical

Syntax

list_roles

Abbreviation

lsr

Options

This command takes no options.

Arguments

This command takes no arguments.

Return value

This command returns a list to stdout of roles defined in the currently selected zone.

Examples

list_roles

This example returns the list of roles for the zone:

Rescue - always permit login
listed
scp
sftp
UNIX Login
Windows Login
winscp

Related commands

Before you use this command, you must have a currently selected zone stored in memory. The following commands enable you to view and select a role:

  • get_roles returns a Tcl list of roles in the current zone.
  • new_role creates a new role and stores it in memory as the currently selected role.
  • select_role retrieves a role from Active Directory and stores it in memory as the selected role.

After you have a role stored in memory, you can use the following commands to work with that role: