Set-RDSGroup

NAME

Set-RDSGroup

SYNOPSIS

Modifies an RD Session Host server group.

SYNTAX

Set-RDSGroup [-Name] <string> [[-SiteId] <uint>] [-Description <string>] [-Enable <bool>] [-MaxServersFromTemplate <uint>] [-NewName <string>] [-RASTemplate <VDITemplate>] [-ServersToAddPerRequest <uint>] [-UseRASTemplate <bool>] [-WorkLoadThreshold <uint>] [-WorkLoadToDrain <uint>] [<CommonParameters>]

Set-RDSGroup [-Id] <uint> [-Description <string>] [-Enable <bool>] [-MaxServersFromTemplate <uint>] [-NewName <string>] [-RASTemplate <VDITemplate>] [-ServersToAddPerRequest <uint>] [-UseRASTemplate <bool>] [-WorkLoadThreshold <uint>] [-WorkLoadToDrain <uint>] [<CommonParameters>]

Set-RDSGroup [-InputObject] <RDSGroup> [-Description <string>] [-Enable <bool>] [-MaxServersFromTemplate <uint>] [-NewName <string>] [-RASTemplate <VDITemplate>] [-ServersToAddPerRequest <uint>] [-UseRASTemplate <bool>] [-WorkLoadThreshold <uint>] [-WorkLoadToDrain <uint>] [<CommonParameters>]

DESCRIPTION

Modifies properties of an RD Session Host server group.

PARAMETERS


-Name <string>
The name of the group to modify.

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

-SiteId <uint>
Site ID where the target group is located.

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>
The ID of an RD Session Host server group to modify.

        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 modify.

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

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

-Enable <bool>
Enables or disables the specified group(s) in a site.

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

-NewName <string>
A new name to assign to the specified group.

        Required?                    false
        Position?                    named
        Default value                
        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 <bool>
Enables or disables the use of RAS Template.

        Required?                    false
        Position?                    named
        Default value                
        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

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

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

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

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

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

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

        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. 

INPUTS

PSAdmin.RDSGroup

OUTPUTS

-none-

EXAMPLES


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

Set-RDSGroup "My RD Session Host Group" -Enable $False

Disables the RD Session Host server group specified by name.

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

Set-RDSGroup -Id 11 -Enable $False

Disables the RD Session Host server group specified by ID.

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

Set-RDSGroup $RDSGroup -Enable $False

Disables the RD Session Host server group specified by the $RDSGroup variable (an object of type RDSGroup).

To obtain an RDSGroup object representing a group, use the Get-RDSGroup cmdlet.

---------- EXAMPLE 4 ----------

Get-RDSGroup -Id 11 | Set-RDSGroup -Enable $False

Disables the RD Session Host server group obtained from the pipeline output.

RELATED LINKS