Export (0) Print
Expand All

New-ThrottlingPolicy

Applies to: Exchange Server 2010

Topic Last Modified: 2011-03-19

Use the New-ThrottlingPolicy cmdlet to create a non-default throttling policy.


New-ThrottlingPolicy -Name <String> [-Confirm [<SwitchParameter>]] [-CPUStartPercent <Nullable>] [-DomainController <Fqdn>] [-EASMaxConcurrency <Nullable>] [-EASPercentTimeInAD <Nullable>] [-EASPercentTimeInCAS <Nullable>] [-EASPercentTimeInMailboxRPC <Nullable>] [-EWSFastSearchTimeoutInSeconds <Nullable>] [-EWSFindCountLimit <Nullable>] [-EWSMaxConcurrency <Nullable>] [-EWSMaxSubscriptions <Nullable>] [-EWSPercentTimeInAD <Nullable>] [-EWSPercentTimeInCAS <Nullable>] [-EWSPercentTimeInMailboxRPC <Nullable>] [-ExchangeMaxCmdlets <Nullable>] [-ForwardeeLimit <Nullable>] [-IMAPMaxConcurrency <Nullable>] [-IMAPPercentTimeInAD <Nullable>] [-IMAPPercentTimeInCAS <Nullable>] [-IMAPPercentTimeInMailboxRPC <Nullable>] [-MessageRateLimit <Nullable>] [-Organization <OrganizationIdParameter>] [-OWAMaxConcurrency <Nullable>] [-OWAPercentTimeInAD <Nullable>] [-OWAPercentTimeInCAS <Nullable>] [-OWAPercentTimeInMailboxRPC <Nullable>] [-POPMaxConcurrency <Nullable>] [-POPPercentTimeInAD <Nullable>] [-POPPercentTimeInCAS <Nullable>] [-POPPercentTimeInMailboxRPC <Nullable>] [-PowerShellMaxCmdletQueueDepth <Nullable>] [-PowerShellMaxCmdlets <Nullable>] [-PowerShellMaxCmdletsTimePeriod <Nullable>] [-PowerShellMaxConcurrency <Nullable>] [-RCAMaxConcurrency <Nullable>] [-RCAPercentTimeInAD <Nullable>] [-RCAPercentTimeInCAS <Nullable>] [-RCAPercentTimeInMailboxRPC <Nullable>] [-RecipientRateLimit <Nullable>] [-WhatIf [<SwitchParameter>]]

Parameter Required Type Description

Name

Required

System.String

The Name parameter specifies the name of the object in Active Directory. The default policy is named DefaultThrottlingPolicy<GUID>.

Confirm

Optional

System.Management.Automation.SwitchParameter

The Confirm switch causes the command to pause processing and requires you to acknowledge what the command will do before processing continues. You don't have to specify a value with the Confirm switch.

CPUStartPercent

Optional

System.Nullable

The CPUStartPercent parameter specifies the per-process CPU percentage at which users governed by this policy begin to be backed off. Valid values are from 0 through 100. Use $null to turn off CPU percentage-based throttling for this policy.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

The DomainController parameter specifies the fully qualified domain name (FQDN) of the domain controller that writes this configuration change to Active Directory.

EASMaxConcurrency

Optional

System.Nullable

The EASMaxConcurrency parameter specifies how many concurrent connections a Microsoft Exchange ActiveSync user can have against a server running Exchange 2010 at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The EASMaxConcurrency parameter has a valid range from 0 through 100 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null.

EASPercentTimeInAD

Optional

System.Nullable

The EASPercentTimeInAD parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

EASPercentTimeInCAS

Optional

System.Nullable

The EASPercentTimeInCAS parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

EASPercentTimeInMailboxRPC

Optional

System.Nullable

The EASPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Exchange ActiveSync user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

EWSFastSearchTimeoutInSeconds

Optional

System.Nullable

The EWSFastSearchTimeoutInSeconds parameter specifies the amount of time that searches made using Exchange Web Services continue before they time out. If the search takes more than the time indicated by the policy value, the search stops and an error is returned. The default value of this setting is 60 seconds.

EWSFindCountLimit

Optional

System.Nullable

The EWSFindCountLimit parameter specifies the maximum result size of FindItem or FindFolder calls that can exist in memory on the Client Access server at the same time for this user in this current process. If an attempt is made to find more items or folders than your policy limit allows, an error is returned. However, the limit isn't strictly enforced if the call is made within the context of an indexed page view. Specifically, in this scenario, the search results are truncated to include the number of items and folders that fit within the policy limit. You can then continue paging into your results set via further FindItem or FindFolder calls.

EWSMaxConcurrency

Optional

System.Nullable

The EWSMaxConcurrency parameter specifies how many concurrent connections an Exchange Web Services user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The EWSMaxConcurrency parameter has a valid range from 0 through 100 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null.

EWSMaxSubscriptions

Optional

System.Nullable

