Add-RDSGroupMember

NAME

Add-RDSGroupMember

SYNOPSIS

Adds one or multiple RD Session Host servers to a group.

SYNTAX

Add-RDSGroupMember [-GroupName] <string> -RDSServer <string> [-SiteId <uint>] [<CommonParameters>]

Add-RDSGroupMember [-GroupName] <string> -RDSObject <RDS[]> [-SiteId <uint>] [<CommonParameters>]

Add-RDSGroupMember [-GroupObject] <RDSGroup> -RDSServer <string> [<CommonParameters>]

Add-RDSGroupMember [-GroupObject] <RDSGroup> -RDSObject <RDS[]> [<CommonParameters>]

Add-RDSGroupMember [-GroupId] <uint> [-RDSIds] <List`1> [<CommonParameters>]

DESCRIPTION

Adds one or multiple RD Session Host servers to an existing group.

PARAMETERS


-GroupName <string>
RD Session Host server group name. 

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

-SiteId <uint>
Site ID where the RD Session Host server 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 identifying the target 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

-RDSServer <string>
The name of an RD Session Host server to add to the group. 

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

-RDSObject <RDS[]>
A list of RD Session Host servers (an array of objects of type RDS) to add to the group.

An RDS object representing an RD Session Host server is obtained using the Get-RDS cmdlet. 

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

-GroupId <uint>
The ID of the target RD Session Host server group. 

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

-RDSIds <List`1>
The IDs of RD Session Host servers to be added to the specified group. 

        Required?                    true
        Position?                    1
        Default value                
        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

-none-

EXAMPLES


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

Add-RDSGroupMember "My RD Session Host Group" -RDSServer "server.company.dom"

Adds the specified RD Session Host server to the specified group.

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

Add-RDSGroupMember "My RD Session Host Group" -RDSObject $RDSList

Adds a list of RD Session Host servers ($RDSList) to the specified group.

The $RDSList variable is an array of objects of type RDS. An RDS object representing an RD Session Host server is obtained using the Get-RDS cmdlet.

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

Add-RDSGroupMember $RDSGroup -RDSServer "server.company.dom"

Adds the specified RD Session Host server to the group specified by the $RDSGroup variable.

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

---------- EXAMPLE 4 ----------

Get-RDSGroup "My RD Session Host Group" | Add-RDSGroupMember -RDSServer "server.company.dom"

Adds the specified RD Session Host server to the group obtained from the pipeline output.

RELATED LINKS