.png)
Get-ThrottlingPolicy
Applies to: Exchange Server 2010
Topic Last Modified: 2011-03-19
Use the Get-ThrottlingPolicy cmdlet to view the client throttling settings for one or more throttling policies.
Get-ThrottlingPolicy [-Identity <ThrottlingPolicyIdParameter>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>]
| Parameter | Required | Type | Description |
|---|---|---|---|
|
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. |
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.ThrottlingPolicyIdParameter |
The Identity parameter identifies the name of the throttling policy that you want to return settings for. |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
The Organization parameter is reserved for internal Microsoft use. |
The Get-ThrottlingPolicy cmdlet returns the client throttling settings for one or more throttling policies. If you use the Identity parameter, the cmdlet returns the settings for the identified throttling policy. If you don't use the Identity parameter, the cmdlet returns the settings for all throttling policies.
For more information about client throttling, see Understanding Client Throttling Policies. For more information about managing performance with client throttling policies, see Managing Performance with Client Throttling Policies.
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 "Client throttling settings" entry in the Client Access Permissions topic.
| Error | Description |
|---|---|
|
|
|
This example returns the settings for all throttling policies.
Get-ThrottlingPolicy
This example displays the parameters and values for throttling policy ThrottlingPolicy2.
Get-ThrottlingPolicy -Identity ThrottlingPolicy2
This example returns the default throttling policy. Default throttling policies have the IsDefault parameter set to $true.
Get-ThrottlingPolicy | where-object {$_.IsDefault -eq $true}
This example returns the throttling policies associated with the user with the alias tonysmith.
$policy = $null;
$policyLink = (get-mailbox tonysmith).ThrottlingPolicy;
if ($policyLink -eq $null)
{
$policy = Get-ThrottlingPolicy | where-object {$_.IsDefault -eq $true}
}
else
{
$policy = $policyLink | Get-ThrottlingPolicy;
}
