Skip to content

Latest commit

 

History

History
202 lines (144 loc) · 5.08 KB

File metadata and controls

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

Set-SPRoutingMachineInfo

SYNOPSIS

Sets routing target properties.

SYNTAX

Set-SPRoutingMachineInfo [-Identity] <SPRoutingMachineInfoPipeBind>
 [-AssignmentCollection <SPAssignmentCollection>] [-Availability <SPRoutingMachineAvailability>]
 [-ClearOutgoingPort] [-OutgoingPort <Int32>] [-OutgoingScheme <SPRoutingOutgoingScheme>]
 [-StaticWeight <Double>] [<CommonParameters>]

DESCRIPTION

Use the Set-SPRoutingMachineInfo cmdlet to set routing target properties by using the Identity parameter.

For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.

EXAMPLES

EXAMPLE

$wa = Get-SPWebApplication -Identity https://webAppUrl
$rm = Get-SPRequestManagementSettings -Identity $wa
$m = Get-SPRoutingMachineInfo -RequestManagementSettings $rm -Name SP01
Set-SPRoutingMachineInfo -Identity $m -Availability Unavailable

This example sets the "Availability" routing target property to Unavailable for a specified identity.

PARAMETERS

-Identity

Applicable: SharePoint Server Subscription Edition

Specifies the name of the request management settings object to set.

Type: SPRoutingMachineInfoPipeBind
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
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 specified 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

-ClearOutgoingPort

Applicable: SharePoint Server Subscription Edition

Clears the outgoing port if it is set.

Type: SwitchParameter
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 schema 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 whether the static weight of a computer routing 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

Add-SPRoutingMachineInfo

Get-SPRoutingMachineInfo

Remove-SPRoutingMachineInfo