Remove-RDSGroupMember

NAME

Remove-RDSGroupMember

SYNOPSIS

Removes an RD Session Host server from a group.

SYNTAX

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

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

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

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

Remove-RDSGroupMember [-GroupId] <uint> [-RDSId] <uint> [<CommonParameters>]

DESCRIPTION

Removes an RD Session Host server from an RD Session Host server group.

PARAMETERS


-GroupName <string>
The name of the target RD Session Host server group. 

        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 a group from which to delete specified RD Session Host servers.

An RDSGroup 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 remove from the specified 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 remove from the specified 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

-RDSId <uint>
The ID of an RD Session Host server to remove from the specified group. 

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

-none-

EXAMPLES


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

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

Removes the specified RD Session Host server from the specified group.

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

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

Removes the specified RD Session Host server from the group specified by the $RDSGroup variable.

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

RELATED LINKS