Add-SPRoutingRule
Adds a routing rule.
Syntax
Add-SPRoutingRule
[-RequestManagementSettings] <SPRequestManagementSettingsPipeBind>
[-Name] <String>
[-AssignmentCollection <SPAssignmentCollection>]
[-Criteria <SPRequestManagementRuleCriteriaPipeBind[]>]
[-ExecutionGroup <Int32>]
[-Expiration <DateTime>]
[-MachinePool <SPRoutingMachinePoolPipeBind>]
[<CommonParameters>] Description
The Add-SPRoutingRule cmdlet adds a routing rule for the farm.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
--------------EXAMPLE--------
C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web
C:\PS>Get-SPRoutingRule -RequestManagementSettings $rm
C:\PS>$machines=Get-SPRoutingMachineInfo -RequestManagementSettings $rm
C:\PS>Add-SPRoutingMachinePool -RequestManagementSettings $rm -Name <Name of Pool> -MachineTargets $machinesThis examples adds a routing rule to the farm by using the $rm and $machines variables.
Parameters
-AssignmentCollection
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.
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.
| Type: | SPAssignmentCollection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Criteria
Specifies the criteria for the rule to match.
| Type: | SPRequestManagementRuleCriteriaPipeBind[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-ExecutionGroup
Specifies the group in which the rule will be placed.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Expiration
Specifies the expiration date and time of the rule.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-MachinePool
Specifies the pool of machines to which a request will be routed if the created rule is matched.
| Type: | SPRoutingMachinePoolPipeBind |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-Name
Specifies the name of the rule.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |
-RequestManagementSettings
Specifies the name of the request management settings object to add to the routing rule.
| Type: | SPRequestManagementSettingsPipeBind |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019 |