Add-SPRoutingMachineInfo

Adds a new routing target to the farm.

Syntax

Add-SPRoutingMachineInfo
   [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind>
   [-Name] <String>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-Availability <SPRoutingMachineAvailability>]
   [-OutgoingPort <Int32>]
   [-OutgoingScheme <SPRoutingOutgoingScheme>]
   [-StaticWeight <Double>]
   [<CommonParameters>]

Description

Use the Add-SPRoutingMachineInfo cmdlet to add a new routing target to the farm by using the RequestManagementSettings and Name parameters.

Examples

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

C:\PS>$web=Get-SPWebApplication -Identity <URL of web application>

C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web

C:\PS>Add-SPRoutingMachineInfo -RequestManagementSettings $rm -Name <MachineName> -Availability Available

C:\PS>

This example adds a routing target for a specified identity to the farm.

Required Parameters

-Name

Specifies the name of the computer to add to the route.

Type:String
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName)
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 target.

Type:SPRequestManagementSettingsPipeBind
Position:1
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Optional 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
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-Availability

Specifies whether or not the added computer will be available for routing.

The valid values are:

--Available --Unavailable

Type:SPRoutingMachineAvailability
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-OutgoingPort

Specifies the port used by Request Manager to make an outgoing connection.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-OutgoingScheme

Determines the Http scheme of outgoing connections.

The valid values are:

--SameAsIncoming --Http --Https

Type:SPRoutingOutgoingScheme
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
-StaticWeight

Specifies the static weight of a computer routing that is used by Request Manager. If the static weight is higher, more requests will be routed to the computer.

Type:Double
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019