Skip to content

Latest commit

 

History

History
144 lines (100 loc) · 4.01 KB

File metadata and controls

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

Get-SPRoutingMachineInfo

SYNOPSIS

Returns all the routing targets.

SYNTAX

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

$web=Get-SPWebApplication -Identity <URL of web application>
$rm=Get-SPRequestManagementSettings -Identity $web
Get-SPRoutingMachineInfo -RequestManagementSettings $rm

This example returns a routing target for a specified identity.

PARAMETERS

-RequestManagementSettings

Applicable: SharePoint Server Subscription Edition

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

Type: SPRequestManagementSettingsPipeBind
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. 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

Type: SPRoutingMachineAvailability
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Name

Applicable: SharePoint Server Subscription Edition

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

Type: String
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

Remove-SPRoutingMachineInfo

Set-SPRoutingMachineInfo