Get-RDSGroup

NAME

Get-RDSGroup

SYNOPSIS

Retrieves information about one or multiple RD Session Host server groups.

SYNTAX

Get-RDSGroup [[-Name] <string>] [[-SiteId] <uint>] [<CommonParameters>]

Get-RDSGroup [[-Id] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves information about one or multiple RD Session Host server groups.

The cmdlet returns an object of type RDSGroup.

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 group; 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

RDSGroup

EXAMPLES


---------- EXAMPLE 1 ----------

Get-RDSGroup "My RD Session Host Group" | Format-List

Retrieves information about the group 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 group properties.

---------- EXAMPLE 2 ----------

Get-RDSGroup -Id 10

Retrieves information about the group specified by ID from the Licensing Server site.

RELATED LINKS