Export (0) Print
Expand All

Get-ThrottlingPolicy

 

Applies to: Exchange Server 2013

Topic Last Modified: 2014-04-11

This cmdlet is available only in on-premises Exchange Server 2013.

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

For information about the parameter sets in the Syntax section below, see Syntax.

Get-ThrottlingPolicy [-Identity <ThrottlingPolicyIdParameter>] [-Diagnostics <SwitchParameter>] [-DomainController <Fqdn>] [-Explicit <SwitchParameter>] [-IgnoreDehydratedFlag <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-ThrottlingPolicyScope <Regular | Organization | Global>]

This example returns the settings for all throttling policies.

Get-ThrottlingPolicy | Format-List

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

Get-ThrottlingPolicy -Identity ThrottlingPolicy2 | Format-List

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 how to control the resources consumed by individual users, see Exchange workload management.

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 "User throttling" entry in the Server health and performance permissions topic.

 

Parameter Required Type Description

Diagnostics

Optional

System.Management.Automation.SwitchParameter

The Diagnostics switch specifies whether you want the output to include the diagnostics string. To return diagnostics information, use the syntax Get-ThrottlingPolicy -Diagnostics. You don't specify a value for this switch.

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.

The DomainController parameter isn't supported on Edge Transport servers. An Edge Transport server uses the local instance of Active Directory Lightweight Directory Services (AD LDS) to read and write data.

Explicit

Optional

System.Management.Automation.SwitchParameter

The Explicit switch specifies whether you only want to return the policy settings that have been directly assigned using this policy. By default, this parameter is set to $false.

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.ThrottlingPolicyIdParameter

The Identity parameter identifies the name of the throttling policy that you want to return settings for.

IgnoreDehydratedFlag

Optional

System.Management.Automation.SwitchParameter

This parameter is reserved for internal Microsoft use.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is reserved for internal Microsoft use.

ThrottlingPolicyScope

Optional

Microsoft.Exchange.Data.Directory.SystemConfiguration.ThrottlingPolicyScopeType

The ThrottlingPolicyScope parameter specifies the scope of the throttling policy. You can use the following values:

  • Global

  • Organization

  • Regular

For information about each of these policy scopes, see Exchange workload management.

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.

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.

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft