Edit

Share via


Get-SPRoutingMachineInfo

Returns all the routing targets.

Syntax

Default (Default)

Get-SPRoutingMachineInfo
    [-RequestManagementSettings] <SPRequestManagementSettingsPipeBind>
    [-AssignmentCollection <SPAssignmentCollection>]
    [-Availability <SPRoutingMachineAvailability>]
    [-Name <String>]
    [<CommonParameters>]

Description

Use the Get-SPRoutingMachineInfo cmdlet to return all the routing targets that are being used by the Request Manager object.

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

Examples

EXAMPLE

C:\PS>$web=Get-SPWebApplication -Identity <URL of web application>

C:\PS>$rm=Get-SPRequestManagementSettings -Identity $web

Get-SPRoutingMachineInfo -RequestManagementSettings $rm

This example returns a routing target for a specified identity.

Parameters

-AssignmentCollection

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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.

Parameter properties

Type:SPAssignmentCollection
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-Availability

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies whether or not the specified computer will be available for routing. If no value is specified, all computers are returned.

The values for this parameter are filtered based on availability.

The valid values are:

--Available --Unavailable

Parameter properties

Type:SPRoutingMachineAvailability
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

Specifies the name of the computer for which you want to return routing information.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequestManagementSettings

Applicable: SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019

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

Parameter properties

Type:SPRequestManagementSettingsPipeBind
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:1
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.