Syntax includes the vmware-view URI scheme, a path part to specify the desktop or application, and, optionally, a query to specify desktop or application actions or configuration options.
When you create a URI, you are essentially calling vmware-view with the full View URI string as an argument.
Use the following syntax to create URIs for launching Horizon Client:
The only required element is the URI scheme, vmware-view. For some versions of some client operating systems, the scheme name is case-sensitive. Therefore, use vmware-view.
For information about encoding for ASCII characters, see the URL encoding reference at http://www.utf8-chartable.de/.
Specifies the server address and, optionally, a user name, a non-default port number, or both. Note that underscores (_) are not supported in server names. Server names must conform to DNS syntax.
To specify a user name, use the following syntax:
Note that you cannot specify a UPN address, which includes the domain. To specify the domain, you can use the domainName query part in the URI.
To specify a port number, use the following syntax:
- Specifies the desktop or application. Use the desktop display name or application display name. This name is the one specified in View Administrator when the desktop or application pool was created. If the display name has a space in it, use the %20 encoding mechanism to represent the space.
Specifies the configuration options to use or the desktop or application actions to perform. Queries are not case-sensitive. To use multiple queries, use an ampersand (&) between the queries. If queries conflict with each other, the last query in the list is used. Use the following syntax:
This topic lists the queries that are supported for this type of Horizon Client. If you are creating URIs for multiple types of clients, such as desktop clients and mobile clients, see the Using VMware Horizon Client guide for each type of client system.
Table 1. Values That Can Be Used with the action Query Value Description browse Displays a list of available desktops and applications hosted on the specified server. You are not required to specify a desktop or application when using this action. start-session Launches the specified desktop or application. If no action query is provided and the desktop or application name is provided, start-session is the default action. reset
Shuts down and restarts the specified desktop or remote application. Unsaved data is lost. Resetting a remote desktop is the equivalent of pressing the Reset button on a physical PC. In Horizon Client 3.0, if you specify an application, the action will be ignored.
In Horizon Client 3.1, if you specify an application, the end user is prompted to confirm quitting all remote applications.
logoff Logs the user out of the guest operating system in the remote desktop. If you specify an application, the action will be ignored or the end user will see the warning message "Invalid URI action."
- For remote applications, valid values are PCOIP and BLAST. For example, to specify PCoIP, use the syntax appProtocol=PCOIP. This query is supported only in Horizon Client 4.0 and later releases. In earlier Horizon Client releases, remote applications always use PCoIP.
Sets the size of the window that displays a remote desktop. To use this query, you must set the
action query to
start-session or else not have an
Table 2. Valid Values for the desktopLayout Query Value Description fullscreen Full screen on one monitor. This is the default. multimonitor Full screen on all monitors. windowLarge Large window. windowSmall Small window. WxH Custom resolution, where you specify the width by height, in pixels. An example of the syntax is desktopLayout=1280x800.
- For remote desktops, valid values are RDP, PCOIP, and BLAST. For example, to specify PCoIP, use the syntax desktopProtocol=PCOIP. BLAST is supported only in Horizon Client 4.0 and later releases.
- The NETBIOS domain name associated with the user who is connecting to the remote desktop or application. For example, you would use mycompany rather than mycompany.com.