You can use the vmware-view URI scheme to create hypertext links or buttons and include these links in email or on a Web page. For example, an end user can click a URI link to start a remote desktop with the startup options that you specify.

URI Syntax Examples

Each URI example is followed by a description of what the end user sees after clicking the URI link.

  1. vmware-view://view.mycompany.com/Primary%20Desktop?action=start-session

    Horizon Client starts and connects to the view.mycompany.com server. The login dialog box prompts the user for a user name, domain name, and password. After a successful login, the client connects to the remote desktop that has the display name Primary Desktop, and the user is logged in to the guest operating system.

    Note: In this example, the default display protocol and window size are used. The default display protocol is PCoIP and the default window size is full screen.

    You can change the defaults. See Using the vmware-view Command-Line Interface and Configuration Files.

  2. vmware-view://view.mycompany.com/cn%3Dwin7-32%2Cou%3Dapplications%2Cdc%3Dvdi%2Cdc%3Dvmware%2Cdc%3Dint

    Horizon Client starts and connects to the view.mycompany.com server. The login dialog box prompts the user for a user name, domain name, and password. After a successful login, the client connects to the remote desktop that has the desktop ID CN=win7-32,OU=Applications,DC=vdi,DC=vmware,DC=int (encoded value cn%3Dwin7-32%2Cou%3Dapplications%2Cdc%3Dvdi%2Cdc%3Dvmware%2Cdc%3Dint).

  3. vmware-view://view.mycompany.com:7555/Primary%20Desktop

    This URI has the same effect as the previous example, except that it uses the nondefault port of 7555 for the Connection Server instance. (The default port is 443.) Because a remote desktop identifier is provided, the remote desktop opens, even though the start-session action is not included in the URI.

  4. vmware-view://[email protected]/Finance%20Desktop?desktopProtocol=PCOIP

    Horizon Client starts and connects to the view.mycompany.com server. In the login dialog box, the User name text box is populated with fred. The user must supply the domain name and password. After a successful login, the client connects to the remote desktop that has the display name Finance Desktop, and the user is logged in to the guest operating system. The connection uses the PCoIP display protocol.

  5. vmware-view://view.mycompany.com/Calculator?action=start-session&appProtocol=BLAST

    Horizon Client starts and connects to the view.mycompany.com server. In the login dialog box, the user must supply the user name, domain name, and password. After a successful login, the client connects to the published application that has the display name Calculator. The connection uses the VMware Blast display protocol.

  6. vmware-view://[email protected]/Finance%20Desktop?domainName=mycompany

    Horizon Client starts and connects to the view.mycompany.com server. In the login dialog box, the User name text box is populated with fred, and the Domain text box is populated with mycompany. The user must supply only a password. After a successful login, the client connects to the remote desktop that has the display name Finance Desktop, and the user is logged in to the guest operating system.

  7. vmware-view://view.mycompany.com/

    Horizon Client starts and the user is taken to the login prompt for connecting to the view.mycompany.com server.

  8. vmware-view://view.mycompany.com/Primary%20Desktop?action=reset

    Horizon Client starts and connects to the view.mycompany.com server. The login dialog box prompts the user for a user name, domain name, and password. After a successful login, Horizon Client shows a dialog box that prompts the user to confirm the reset operation for Primary Desktop.

    Note: This action is available only if a Horizon administrator has enabled the reset feature for the remote desktop.
  9. vmware-view://view.mycompany.com/Primary%20Desktop?action=restart

    Horizon Client starts and connects to the view.mycompany.com server. The login dialog box prompts the user for a user name, domain name, and password. After a successful login, Horizon Client shows a dialog box that prompts the user to confirm the restart operation for Primary Desktop.

    Note: This action is available only if a Horizon administrator has enabled the restart feature for the remote desktop.
  10. vmware-view://

    Horizon Client starts and the user is taken to the page for entering the address of a server.

  11. vmware-view://10.10.10.10/My%20Notepad++?args=%22My%20new%20file.txt%22

    Starts My Notepad++ on server 10.10.10.10 and passes the argument My new file.txt in the published application start command. The filename is enclosed in double quotes because it contains spaces.

  12. vmware-view://10.10.10.10/Notepad++%2012?args=a.txt%20b.txt

    Starts Notepad++ 12 on server 10.10.10.10 and passes the argument a.text b.txt in the published application start command. Because the argument is not enclosed in quotes, a space separates the filenames and the two files are opened separately in Notepad++.

    Note: Published applications can differ in the way that they use command-line arguments. For example, if you pass the argument a.txt b.txt to WordPad, WordPad opens only one file, a.txt.
  13. vmware-view://view.mycompany.com/Notepad?unauthenticatedAccessEnabled=true&unauthenticatedAccessAccount=anonymous1

    Horizon Client starts and connects to the view.mycompany.com server using the anonymous1 user account. The Notepad application starts without prompting the user to provide login credentials.

HTML Code Examples

You can use URIs to make hypertext links and buttons to include in emails or on Web pages. The following examples show how to use the URI from the first URI example to code the hypertext link labeled Test Link and a button labeled TestButton.

<html>
<body>

<a href="vmware-view://view.mycompany.com/Primary%20Desktop?action=start-session">Test Link</a><br>

<form><input type="button" value="TestButton" onClick="window.location.href=
'vmware-view://view.mycompany.com/Primary%20Desktop?action=start-session'"></form> <br>

</body>
</html>