New-RDSGroup

New-RDSGroup

Creates a new RD Session Host server group.

New-RDSGroup [-Name] <string> [[-SiteId] <uint>] [-Description <string>] [-MaxServersFromTemplate <uint>] [-RASTemplate <VDITemplate>] [-RDSObject <RDS[]>] [-ServersToAddPerRequest <uint>] [-UseRASTemplate <SwitchParameter>] [-WorkLoadThreshold <uint>] [-WorkLoadToDrain <uint>] [<CommonParameters>]

Creates a new RD Session Host server group. Individual servers can be added to the group using the Add-RDSGroupMember cmdlet.

-Name <string>
Group name.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint>
Site ID in which to create the 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

-Description <string>
A description of the specified group.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-UseRASTemplate <SwitchParameter>
Enables use of RAS Template.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

-RASTemplate <VDITemplate>
The RD RAS Template object.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WorkLoadThreshold <uint>
Send a request to the RAS template when the workload threshold is above the specified value

Default: 75

        Required?                    false

        Position?                    named

        Default value                75

        Accept pipeline input?       false

        Accept wildcard characters?  false

-ServersToAddPerRequest <uint>
Number of servers to be added to the group per request

Default: 1

        Required?                    false

        Position?                    named

        Default value                1

        Accept pipeline input?       false

        Accept wildcard characters?  false

-MaxServersFromTemplate <uint>
Max number of servers to be added to the group from the RAS Template

Default: 2

        Required?                    false

        Position?                    named

        Default value                2

        Accept pipeline input?       false

        Accept wildcard characters?  false

-WorkLoadToDrain <uint>
Drain and unassign servers from group when workload is below the specified value

Default: 20

        Required?                    false

        Position?                    named

        Default value                20

        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?                    false

        Position?                    named

        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. 

PSAdmin.RDSGroup

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

New-RDSGroup "My RDS Group"

Creates a new RD Session Host server group with the specified name.