Remove-RDSGroup

NAME

Remove-RDSGroup

SYNOPSIS

Removes an RD Session Host server group from a site.

SYNTAX

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

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

Remove-RDSGroup [-InputObject] <RDSGroup> [<CommonParameters>]

DESCRIPTION

Removes an RD Session Host server group from a site.

PARAMETERS


-Name <string>
The name of an RD Session Host server group to remove from a site. 

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

-SiteId <uint>
Site ID from which to remove the specified group.

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>
RD Session Host server group ID. To obtain the ID of a group, use the Get-RDSGroup cmdlet. 

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

-InputObject <RDSGroup>
An RD Session Host server group (an object of type RDSGroup) to remove from a site.

An RDSGroup object representing a group is obtained using the Get-RDSGrouip cmdlet. 

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

RDSGroup

OUTPUTS

-none-

EXAMPLES


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

Remove-RDSGroup "My RDS Group"

Removes the group specified by name from the Licensing Server site (default).

To remove a group from a specific site, specify the -SiteId parameter.

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

Remove-RDSGroup -Id 10

Removes the group specified by ID from the Licensing Server site. To obtain the group ID, use the Get-RDSGroup cmdlet.

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

Get-RDSGroup | Remove-RDSGroup

Removes an RD Session Host server group, which is identified by an object obtained from the pipeline output.

RELATED LINKS