Remove-RASRDSHostPool

NAME

Remove-RASRDSHostPool

SYNOPSIS

Removes an RD Session Host Pool from a site.

SYNTAX

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

Remove-RASRDSHostPool [-InputObject] <RDSHostPool> [<CommonParameters>]

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

DESCRIPTION

Removes an RD Session Host Pool from a site.

PARAMETERS


-Name <string>
The name of a RD Session Host server host pool 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 host pool.

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 Pool ID. To obtain the ID of a host pool, use the Get-RASRDSHostPool cmdlet. 

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

-InputObject <RDSHostPool>
A RD Session Host Pool object (an object of type RDSHostPool) to remove from a site.

A RDSHostPool object representing a group is obtained using the Get-RASRDSHostPool 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

RDSHostPool

OUTPUTS

-none-

EXAMPLES


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

Remove-RASRDSHostPool "My RDS Host Pool"

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

To remove a host pool from a specific site, specify the -SiteId parameter.
---------- EXAMPLE 2 ----------

Remove-RASRDSHostPool -Id 10

Removes the host pool specified by ID from the Licensing Server site. To obtain the host pool ID, use the Get-RASRDSHostPool cmdlet.
---------- EXAMPLE 3 ----------

Get-RASRASRDSHostPool | Remove-RASRASRDSHostPool

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

RELATED LINKS