Move-RASRDSHostPoolMember

NAME

Move-RASRDSHostPoolMember

SYNOPSIS

Moves one or multiple RD Session Host servers to a host pool.

SYNTAX

Move-RASRDSHostPoolMember [-HostPoolId] <uint> [-RDSIds] <uint[]> [<CommonParameters>]

Move-RASRDSHostPoolMember [-HostPoolName] <string> -RDSObject <RDSHost[]> [-SiteId <uint>] [<CommonParameters>]

Move-RASRDSHostPoolMember [-HostPoolName] <string> -RDSServer <string> [-SiteId <uint>] [<CommonParameters>]

Move-RASRDSHostPoolMember [-HostPoolObject] <RDSHostPool> -RDSObject <RDSHost[]> [<CommonParameters>]

Move-RASRDSHostPoolMember [-HostPoolObject] <RDSHostPool> -RDSServer <string> [<CommonParameters>]

DESCRIPTION

Moves one or multiple RD Session Host servers to an existing host pool.

PARAMETERS


-HostPoolName <string>
RD Session Host Pool name. 

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

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

-HostPoolId <uint>
The ID of the target RD Session Host Pool. 

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

-HostPoolObject <RDSHostPool>
An object of type RDS Group identifying the target RD Session Host Pool.

The object is obtained using the Get-RASRDSHostPool cmdlet. 

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

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

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

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

A RDS object representing a 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

-RDSIds <uint[]>
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

RDSHostPool

OUTPUTS

-none-

EXAMPLES


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

Move-RASRDSHostPoolMember "My RD Session Host Pool" -RDSServer "server.company.dom"

Moves the specified RD Session Host server to the specified host pool.
---------- EXAMPLE 2 ----------

Move-RASRDSHostPoolMember "My RD Session Host Pool" -RDSObject $RDSList

Moves a list of RD Session Host servers ($RDSList) to the specified host pool.

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-RASRDSHost cmdlet.
---------- EXAMPLE 3 ----------

Move-RASRDSHostPoolMember $RDSHostPool -RDSServer "server.company.dom"

Moves the specified RD Session Host server to the host pool specified by the $RDSHostPool variable.

$RDSHostPool is an object of type RDSHostPool, which is obtained using the Get-RASRDSHostPool cmdlet.
---------- EXAMPLE 4 ----------

Get-RASRDSHostPool "My RD Session Host Pool" | Move-RASRDSHostPoolMember -RDSServer "server.company.dom"

Moves the specified RD Session Host server to the host pool obtained from the pipeline output.

RELATED LINKS