Export (0) Print
Expand All

Add-SPRoutingRule

SharePoint 2013

Published: July 16, 2012

Applies to:  SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise 

Adds a routing rule.

Add-SPRoutingRule [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind> [-Name] <String> [-AssignmentCollection <SPAssignmentCollection>] [-Criteria <SPRequestManagementRuleCriteriaPipeBind[]>] [-ExecutionGroup <Nullable>] [-Expiration <Nullable>] [-MachinePool <SPRoutingMachinePoolPipeBind>]

Parameters

Parameter Required Type Description

RequestManagementSettings

Required

Microsoft.SharePoint.PowerShell.SPRequestManagementSettingsPipeBind

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

Name

Required

System.String

Specifies the name of the 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.

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 created rule is matched.

Detailed Description

The Add-SPRoutingRule cmdlet adds a routing rule for the farm.

Input Types

Return Types

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

$rm=Get-SPRequestManagementSettings -Identity $web
Get-SPRoutingRule -RequestManagementSettings $rm
$machines=Get-SPRoutingMachineInfo -RequestManagementSettings $rm
Add-SPRoutingMachinePool -RequestManagementSettings $rm -Name <Name of Pool> -MachineTargets $machines

This examples adds a routing rule to the farm by using the $rm and $machines variables.

Change History

Date Description

July 16, 2012

Initial publication

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