-
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
-
Enabled <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
-
Enable <bool>
Enables or disables the specified group(s) in a site.
This is an alias of the Enabled parameter.
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
-
RASTemplateId <uint>
The RD RAS Template Id.
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
-
InheritDefaultAgentSettings <bool>
Enables the 'Inherit default settings' option. This will inherit Global agent settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
InheritDefaultPrinterSettings <bool>
Enables the 'Inherit default settings' option. This will inherit Global printer settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
InheritDefaultUPDSettings <bool>
Enables the 'Inherit default settings' option. This will inherit Global User Profile Disk settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
InheritDefaultDesktopAccessSettings <bool>
Enables the 'Inherit default settings' option. This will inherit Global Desktop Access settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
Port <uint>
Specifies the port number for the RD Session Host agent.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
MaxSessions <uint>
Specifies the 'Maximum Sessions' property.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
SessionTimeout <uint>
Specifies the 'Publishing Sessions Disconnect Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
SessionLogoffTimeout <uint>
Specifies the 'Publishing Settings Reset Timeout' option (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AllowURLAndMailRedirection <AllowURLAndMailRedirection>
Specifies the 'Allow Client URL/Mail Redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration).
Possible values: Disabled, Enabled, EnabledWithAppRegistration
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
SupportShellURLNamespaceObjects <bool>
Enables or disables the 'Support Shell URL Namespace Objects' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AutoPreferredPA <SwitchParameter>
Sets the 'Preferred Publishing Agent' option to 'Automatically".
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-
PreferredPAObj <PA>
The preferred Publishing Agent server.
To obtain an object of type PA representing the preferred Publishing Agent, use the Get-PA cmdlet.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AllowRemoteExec <bool>
Enables or disables the 'Allow 2XRemoteExec to send command to the client' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
EnableAppMonitoring <bool>
Enables or disables the 'Application Monitoring' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
UseRemoteApps <bool>
Enables or disables the 'Use RemoteApps if available' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
AllowFileTransfer <bool>
Enables or disables the 'Allow file transfer' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
PrinterNameFormat <PrnNameFormat>
Specifies the 'Printer Name Format' option. Accepted values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES.
Possible values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RemoveClientNameFromPrinterName <bool>
Enables or disables the 'Remove client name from printer name' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RemoveSessionNumberFromPrinterName <bool>
Enables or disables the 'Remove session number from printer name' option.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
UPDMode <UPDMode>
Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled.
Possible values: DoNotChange, Enabled, Disabled
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
UPDRoamingMode <UPDRoamingMode>
Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include.
Possible values: Exclude, Include
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
UPDiskPath <string>
Specifies the User Profile Disk path.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
MaxUserProfileDiskSizeGB <uint>
Specifies the max user profile disk size (in GB).
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
IncludeFolderPath <string[]>
Specifies the UPD 'Include' folder paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
IncludeFilePath <string[]>
Specifies the UPD 'Include' file paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
ExcludeFolderPath <string[]>
Specifies the UPD 'Exclude' folder paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
ExcludeFilePath <string[]>
Specifies the UPD 'Exclude' file paths.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RestrictDesktopAccess <bool>
Enables or disables the 'Restrict direct desktop access to the following users' option.
Use the RestrictedUsers parameter to specify the list of users.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-
RestrictedUsers <string[]>
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled).
The list can contain user account names and user SIDs.
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.