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.
Use the following syntax to create URIs to start 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. 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:
- Specifies the desktop or application. Use the desktop display name or application display name. This name is the one specified in Horizon 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.
If you use the browse action and specify a desktop or application, the desktop or application is highlighted in the list of available items.
start-session Opens 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. Unsaved data is lost. Resetting a remote desktop is the equivalent of pressing the Reset button on a physical PC. Specifying an application is not supported. If you specify an application, an error message appears.
If you do not specify a desktop or application, Horizon Client quits all remote applications.
restart Shuts down and restarts the specified desktop. Restarting a remote desktop is the equivalent of 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 an application, the action is ignored or the end user sees the warning message "Invalid URI action."
Specifies command-line arguments to add to remote application launch. 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 remote applications, valid values are PCOIP and BLAST. For example, to specify PCoIP, use the syntax appProtocol=PCOIP.
- Sets the default launch view for Horizon Client. 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.
- The NETBIOS domain name associated with the user who is connecting to the remote desktop or 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, the Windows user name is used. The syntax is tokenUserName=name.
- If this option is set to true, the Unauthenticated Access feature is enabled by default. If this option is set to false, the Unauthenticated Access feature is disabled. When this option is set to "", the Unauthenticated Access feature is disabled. The Log in anonymously using Unauthenticated Access option is available in the Horizon Client settings. An example of the syntax is unauthenticatedAccessEnabled=true.
- Sets the account to use if the Unauthenticated Access feature is enabled. If Unauthenticated Access is disabled, then this query is ignored. An example of the syntax using the anonymous1 user account is unauthenticatedAccessAccount=anonymous1.