Host
Was this helpful?
Was this helpful?
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
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
If this parameter is included, the RD Session Host agent will not be uninstalled from the server. To uninstall the agent, omit this parameter. When uninstalling the agent, your RAS admin credentials will be used by default. You can specify different credentials if needed using the Username and Password parameters.
An administrator account to remotely uninstall the RD Session Host agent from the server. If this parameter is omitted, your RAS admin username (and password) will be used by default.
The password of the account specified in the Username parameter.
No Content
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.
Site ID for which to retrieve RD Session Host settings (optional)
Filter the result by server name (optional)
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.
Specifies not to install the RD Session Host agent on the server. If this parameter is omitted, the agent will be push installed on the server using your RAS admin credentials. To specify different credentials for push installation, specify the Username and Password parameters.
An administrator account for push installing the RD Session Host agent on the server. If this parameter is omitted, your RAS admin username (and password) will be used.
The password of the account specified in the Username parameter.
Specifies not to restart the server after the RD Session Host agent is installed. If this parameter is omitted, the server will be restarted if required.
Specifies not to add firewall rules to allow the RD Session Host Agent to communicate. If this parameter is omitted, the firewall rules will not be added.
Specifies not to install the Desktop Experience after the RD Session Host agent is installed. If this parameter is omitted, the Desktop Experience is installed.
Specifies not to install the Terminal Services role after the RD Session Host agent is installed. If this parameter is omitted, the Terminal Services role will be installed.
Specifies the list of users or groups in UPN or SID format to be added to the RDSUsers Group in csv format.
To create a new RD Session Host
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.
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
Update 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.
Deprecated: use FileTransferMode instead. Enable or disable the 'Allow file transfer' 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.
Enable or disable the 'Allow local to remote drag and drop' option. (deprecated)
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".
falseThe 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