Edit

Set-SPRoutingMachineInfo

  • Reference
Module:
sharepoint-server
Applies to:
SharePoint Server Subscription Edition

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

-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 Subscription Edition

-Availability

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

The valid values are:

--Available --Unavailable

Type:SPRoutingMachineAvailability
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-ClearOutgoingPort

Clears the outgoing port if it is set.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-Identity

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

Type:SPRoutingMachineInfoPipeBind
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-OutgoingPort

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

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-OutgoingScheme

Determines the schema of outgoing connections.

The valid values are:

--SameAsIncoming --Http --Https

Type:SPRoutingOutgoingScheme
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition

-StaticWeight

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
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:SharePoint Server Subscription Edition