Delete a RD Session Host server from a site. The RD Session Host agent will be uninstalled from the server by default. You can optionally keep it by including the noUninstall
parameter.
RD Session Host ID
No Content
Update RD Session Host server settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.
RD Session Host ID
RD Session Host settings
Enable or disable the specified RD Session Host server in a site.
A new server name. This must be either the server's FQDN or IP address.
A user-defined RD Session Host server description.
Specifies the RD Session Host server direct address.
Enable or disable the 'Inherit default agent settings' option. This will inherit RD Session Host 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 RD Session Host 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 RD Session Host 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 RD Session Host 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 Optimization Settings' option. This will inherit Image Optimization 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 Application Packages 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.
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.
Enables or disables Universal Printing on the RD Session Host server. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.
Enable or disable TWAIN (Universal Scanning) on the RD Session Host server. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.
Enable or disable WIA (Universal Scanning) on the RD Session Host server. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.
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.
Set the 'Preferred Connection Broker' option to 'Automatically".
The preferred Connection Broker ID.
Enable or disable the 'Enable Drive Redirection Cache' 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
Retrieve a specific RD Session Host by ID. The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.
RD Session Host ID
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.
Server name.
Whether the server is enabled or not.
Description of the server.
ID of the site.
The direct address of the target RD Session Host server.
The RDSH RAS Template ID.
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 optimization settings will be inherited.
If true, default app package settings will be inherited.
The port number of RD Session Host agent.
Maximum number of session a RDS Host can have.
Disconnect active session after (in seconds). 0 - Never.
Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.
URL and Mail Redirection values.
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.
Specifies if 'Application Monitoring' option is enabled or disabled.
Specifies if 'Use RemoteApps if available' option is enables or disabled.
Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)
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.
Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)
Drag and drop redirection values.
The preferred Connection broker ID.
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
Manage RDP transport protocol.
Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.
Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.
Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.
Printer Name Format
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
User Profile Technology values.
FXLogix Settings
User Profile Disk Mode.
Specifies the max user profile disk size (in GB).
Specifies the User Profile Disk path.
User Profile Disk Roaming Mode.
Specifies the UPD 'Include' folder paths.
Specifies the UPD 'Include' file paths.
Specifies the UPD 'Exclude' folder paths.
Specifies the UPD 'Exclude' file paths.
Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.
Image Optimization
Application Packages Assigned
Create a new RD Session Host server to a site. The RD Session Host agent will be installed on the server by default. You can optionally skip the agent installation by including the noInstall
parameter.
RD Session Host settings
A RD Session Host server FQDN or IP address.
The site ID to which to add the specified server. If the parameter is omitted, the Licensing Server site ID will be used.
Specifies the list of users or groups in UPN or SID format to be added to the RDSUsers Group in csv format.
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.
Server name.
Whether the server is enabled or not.
Description of the server.
ID of the site.
The direct address of the target RD Session Host server.
The RDSH RAS Template ID.
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 optimization settings will be inherited.
If true, default app package settings will be inherited.
The port number of RD Session Host agent.
Maximum number of session a RDS Host can have.
Disconnect active session after (in seconds). 0 - Never.
Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.
URL and Mail Redirection values.
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.
Specifies if 'Application Monitoring' option is enabled or disabled.
Specifies if 'Use RemoteApps if available' option is enables or disabled.
Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)
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.
Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)
Drag and drop redirection values.
The preferred Connection broker ID.
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
Manage RDP transport protocol.
Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.
Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.
Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.
Printer Name Format
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
User Profile Technology values.
FXLogix Settings
User Profile Disk Mode.
Specifies the max user profile disk size (in GB).
Specifies the User Profile Disk path.
User Profile Disk Roaming Mode.
Specifies the UPD 'Include' folder paths.
Specifies the UPD 'Include' file paths.
Specifies the UPD 'Exclude' folder paths.
Specifies the UPD 'Exclude' file paths.
Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.
Image Optimization
Application Packages Assigned
Retrieve a list of RD Session Host settings. The result set contains only the major properties of a group; it does not include the complete list of settings supported in RAS.
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.
Server name.
Whether the server is enabled or not.
Description of the server.
ID of the site.
The direct address of the target RD Session Host server.
The RDSH RAS Template ID.
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 optimization settings will be inherited.
If true, default app package settings will be inherited.
The port number of RD Session Host agent.
Maximum number of session a RDS Host can have.
Disconnect active session after (in seconds). 0 - Never.
Logoff disconnected session after (in seconds). 0 - Never; 1 - Immediate.
URL and Mail Redirection values.
Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.
Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.
Specifies if 'Application Monitoring' option is enabled or disabled.
Specifies if 'Use RemoteApps if available' option is enables or disabled.
Specifies if 'Allow file transfer' option is enables or disabled. (deprecated)
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.
Specifies if 'Allow local to remote drag and drop' option is enables or disabled. (deprecated)
Drag and drop redirection values.
The preferred Connection broker ID.
Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.
Manage RDP transport protocol.
Specifies if Universal Printing on the RD Session Host server is Enabled or disabled. In the RAS console, this option is toggled on the Universal Printing tab page in the Universal Printing category.
Specifies if TWAIN (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this option is toggled on the TWAIN tab page in the Universal Scanning category.
Specifies if WIA (Universal Scanning) on the RD Session Host server is enabled or disabled. In the RAS console, this options is toggled on the WIA tab page in the Universal Scanning category.
Printer Name Format
Specifies if 'Remove client name from printer name' option is enabled or disabled.
Specifies if 'Remove session number from printer name' option is enabled or disabled.
User Profile Technology values.
FXLogix Settings
User Profile Disk Mode.
Specifies the max user profile disk size (in GB).
Specifies the User Profile Disk path.
User Profile Disk Roaming Mode.
Specifies the UPD 'Include' folder paths.
Specifies the UPD 'Include' file paths.
Specifies the UPD 'Exclude' folder paths.
Specifies the UPD 'Exclude' file paths.
Specifies if 'Restrict direct desktop access to the following users' option is enabled or disabled.
Specifies the list of users for the RestrictDesktopAccess option (the option should be enabled). The list can contain user account names and user SIDs.
Image Optimization
Application Packages Assigned