HostPool
Last updated
Last updated
Delete a RD Session Host Pool
ID of the RD Session Host Pool to be deleted
No Content
Retrieve a list of the RD Session Host Pools
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
RDS Host Pool name.
ID of the site.
Whether the RDS Host Pool is enabled or not.
Description of the RDS Host Pool.
Whether the RD session hosts are based on a template or not.
The RDSH RAS Template ID.
The RDSH RAS Template Version ID.
Min number of servers to be added to the host pool from the template.
Max number of servers to be added to the host pool from the template.
Send a request to the template when the 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 specified time (in seconds).
Remove servers from host pool after drain and power off.
If true, default agent settings will be inherited.
If true, default printer settings will be inherited.
If true, default User Profile settings will be inherited.
If true, default desktop access settings will be inherited.
If true, default app package settings will be inherited.
If true, default Auto-upgrade settings will be inherited.
RDS Default Settings
The Ids of the RDS that form part of the host pool.
Host Pool Base Provisioning Settings
Modify the properties of a RD Session Host Pool
ID of the RD Session Host Pool to be updated
The RD Session Host Pool to be updated
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 RAS Template ID.
The RDSH RAS Template Version 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.
Session Type
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 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'.
URL and Mail Redirection values.
Enable or disable the 'Support Shell URL Namespace Objects' option.
Set the 'Preferred Connection Broker' option to 'Automatically".
The preferred Connection Broker.
Enable or disable the 'Enable Drive Redirection Cache' option.
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.
File Transfer Control modes.
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.
Drag and drop redirection values.
Manage RDP transport protocol.
Printer Name Format
Enable or disable the 'Remove client name from printer name' option.
Enable or disable the 'Remove session number from printer name' option.
User Profile Technology values.
User Profile Disk Mode.
User Profile Disk Roaming Mode.
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.
No Content
Create a new RD Session Host Pool
RD Session Host Pool
Host pool name.
Site ID in which to create the host pool. If the parameter is omitted, the site ID of the Licensing Server will be used.
A description of the specified host pool.
Enable Autoscaling.
The RDSH RAS Template ID.
The RDSH RAS Template Version ID.
Min number of servers to be added to the host pool from the RAS Template. Default: 1
Max number of servers to be added to the host pool from the RAS Template. Default: 2
The host name format. All hosts created from the template will have this name with %ID:N:S% replaced.
Session Type
The number of hosts that will be created after template creation process has finished. These desktops are created only once.
Send a request to the RAS template when the workload threshold is above the specified value. Default: 75
Number of servers to be added to the host pool per request. Default: 1
Drain and power off servers within host pool when workload is below the specified value. Default: 20
Drain and power off servers from host pool when workload remains below the specified level for the below specified time (in seconds). Default: 0 (Immediate)
Remove servers from host pool after drain and power off.
A list of RD Session Host servers (an array of RDS Ids) to add to the host pool.
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 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'.
URL and Mail Redirection values.
Enable or disable the 'Support Shell URL Namespace Objects' option.
The preferred Connection Broker.
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.
File Transfer Control modes.
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.
Drag and drop redirection values.
Manage RDP transport protocol.
Printer Name Format
Enable or disable the 'Remove client name from printer name' option.
Enable or disable the 'Remove session number from printer name' option.
User Profile Technology values.
User Profile Disk Mode.
User Profile Disk Roaming Mode.
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.
Created
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
RDS Host Pool name.
ID of the site.
Whether the RDS Host Pool is enabled or not.
Description of the RDS Host Pool.
Whether the RD session hosts are based on a template or not.
The RDSH RAS Template ID.
The RDSH RAS Template Version ID.
Min number of servers to be added to the host pool from the template.
Max number of servers to be added to the host pool from the template.
Send a request to the template when the 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 specified time (in seconds).
Remove servers from host pool after drain and power off.
If true, default agent settings will be inherited.
If true, default printer settings will be inherited.
If true, default User Profile settings will be inherited.
If true, default desktop access settings will be inherited.
If true, default app package settings will be inherited.
If true, default Auto-upgrade settings will be inherited.
RDS Default Settings
The Ids of the RDS that form part of the host pool.
Host Pool Base Provisioning Settings
Retrieve information about a RD Session Host Pool.
ID of the RD Session Host Pool to be retrieved
Success
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
RDS Host Pool name.
ID of the site.
Whether the RDS Host Pool is enabled or not.
Description of the RDS Host Pool.
Whether the RD session hosts are based on a template or not.
The RDSH RAS Template ID.
The RDSH RAS Template Version ID.
Min number of servers to be added to the host pool from the template.
Max number of servers to be added to the host pool from the template.
Send a request to the template when the 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 specified time (in seconds).
Remove servers from host pool after drain and power off.
If true, default agent settings will be inherited.
If true, default printer settings will be inherited.
If true, default User Profile settings will be inherited.
If true, default desktop access settings will be inherited.
If true, default app package settings will be inherited.
If true, default Auto-upgrade settings will be inherited.
RDS Default Settings
The Ids of the RDS that form part of the host pool.
Host Pool Base Provisioning Settings