Get-RASRDSHostPool
NAME
Get-RASRDSHostPool
SYNOPSIS
Retrieves information about one or multiple RD Session Host Pools.
SYNTAX
Get-RASRDSHostPool [[-Id] <uint>] [<CommonParameters>]
Get-RASRDSHostPool [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]
DESCRIPTION
Retrieves information about one or multiple RD Session Host Pools.
The cmdlet returns an object of type RDSHostPool.
To see the complete list of object properties, use the Format-List cmdlet (see examples).
The result set contains only the major properties of a host pool; it does not include the complete list of settings supported in RAS.
PARAMETERS
-Name <string> The name of a group for which to retrieve the information.
Required? false
Position? 0
Default value
Accept pipeline input? false
Accept wildcard characters? false-SiteId <uint> Site ID from which to retrieve the group info.
If the parameter is omitted, the site ID of the Licensing Server will be used.
Required? false
Position? 1
Default value 0
Accept pipeline input? false
Accept wildcard characters? false-Id <uint> The ID of a group for which to retrieve the information.
Required? false
Position? 0
Default value 0
Accept pipeline input? true (ByValue)
Accept wildcard characters? false<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters documentation. INPUTS
System.UInt32
OUTPUTS
EXAMPLES
---------- EXAMPLE 1 ----------
Get-RASRDSHostPool "My RD Session Host Pool" | Format-List
Retrieves information about the host pool specified by name from the Licensing Server site.
To retrieve the info from a specific site, specify the -SiteId parameter.
The Format-List cmdlet formats the display output to include all available host pool properties. ---------- EXAMPLE 2 ----------
Get-RASRDSHostPool -Id 10
Retrieves information about the host pool specified by ID from the Licensing Server site.
RELATED LINKS
Last updated