Edit

Set-SPRoutingMachinePool

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

Sets properties of a machine pool.

Syntax

Set-SPRoutingMachinePool
   [-Identity] <SPRoutingMachinePoolPipeBind>
   [-AssignmentCollection <SPAssignmentCollection>]
   [-MachineTargets <SPRoutingRuleTargetPipeBind[]>]
   [<CommonParameters>]

Description

Use the Set-SPRoutingMachinePool cmdlet to set properties of a machine pool 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
$pool = Get-SPRoutingMachinePool -RequestManagementSettings $rm -Name 'MachinePool'
$newMachine = Get-SPRoutingMachineInfo -RequestManagementSettings $rm -Name SP01
Set-SPRoutingMachinePool -Identity $pool -MachineTargets ($pool.MachineTargets + $newMachine)

This example sets the routing machine pool on the specified Web Application. Using the Request Management settings of the Web Application, it retrieves the existing routing machine pool named 'MachinePool'. It then gets the routing machine info for a new machine to add to the pool. Lastly, it sets the pool with the existing machine targets plus the new machine target.

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

-Identity

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

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

-MachineTargets

Specifies the routing targets collection that the machine pool will contain.

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