Skip to content

Latest commit

 

History

History
201 lines (142 loc) · 4.88 KB

File metadata and controls

201 lines (142 loc) · 4.88 KB
external help file Microsoft.SharePoint.PowerShell.dll-help.xml
Module Name SharePointServer
online version https://learn.microsoft.com/powershell/module/sharepoint-server/add-sproutingmachineinfo
applicable SharePoint Server Subscription Edition
title Add-SPRoutingMachineInfo
schema 2.0.0

Add-SPRoutingMachineInfo

SYNOPSIS

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

$web=Get-SPWebApplication -Identity <URL of web application>
$rm=Get-SPRequestManagementSettings -Identity $web
Add-SPRoutingMachineInfo -RequestManagementSettings $rm -Name <MachineName> -Availability Available

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

PARAMETERS

-RequestManagementSettings

Applicable: SharePoint Server Subscription Edition

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

Type: SPRequestManagementSettingsPipeBind
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Name

Applicable: SharePoint Server Subscription Edition

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

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-AssignmentCollection

Applicable: SharePoint Server Subscription Edition

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
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Availability

Applicable: SharePoint Server Subscription Edition

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

The valid values are:

--Available --Unavailable

Type: SPRoutingMachineAvailability
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OutgoingPort

Applicable: SharePoint Server Subscription Edition

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

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-OutgoingScheme

Applicable: SharePoint Server Subscription Edition

Determines the Http scheme of outgoing connections.

The valid values are:

--SameAsIncoming --Http --Https

Type: SPRoutingOutgoingScheme
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-StaticWeight

Applicable: SharePoint Server Subscription Edition

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
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

NOTES

RELATED LINKS

Get-SPRoutingMachineInfo

Remove-SPRoutingMachineInfo

Set-SPRoutingMachineInfo