URI syntax includes the vmware-view URI scheme, a path part to specify the remote desktop or published application, and, optionally, a query to specify remote desktop or published application actions or configuration options.
Use the following syntax to create URIs to start Horizon Client.
The only required element is the URI scheme, vmware-view. Because the scheme name is case-sensitive for some versions of some client operating systems, type vmware-view.
For information about encoding for ASCII characters, see the URL encoding reference at http://www.utf8-chartable.de/.
The server address and, optionally, a user name, a non-default port number, or both. Underscores (_) are not supported in server names. Server names must conform to DNS syntax.
To specify a user name, use the following syntax.
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.
- The display name of the remote desktop or published application. The display name is specified in Horizon Console when the desktop pool or application pool is created. If the display name contains a space, use the %20 encoding mechanism to represent the space.
- Alternatively, you can specify a desktop or application ID, which is a path string that includes the desktop or application pool ID. To find a desktop or application ID, open ADSI Edit on the Connection Server host, navigate to DC=vdi,dc=vmware,dc=int, and select the OU=Applications node. All the desktop and application pools are listed. The distinguishedName attribute specifies the ID value. You must encode the ID value before you specify it in a URI, for example, cn%3Dwin7-32%2Cou%3Dapplications%2Cdc%3Dvdi%2Cdc%3Dvmware%2Cdc%3Dint.
Note: More than one remote desktop or published application can have the same display name, but the desktop and application ID is unique. To specify a particular remote desktop or published application, use the desktop or application ID rather than the display name.
The configuration options to use, or the remote desktop or published application actions to perform. Queries are not case-sensitive. To use multiple queries, use an ampersand (&) between the queries. If the queries conflict,
Horizon Client uses the last query in the list. Use the following syntax.
The following queries 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 installation and setup guide for each type of client system for the list of supported queries.
Table 1. Values That Can Be Used with the action Query Value Description browse Displays a list of available remote desktops and published applications hosted on the specified server. You are not required to specify a remote desktop or published application when using this action.
If you use the browse action and specify a remote desktop or published application, the remote desktop or published application is highlighted in the list of available items.
start-session Opens the specified remote desktop or published application. If no action query is provided and the remote desktop or published application name is provided, start-session is the default action. reset
Shuts down and restarts the specified remote desktop or published application. Unsaved data is lost. Resetting a remote desktop is the same as pressing the Reset button on a physical PC.
restart Shuts down and restarts the specified remote desktop. Restarting a remote desktop is the same as the Windows operating system restart command. The operating system usually prompts the user to save any unsaved data before it restarts. logoff Logs the user out of the guest operating system in the remote desktop. If you specify a published application, the action is ignored or the end user sees the warning message "Invalid URI action."
Specifies command-line arguments to add when the published application starts. Use the syntax
value is a string. Use percent encoding for the following characters:
- For a colon (:), use %3A
- For a back slash (\), use %5C
- For a space ( ), use %20
- For a double quotation mark ("), use %22
For example, to specify the filename "My new file.txt" for the Notepad++ application, use %22My%20new%20file.txt%22.
- For published applications, valid values are PCOIP and BLAST. For example, to specify PCoIP, use the syntax appProtocol=PCOIP.
- Sets the default view for when Horizon Client starts. Valid values are recent and servers.
- For remote desktops, valid values are PCOIP and BLAST. For example, to specify PCoIP, use the syntax desktopProtocol=PCOIP.
- Specifies the NETBIOS domain name associated with the user who is connecting to the remote desktop or published application. For example, you might use mycompany rather than mycompany.com.
- Specifies the RSA or RADIUS user name. Use this query only if the RSA or RADIUS user name is different from the Active Directory user name. If you do not specify this query and RSA or RADIUS authentication is required, Horizon Client uses the Windows user name. The syntax is tokenUserName=name.