Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Set-SPRoutingRule

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise 

Changes properties of an existing routing rule.

Set-SPRoutingRule [-Identity] <SPRoutingRulePipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Criteria <SPRequestManagementRuleCriteriaPipeBind[]>] [-ExecutionGroup <Nullable>] [-Expiration <Nullable>] [-MachinePool <SPRoutingMachinePoolPipeBind>]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPRoutingRulePipeBind

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

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.

ExecutionGroup

Optional

System.Nullable

Specifies the group in which the rule will be placed.

Expiration

Optional

System.Nullable

Specifies the expiration date and time of the rule.

MachinePool

Optional

Microsoft.SharePoint.PowerShell.SPRoutingMachinePoolPipeBind

Specifies the pool of machines to which a request will be routed if the changed rule is matched.

Detailed Description

Use the Set-SPRoutingRule cmdlet to change properties of an existing routing rule.

Input Types

Return Types

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

$rm=Get-SPRequestManagementSettings -Identity $web
Get-SPRoutingRule -RequestManagementSettings $rm
$machines=Get-SPRoutingMachineInfo -RequestManagementSettings $rm
$pool=Add-SPRoutingMachinePool -RequestManagementSettings $rm -Name <Name of Pool> -MachineTargets $machines
$criteria=New-SPRequestManagementRuleCriteria -Value http -Property url -MatchType startswith -CaseSensitive $false
$rule=Add-SPRoutingRule -RequestManagementSettings $rm -Name <Rule Name> -Criteria $c -MachinePool $pool
$criteriaNew = New-SPRequestManagementRuleCriteria -Property UserAgent -MatchType Equals -Value "Mozilla/4.0 (compatible; MSIE 4.01; Windows NT; MS Search 6.0 Robot)"
Set-SPRoutingRule -Identity $rule -Criteria $criteriaNew

This example sets a routing rule for the specified identity by using the $rule variable.

Change History

Date Description

July 16, 2012

Initial publication

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.