The EWSMaxSubscriptions parameter specifies the maximum number of active push and pull subscriptions that a user can have on a specified Client Access server at the same time. If a user tries to create more subscriptions than the configured maximum, the subscription fails, and an event is logged in Event Viewer.

EWSPercentTimeInAD

Optional

System.Nullable

The EWSPercentTimeInAD parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

EWSPercentTimeInCAS

Optional

System.Nullable

The EWSPercentTimeInCAS parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

EWSPercentTimeInMailboxRPC

Optional

System.Nullable

The EWSPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Exchange Web Services user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

ExchangeMaxCmdlets

Optional

System.Nullable

The ExchangeMaxCmdlets parameter specifies the number of cmdlets that can be executed within a specific time period before their execution is slowed down. The value specified by this parameter should be less than the value specified by the PowerShellMaxCmdlets parameter.

The time period used for this limit is specified by the PowerShellMaxCmdletsTimePeriod parameter. We recommend that you set values for both parameters at the same time.

ForwardeeLimit

Optional

System.Nullable

The ForwardeeLimit parameter specifies the limits for the number of recipients that can be configured in Inbox Rules when using the forward or redirect action. This parameter doesn't limit the number of messages that can be forwarded or redirected to the recipients that are configured.

IMAPMaxConcurrency

Optional

System.Nullable

The IMAPMaxConcurrency parameter specifies how many concurrent connections an IMAP user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The IMAPMaxConcurrency parameter has a valid range from 0 through 100 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null.

IMAPPercentTimeInAD

Optional

System.Nullable

The IMAPPercentTimeInAD parameter specifies the percentage of a minute that an IMAP user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

IMAPPercentTimeInCAS

Optional

System.Nullable

The IMAPPercentTimeInCAS parameter specifies the percentage of a minute that an IMAP user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

IMAPPercentTimeInMailboxRPC

Optional

System.Nullable

The IMAPPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an IMAP user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

MessageRateLimit

Optional

System.Nullable

The MessageRateLimit parameter specifies the number of messages per minute that can be submitted to transport. For messages submitted through the Mailbox server role (using Microsoft Outlook, Microsoft Office Outlook Web App, Exchange ActiveSync, or Exchange Web Services), this results in the deferral of messages until the quota for the user is available. Specifically, messages appear in the Outbox or Drafts folder for longer periods of time when users submit messages at a rate greater than the MessageRateLimit parameter.

For POP or IMAP clients submitting messages directly to transport using SMTP, clients receive a transient error if they submit at a rate that exceeds the MessageRateLimit parameter. Exchange attempts to connect and send the messages at a later time.

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

The Organization parameter is reserved for internal Microsoft use.

OWAMaxConcurrency

Optional

System.Nullable

The OWAMaxConcurrency parameter specifies how many concurrent connections an Outlook Web App user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The OWAMaxConcurrency parameter has a valid range from 0 through 100 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null.

OWAPercentTimeInAD

Optional

System.Nullable

The OWAPercentTimeInAD parameter specifies the percentage of a minute that an Outlook Web App user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

OWAPercentTimeInCAS

Optional

System.Nullable

The OWAPercentTimeInCAS parameter specifies the percentage of a minute that an Outlook Web App user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

OWAPercentTimeInMailboxRPC

Optional

System.Nullable

The OWAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an Outlook Web App user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

POPMaxConcurrency

Optional

System.Nullable

The POPMaxConcurrency parameter specifies how many concurrent connections a POP user can have against an Exchange server at one time. A connection is held from the moment a request is received until a response is sent in its entirety to the requestor. If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The POPMaxConcurrency parameter has a valid range from 0 through 100 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null.

POPPercentTimeInAD

Optional

System.Nullable

The POPPercentTimeInAD parameter specifies the percentage of a minute a POP user can spend executing LDAP requests (PercentTimeInAD). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

POPPercentTimeInCAS

Optional

System.Nullable

The POPPercentTimeInCAS parameter specifies the percentage of a minute a POP user can spend executing CAS code (PercentTimeInCAS). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

POPPercentTimeInMailboxRPC

Optional

System.Nullable

The POPPercentTimeInMailboxRPC parameter specifies the percentage of a minute a POP user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

PowerShellMaxCmdletQueueDepth

Optional

System.Nullable

The PowerShellMaxCmdletQueueDepth parameter specifies the number of operations allowed to be executed by the user. This value directly affects the behavior of the PowerShellMaxCmdlets and PowerShellMaxConcurrency parameters. For example, the PowerShellMaxConcurrency parameter consumes at least two operations defined by the PowerShellMaxCmdletQueueDepth parameter but additional operations are also consumed by per cmdlet execution. The number of operations depends on the cmdlets executed. We recommend that the value for the PowerShellMaxCmdletQueueDepth parameter be at least three times larger than the value of the PowerShellMaxConcurrency parameter. This parameter won't affect Exchange Control Panel operations or Exchange Web Services operations.

