Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2
Topic Last Modified: 2012-11-19
Use the Get-ManagementRoleEntry cmdlet to retrieve management role entries that have been configured on management roles.
Syntax
Get-ManagementRoleEntry -Identity
<RoleEntryIdParameter> [-DomainController <Fqdn>]
[-Parameters <String[]>] [-PSSnapinName <String>]
[-Type <ManagementRoleEntryType[]>]
|
Detailed Description
The Get-ManagementRoleEntry cmdlet retrieves role entries that have been configured on roles. You can retrieve specific role entries that match specific criteria such as role name, cmdlet name, parameter name, or a combination of each, or role entry type or the associated Windows PowerShell snap-in.
For more information about management role entries, see Understanding Management Roles.
You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Management role entries" entry in the Role Management Permissions topic.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Required |
Microsoft.Exchange.Configuration.Tasks.RoleEntryIdParameter |
The Identity parameter specifies the role entry to retrieve. You must specify the value of the Identity parameter in the format, <management role>\<role entry name>, for example, ExampleRole\Set-Mailbox. For more information about how management role entries work, see Understanding Management Roles. You can use the wildcard character (*) instead of the role, cmdlet name, or both. If the role entry name contains spaces, enclose the name in quotation marks ("). |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory. |
|
Parameters |
Optional |
System.String[] |
The Parameters parameter includes only the role entries that contain the parameters specified. You can specify multiple parameters, separated by commas. You can use the wildcard character (*) with partial parameter names to retrieve all parameters that match the value you specify. This parameter is useful when you use the wildcard character (*) with the value you specify in the Identity parameter. |
|
PSSnapinName |
Optional |
System.String |
The PSSnapinName parameter specifies the Windows PowerShell snap-in that contains the role entry to return. Use the Get-PSSnapin cmdlet to retrieve a list of available Windows PowerShell snap-ins. |
|
Type |
Optional |
Microsoft.Exchange.Data.Directory.Management.ManagementRoleEntryType[] |
The Type parameter specifies the type of role entry to
return. The valid values for the Type parameter are any
combination of the following parameters, separated by commas:
|
Input Types
To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.
Return Types
To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.
Examples
EXAMPLE 1
This example retrieves a list of all the role entries that exist on the Transport Rules management role.
 Copy Code |
|
|---|---|
Get-ManagementRoleEntry "Transport Rules\*" |
|
EXAMPLE 2
This example retrieves a list of all the role entries that contain the Get-Recipient cmdlet.
| Copy Code |
|
|---|---|
Get-ManagementRoleEntry *\Get-Recipient |
|
EXAMPLE 3
This example retrieves the Tier 2 Help Desk\Set-Mailbox role entry and pipes the output of the Get-ManagementRoleEntry cmdlet to the Format-List cmdlet. The Format-List cmdlet then outputs only the Name, Parameters, Role, and Type properties from the role entry.
| Copy Code |
|
|---|---|
Get-ManagementRoleEntry "Tier 2 Help Desk\Set-Mailbox" | Format-List Name, Parameters, Role, Type |
|