Get-RDSGroupMember

NAME

Get-RDSGroupMember

SYNOPSIS

Retrieves member information for an RD Session Host server group.

SYNTAX

Get-RDSGroupMember [-GroupName] <string> [-SiteId <uint>] [<CommonParameters>]

Get-RDSGroupMember [-GroupObject] <RDSGroup> [<CommonParameters>]

Get-RDSGroupMember [-GroupId] <uint> [<CommonParameters>]

DESCRIPTION

Retrieves the list of RD Session Host servers, which are members of a specified group.

It returns an arrays of objects of type RDS, each containing properties of an RD Session Host server.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

PARAMETERS


-GroupName <string>
The name of a group from which to retrieve server information. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
Site ID where the group is located.

If the parameter is omitted, the site ID of the Licensing Server will be used. 

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-GroupObject <RDSGroup>
An object of type RDSGroup representing an RD Session Host server group.

The object is obtained using the Get-RDSGroup cmdlet. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-GroupId <uint>
The ID of the RDSGroup representing an RD Session Host server group. 

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        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

RDSGroup

OUTPUTS

RDS

EXAMPLES


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

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

Retrieves the list of RD Session Host servers from the group specified by name.

The Format-List cmdlet formats the display output to include all available server properties.

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

Get-RDSGroupMember $RDSGroup

Retrieves the list of RD Session Host servers from the group specified by the $RDSGroup variable.

The $RDSGroup variable is an object of type RDSGroup, which is obtained using the Get-RDSGroup cmdlet.

---------- EXAMPLE 3 ----------

Get-RDSGroup "My RD Session Host Group" | Get-RDSGroupMember

Retrieves the list of servers from the group obtained from the pipeline output.

RELATED LINKS