PowerShellMaxCmdlets

Optional

System.Nullable

The PowerShellMaxCmdlets parameter specifies the number of cmdlets that can be executed within a specific time period before their execution is stopped. The value specified by this parameter should be more than the value specified by the ExchangeMaxCmdlets parameter. The time period used for this limit is specified by the PowerShellMaxCmdletsTimePeriod parameter. Both values should be set at the same time.

PowerShellMaxCmdletsTimePeriod

Optional

System.Nullable

The PowerShellMaxCmdletsTimePeriod parameter specifies the time period, in seconds, that the throttling policy uses to determine whether the number of cmdlets being executed exceeds the limits specified by the PowerShellMaxCmdlets and ExchangeMaxCmdlets parameters.

PowerShellMaxConcurrency

Optional

System.Nullable

The PowerShellMaxConcurrency parameter specifies different information depending on context:

  • In the context of Remote PowerShell, the PowerShellMaxConcurrency parameter specifies the maximum number of Remote PowerShell sessions that a Remote PowerShell user can have open at the same time.
  • In the context of Exchange Web Services, the PowerShellMaxConcurrency parameter specifies the number of concurrent cmdlet executions that a user can have at the same time.

This parameter value doesn't necessarily correlate to the number of browsers opened by the user.

RCAMaxConcurrency

Optional

System.Nullable

The RCAMaxConcurrency parameter specifies how many concurrent connections an RPC Client Access user can have against a server running Exchange 2010 at one time. A connection is held from the moment a request is received until the connection is closed or the connection is otherwise disconnected (for example, if the user goes offline). If users attempt to make more concurrent requests than their policy allows, the new connection attempt fails. However, the existing connections remain valid. The RCAMaxConcurrency parameter has a valid range from 0 through 100 inclusive. To indicate that the number of concurrent connections should be unthrottled (no limit), this value should be set to $null.

RCAPercentTimeInAD

Optional

System.Nullable

The RCAPercentTimeInAD parameter specifies the percentage of a minute that an Outlook user can spend executing directory requests. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

RCAPercentTimeInCAS

Optional

System.Nullable

The RCAPercentTimeInCAS parameter specifies the percentage of a minute that an Outlook user can spend executing CAS mailbox requests. A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

RCAPercentTimeInMailboxRPC

Optional

System.Nullable

The RCAPercentTimeInMailboxRPC parameter specifies the percentage of a minute that an RPC Client Access user can spend executing mailbox RPC requests (PercentTimeInMailboxRPC). A value of 100 indicates that for every one-minute window, the user can spend 60 seconds of that time consuming the resource in question.

RecipientRateLimit

Optional

System.Nullable

The RecipientRateLimit parameter specifies the limits on the number of recipients that a user can address in a 24-hour period.

WhatIf

Optional

System.Management.Automation.SwitchParameter

The WhatIf switch instructs the command to simulate the actions that it would take on the object. By using the WhatIf switch, you can view what changes would occur without having to apply any of those changes. You don't have to specify a value with the WhatIf switch.

By default, there is one default throttling policy. Microsoft Exchange Server 2010 Setup creates a default client throttling policy when you install the Exchange 2010 Client Access server role. There is no way to replace, re-create, or remove the existing default throttling policy. However, you can modify the default policy using the Set-ThrottlingPolicy cmdlet.

Dd351045.note(en-us,EXCHG.140).gifNote:
Unified Messaging users are considered Exchange Web Services users and are therefore throttled by Exchange Web Services parameters such as EWSMaxConcurrency, EWSPercentTimeInAD, EWSPercentTimeInCAS, and EWSPercentTimeInMailboxRPC.

For more information, see Understanding Client Throttling Policies and 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 creates a non-default throttling policy. Any parameters that you omit inherit the values from the default throttling policy.

New-ThrottlingPolicy -Name <NewPolicyName> -EWSPercentTimeInCAS 80 -EWSPercentTimeInAD $null

This example creates a policy for a tenant that sets the EWSPercentTimeInCAS parameter value to 80.

New-ThrottlingPolicy -Name <NewPolicyName > EWSPercentTimeInCAS 80

This example creates a throttling policy that restricts the number of connections for a user to three. The users associated with this policy are only able to create three remote Exchange Management Shell sessions. This policy also restricts to three the number of Exchange Control Panel operations or Exchange Web Services operations that can be executed at the same time.

New-ThrottlingPolicy <NewPolicyName> -PowerShellMaxConcurrency 3 -PowerShellMaxCmdletQueueDepth 12

This example creates a throttling policy that restricts a user to be able to only execute 10 cmdlets in a period of five seconds. If the users associated with this policy exceed this number, the cmdlet pipeline execution is stopped with a throttling error message. The user needs to wait for and then resubmit the execution of cmdlets on the open connection.

New-ThrottlingPolicy <NewPolicyName> -PowerShellMaxCmdlets 10 -PowerShellMaxCmdletsTimePeriod 5
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft