Set-RASRDSHostPool
Last updated
Last updated
Set-RASRDSHostPool
Modifies an RD Session Host Pool.
Set-RASRDSHostPool [] (uint)** [ (bool)] [- {Disabled | Enabled | EnabledWithAppRegistration}] [ (SwitchParameter)] [ (bool)] [- (List`1)] [- (string[])] [- {Template | Selection}] [- {PoweredOn | PoweredOff | Suspended}] [ (string)] [ (uint)] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [ (uint)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [- (string[])] [- (string[])] [ (string)] [ (bool)] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [ (string)] [- (string[])] [- (string[])] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [ (uint)] [- {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [ (uint)] [ (uint)] [ (uint)] [ (uint)] [ (string)] [ (uint)] [ (uint)] [- ()] [- {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [- ()] [ (uint)] [ (uint)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [- (string[])] [ (uint)] [ (bool)] [- {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [- ()] [ (uint)] [ (uint)] [ (uint)] [ (string)] [- {DoNotChange | Enabled | Disabled}] [- {Exclude | Include}] [ (bool)] [ (uint)] [ (uint)] [()]
Set-RASRDSHostPool [-] () [ (bool)] [- {Disabled | Enabled | EnabledWithAppRegistration}] [ (SwitchParameter)] [ (bool)] [- (List`1)] [- (string[])] [- {Template | Selection}] [- {PoweredOn | PoweredOff | Suspended}] [ (string)] [ (uint)] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [ (uint)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [- (string[])] [- (string[])] [ (string)] [ (bool)] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [ (string)] [- (string[])] [- (string[])] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [ (uint)] [- {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [ (uint)] [ (uint)] [ (uint)] [ (uint)] [ (string)] [ (uint)] [ (uint)] [- ()] [- {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [- ()] [ (uint)] [ (uint)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [- (string[])] [ (uint)] [ (bool)] [- {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [- ()] [ (uint)] [ (uint)] [ (uint)] [ (string)] [- {DoNotChange | Enabled | Disabled}] [- {Exclude | Include}] [ (bool)] [ (uint)] [ (uint)] [()]
Set-RASRDSHostPool []** (string) [[-] (uint)] [ (bool)] [- {Disabled | Enabled | EnabledWithAppRegistration}] [ (SwitchParameter)] [ (bool)] [- (List`1)] [- (string[])] [- {Template | Selection}] [- {PoweredOn | PoweredOff | Suspended}] [ (string)] [ (uint)] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [ (uint)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [- (string[])] [- (string[])] [ (string)] [ (bool)] [- {Disabled | ClientToServer | ServerToClient | Bidirectional}] [ (string)] [- (string[])] [- (string[])] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [ (uint)] [- {Disabled | BothUDPTCP | OnlyTCP | EitherUDPTCP}] [ (uint)] [ (uint)] [ (uint)] [ (uint)] [ (string)] [ (uint)] [ (uint)] [- ()] [- {PrnFormat_PRN_CMP_SES | PrnFormat_SES_CMP_PRN | PrnFormat_PRN_REDSES}] [- ()] [ (uint)] [ (uint)] [ (bool)] [ (bool)] [ (bool)] [ (bool)] [- (string[])] [ (uint)] [ (bool)] [- {DoNotManage | UPD | FSLogix | FSLogixProfileContainer}] [- ()] [ (uint)] [ (uint)] [ (uint)] [ (string)] [- {DoNotChange | Enabled | Disabled}] [- {Exclude | Include}] [ (bool)] [ (uint)] [ (uint)] [()]
Modifies properties of an RD Session Host Pool.
The name of the host pool to modify.
Site ID where the target host pool is located.
If the parameter is omitted, the site ID of the Licensing Server will be used.
The ID of a RD Session Host Pool to modify.
A RD Session Host Pool object (an object of type RDSHostPool) to modify.
A RDSHostPool object representing a group is obtained using the Get-RASRDSHostPool cmdlet.
Enable or disable the specified host pool(s) in a site.
A new name to assign to the specified host pool.
A description of the specified host pool.
Enable or disable Autoscaling.
The RDSH Template object.
The RDSH Template object.
The RDSH Template ID.
The RDSH Template ID.
The RDSH Template Version ID.
Deprecated: The RDSH Template Version ID.
The RDSH Template Tag ID.
Min number of servers to be added to the host pool from the RAS Template.
Max number of servers to be added to the host pool from the RAS Template.
The VM name format. All VMs created from the template will have this name with %ID:N:S% replaced.
Possible values: PoweredOn, PoweredOff, Suspended
Send a request to the RAS template when the workload threshold is above the specified value.
Number of servers to be added to the host pool per request.
Drain and unassign servers from host pool when workload is below the specified value.
Drain and unassign servers from host pool when workload remains below the specified level for the below specified time (in seconds).
Remove servers from host pool after drain and power off.
Enable or disable the 'Inherit default agent 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.
Enable or disable the 'Inherit default printer 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.
Enable or disable the 'Inherit default user profile settings' option. This will inherit Global User Profile settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Enable or disable the 'Inherit default desktop access 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.
Enable or disable the 'Inherit default app package settings' option. This will inherit Global App Package settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Enable or disable the 'Inherit Auto-upgrade settings' option. This will inherit Global Auto-upgrade settings from the default profile.
If you would like to specify custom settings, you need to disable this option and specify the desired parameters.
Specifies the port number for the RD Session Host agent.
Specifies the 'Maximum Sessions' property.
Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.
Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.
Possible values: Disabled, Enabled, EnabledWithAppRegistration
Enable or disable the 'Support Shell URL Namespace Objects' option.
Set the 'Preferred Connection Broker' option to 'Automatically".
The preferred Connection Broker.
To obtain an object of type Broker representing the preferred Connection Broker, use the Get-RASBroker cmdlet.
The preferred Connection Broker.
Enable or disable the 'Enable Drive Redirection Cache' option.
Enable or disable the 'Enable Z-Order' option. (Experimental)
Enable or disable the 'Allow 2XRemoteExec to send command to the client' option.
Enable or disable the 'Application Monitoring' option.
Enable or disable the 'Use RemoteApps if available' option.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
Location where the File Transfer takes place, if and where it is allowed.
Lock Location where the File Transfer takes place, if and where it is allowed.
Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional
Possible values: Disabled, BothUDPTCP, OnlyTCP, EitherUDPTCP
Possible values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES
Enable or disable the 'Remove client name from printer name' option.
Enable or disable the 'Remove session number from printer name' option.
Specifies the 'User Profile Technology' value.
Possible values: DoNotManage, UPD, FSLogix, FSLogixProfileContainer
Specifies the 'User Profile Disk Mode' option. Accepted values: DoNotChange, Enabled, Disabled.
Possible values: DoNotChange, Enabled, Disabled
Specifies the 'UPD Roaming Mode' option. Accepted values: Exclude, Include.
Possible values: Exclude, Include
Specifies the User Profile Disk path.
Specifies the max user profile disk size (in GB).
Specifies the UPD 'Include' folder paths.
Specifies the UPD 'Include' file paths.
Specifies the UPD 'Exclude' folder paths.
Specifies the UPD 'Exclude' file paths.
Enable or disable the 'Restrict direct desktop access to the following users' option.
Use the RestrictedUsers parameter to specify the list of users.
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled).
The list can contain user account names and user SIDs.
Add or remove Amazon Web Service Subnets.
Possible values: Template, Selection
Datastore IDs.
(CommonParameters)
-none-
**---------- EXAMPLE 1 ----------
Set-RASRDSHostPool "My RD Session Host Pool" -Enabled $False
Disables the RD Session Host Pool specified by name. **---------- EXAMPLE 2 ----------
Set-RASRDSHostPool -Id 11 -Enabled $False
Disables the RD Session Host Pool specified by ID. **---------- EXAMPLE 3 ----------
Set-RASRDSHostPool $RDSHostPool -Enabled $False
Disables the RD Session Host Pool specified by the $RDSHostPool variable (an object of type RDSHostPool).
To obtain an RDSHostPool object representing a host pool, use the Get-RASRDSHostPool cmdlet. **---------- EXAMPLE 4 ----------
Get-RASRDSHostPool -Id 11 | Set-RASRDSHostPool -Enabled $False
Disables the RD Session Host Pool obtained from the pipeline output.
() The Default Power State
() Specifies the 'Allow Client URL/Mail Redirection' option. Accepted values: Disabled, Enabled, EnabledWithAppRegistration (Enable with app registration).
() File Transfer option. Possible values are: 0 (Disabled), 1 (client to Server only), 2 {Server To Client only), 3 (Bidirectional).
() Specifies the mode the client server drag and drop feature will operate.
() Manage RDP transport protocol.
() Specifies the 'Printer Name Format' option. Accepted values: PrnFormat_PRN_CMP_SES, PrnFormat_SES_CMP_PRN, PrnFormat_PRN_REDSES.
() Datastore Source.