View role entries
Applies to: Exchange Server 2013
Each management role entry represents a single cmdlet or script. The parameters included on a role entry determine what parameters on the cmdlet or script a user can access.
The identity of role entries consists of the management role name that the role entry is associated with, and the cmdlet or script that the role entry refers to. For more information about role entries in Microsoft Exchange Server 2013, see Understanding management roles.
Looking for other management tasks related to role entries? Check out Advanced permissions.
What do you need to know before you begin?
Estimated time to complete each procedure: 5 minutes
You need to be assigned permissions before you can perform this procedure or procedures. To see what permissions you need, see the "Management roles" entry in the Role management permissions topic.
You must use the Shell to perform these procedures.
This topic makes use of pipelining, the Format-List cmdlet, objects, and properties. For more information about these concepts, see the following topics:
For information about keyboard shortcuts that may apply to the procedures in this topic, see Keyboard shortcuts in the Exchange admin center.
Tip
Having problems? Ask for help in the Exchange forums. Visit the forums at Exchange Server.
View a list of role entries
You can use the Get-ManagementRoleEntry cmdlet to retrieve a list of role entries. When you use the Get-ManagementRoleEntry cmdlet, you must specify a value that contains both the role name that contains the role entries you want to list and also the cmdlet name of the role entry you want to list. By combining the role name and cmdlet name with the wildcard character (*), you can return specific or broad lists of role entries.
For detailed syntax and parameter information, see Get-ManagementRoleEntry.
View a list of all role entries on a role
To view a list of role entries on a specific role, use the following syntax.
Get-ManagementRoleEntry <role name>\*
This examples retrieves all the role entries on the Recipient Administrators role.
Get-ManagementRole "Recipient Administrators\*"
For detailed syntax and parameter information, see Get-ManagementRoleEntry.
View a list of roles that contain a specific role entry
To view a list of all the roles that contain a specific role entry, use the following syntax.
Get-ManagementRoleEntry *\<cmdlet name>
This example retrieves all the roles that contain the Set-Mailbox role entry.
Get-ManagementRoleEntry *\Set-Mailbox
For detailed syntax and parameter information, see Get-ManagementRoleEntry.
View a targeted list of roles that contain similar role entries
To view a list of targeted roles that contain cmdlets with similar names, use the following syntax.
Get-ManagementRoleEntry *<partial role name>*\*<partial cmdlet name>*
This example returns a list of role entries that contain the string Mailbox that are on roles that contain the string Tier 1 in their names.
Get-ManagementRoleEntry "*Tier 1*\*Mailbox*"
For detailed syntax and parameter information, see Get-ManagementRoleEntry.
View a single role entry
To view the details of a single role entry, use the following syntax.
Get-ManagementRoleEntry <role name>\<cmdlet name> | Format-List
This example retrieves the details of the Set-Mailbox role entry on the Recipient Administrators role.
Get-ManagementRoleEntry "Recipient Administrators\Set-Mailbox" | Format-List
If the role entry you view has too many parameters to list using the Format-List cmdlet, see "View the parameters on a single role entry" later in this topic.
For detailed syntax and parameter information, see Get-ManagementRoleEntry.
View the parameters on a single role entry
Some role entries have more parameters than can be viewed by piping the results of the Get-ManagementRoleEntry cmdlet to the Format-List cmdlet. If you need to view all the parameters on a role entry, you need to directly access the Parameters property of the role entry object.
To view parameters stored in the Parameters property of a role entry object, use the following syntax.
(Get-ManagementRoleEntry <role name>\<cmdlet name>).Parameters
This example retrieves the parameters on the Set-Mailbox role entry on the Mail Recipients role.
(Get-ManagementRoleEntry "Mail Recipients\Set-Mailbox").Parameters
For detailed syntax and parameter information, see Get-ManagementRoleEntry.