This topic has not yet been rated - Rate this topic

Add-SPThrottlingRule

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise 

Adds a new throttling rule.

Add-SPThrottlingRule [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind> [-Name] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Criteria <SPRequestManagementRuleCriteriaPipeBind[]>] [-Expiration <Nullable>] [-Threshold <Nullable>]

Parameters

Parameter Required Type Description

RequestManagementSettings

Required

Microsoft.SharePoint.PowerShell.SPRequestManagementSettingsPipeBind

Specifies the name of the request management settings object to add.

Name

Required

System.String

Specifies the name of the throttling rule.

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.

noteNote:

When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Criteria

Optional

Microsoft.SharePoint.PowerShell.SPRequestManagementRuleCriteriaPipeBind[]

Specifies the criteria for the rule to match.

Expiration

Optional

System.Nullable

Specifies the expiration date and time of the rule.

Threshold

Optional

System.Nullable

Specifies a value between 0 and 10 which defines the maximum threshold for throttling. The Request Manager will remove routing targets if their Health-Score becomes greater than this value.

Detailed Description

The Add-SPThrottlingRule cmdlet adds a new throttling rule for the farm by using the Name and RequestManagementSettings parameters.

Input Types

Return Types

-----------EXAMPLE---------

$web=Get-SPWebApplication -Identity <URL of web application>
$rm=Get-SPRequestManagementSettings -Identity $web
$c=New-SPRequestManagementRuleCriteria -Value http -Property url -MatchType startswith -CaseSensitive $false
Add-SPThrottlingRule -RequestManagementSettings $rm -Name <Rule Name> -Criteria $c -Threshold 4

This example adds a throttling rule for a specified identity by using the $rm and $c variables.

Change History

Date Description

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
© 2013 Microsoft. All rights reserved.