Export (0) Print
Expand All
Expand Minimize

Set-SPRoutingMachineInfo

SharePoint 2013

Updated: March 12, 2013

Applies to:  SharePoint Foundation 2013 | SharePoint Server 2013 Enterprise 

Sets routing target properties.

Set-SPRoutingMachineInfo [-Identity] <SPRoutingMachineInfoPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Availability <Nullable>] [-ClearOutgoingPort <SwitchParameter>] [-OutgoingPort <Nullable>] [-OutgoingScheme <Nullable>] [-StaticWeight <Nullable>]

Parameters

Parameter Required Type Description

Identity

Required

Microsoft.SharePoint.PowerShell.SPRoutingMachineInfoPipeBind

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

AssignmentCollection

Optional

Microsoft.SharePoint.PowerShell.SPAssignmentCollection

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.

note Note:

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.

Availability

Optional

System.Nullable

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

The valid values are:

--Available

--Unavailable

ClearOutgoingPort

Optional

System.Management.Automation.SwitchParameter

Clears the outgoing port if it is set.

OutgoingPort

Optional

System.Nullable

Specifies the listening port for the computer that Request Management will use to communicate with.

OutgoingScheme

Optional

System.Nullable

Determines the schema of outgoing connections.

The valid values are:

--SameAsIncoming

--Http

--Https

StaticWeight

Optional

System.Nullable

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.

Detailed Description

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

Input Types

Return Types

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

$web=Get-SPWebApplication -Identity <URL of web application>
$rm=Get-SPRequestManagementSettings -Identity $web
$m=Get-SPRoutingMachineInfo -RequestManagementSettings $rm -Name <MachineName>
Set-SPRoutingMachineInfo -Identity $m -Availability Unavailable

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

Change History

Date Description

March 12, 2013

Updated the description for the OutgoingPort parameter.

July 16, 2012

Initial publication

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft