Add-SPRoutingMachineInfo
Adds a new routing target to the farm.
Syntax
Default (Default)
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.
Parameters
-AssignmentCollection
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Availability
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies whether or not the added computer will be available for routing.
The valid values are:
--Available --Unavailable
Parameter properties
| Type: | SPRoutingMachineAvailability |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the name of the computer to add to the route.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-OutgoingPort
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the port used by Request Manager to make an outgoing connection.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-OutgoingScheme
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Determines the Http scheme of outgoing connections.
The valid values are:
--SameAsIncoming --Http --Https
Parameter properties
| Type: | SPRoutingOutgoingScheme |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-RequestManagementSettings
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the name of the request management settings object to add to the routing target.
Parameter properties
| Type: | SPRequestManagementSettingsPipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-StaticWeight
Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
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.
Parameter properties
| Type: | Double |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.