Applies to: Exchange Server 2010 SP3, Exchange Server 2010 SP2

Topic Last Modified: 2012-11-19

Use the Get-ThrottlingPolicy cmdlet to view the client throttling settings for one or more throttling policies.

Syntax

Get-ThrottlingPolicy [-Identity <ThrottlingPolicyIdParameter>] [-DomainController <Fqdn>] [-Organization <OrganizationIdParameter>]

Detailed Description

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.

Parameters

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

This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support.

The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization.

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 returns the settings for all throttling policies.

Copy Code 
Get-ThrottlingPolicy

EXAMPLE 2

This example displays the parameters and values for throttling policy ThrottlingPolicy2.

Copy Code 
Get-ThrottlingPolicy -Identity ThrottlingPolicy2

EXAMPLE 3

This example returns the default throttling policy. Default throttling policies have the IsDefault parameter set to $true.

Copy Code 
Get-ThrottlingPolicy | where-object {$_.IsDefault -eq $true}

EXAMPLE 4

This example returns the throttling policies associated with the user with the alias tonysmith.

Copy Code 
$policy = $null;
$policyLink = (get-mailbox tonysmith).ThrottlingPolicy;
if ($policyLink -eq $null)
{ 
	$policy = Get-ThrottlingPolicy | where-object {$_.IsDefault -eq $true}
}
else
{
	$policy = $policyLink | Get-ThrottlingPolicy;
}