EnglishFrançaisDeutschEspañolItaliano日本語한국어NederlandsPortuguês (Brasil)中文 (简体)中文 (繁體, 台灣)
Skip to main content

11 de abril de 2025

Using URIs to Configure Omnissa Horizon Client

You can use uniform resource identifiers (URIs) to create web page or email links that end users can click to start Horizon Client, connect to a server, or open a remote desktop or published application.

You create these links by constructing URIs that provide some or all the following information so that your end users do not need to supply it.

  • Server address
  • Port number for the server
  • Active Directory user name
  • Domain name
  • Remote desktop or published application display name
  • Window size
  • Actions including reset, log out, and start session
  • Display protocol

To use URIs to start Horizon Client, Horizon Client must already be installed on client computers.

Supported Queries

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 guide document for each type of client system for the list of supported queries.

  • action
    The following values can be used with the action query.

    ValueDescription
    browseDisplays 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.
    start-sessionOpens 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.
    restartShuts 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.
    logoffLogs 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."

  • args

    Specifies command-line arguments to add when the published application starts. Use the syntax args=value, where 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.

  • appProtocol

    For published applications, valid values are PCOIP and BLAST. For example, to specify PCoIP, use the syntax appProtocol=PCOIP.

  • desktopLayout

    Sets the size of the remote desktop window. To use this query, you must set the action query to start-session or not have an action query.

    The following values can be used for the desktopLayout query.

    ValueDescription
    fullscreenFull screen on one monitor. This value is the default.
    multimonitorFull screen on all monitors.
    windowLargeLarge window.
    windowSmallSmall window.
    WxHCustom resolution, where you specify the width by height, in pixels. An example of the syntax is desktopLayout=1280x800.

  • desktopProtocol

    For remote desktops, valid values are RDP, PCOIP, and BLAST. For example, to specify PCoIP, use the syntax desktopProtocol=PCOIP.

  • domainName

    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.

  • launchMinimized

    Starts Horizon Client in minimized mode. The Horizon Client window remains minimized and hidden in the background while the user-specified remote desktop or published application starts. The syntax is launchMinimized=true. The default value is false.

  • useExisting

    If this option is set to true, only one Horizon Client instance can run. If users try to connect to a second server, they must log out of the first server, causing remote desktop and published application sessions to be disconnected. If this option is set to false, multiple Horizon Client instances can run and users can connect to multiple servers at the same time. The default is true. An example of the syntax is useExisting=false.

  • unauthenticatedAccessEnabled

    • If this option is set to true, the Unauthenticated Access feature is activated. The File > Unauthenticated Access setting is visible in the user interface and is selected.
    • If this option is set to false, the Unauthenticated Access feature is deactivated. The File > Unauthenticated Access setting is visible in the user interface and is deselected.
    • If this option is set to "", the Unauthenticated Access feature is deactivated and the File > Unauthenticated Access setting is visible in the user interface and is deselected. An example of the syntax is unauthenticatedAccessEnabled=true.

  • unauthenticatedAccessAccount

    If the Unauthenticated Access feature is activated, sets the account to use. If Unauthenticated Access is deactivated, then this query is ignored. An example of the syntax using the anonymous1 user account is unauthenticatedAccessAccount=anonymous1.

Examples of URIs

You can use the 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.

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

  1. [URI scheme]://horizon.mycompany.com/Primary%20Desktop?action=start-session

    Horizon Client starts and connects to the horizon.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 Command-Line Interface and Configuration Files.

  2. [URI scheme]://horizon.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 Horizon 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.

  3. [URI scheme]://fred@horizon.mycompany.com/Finance%20Desktop?desktopProtocol=PCOIP

    Horizon Client starts and connects to the horizon.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.

  4. [URI scheme]://horizon.mycompany.com/Calculator?action=start-session&appProtocol=BLAST

    Horizon Client starts and connects to the horizon.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 Omnissa Horizon Blast display protocol.

  5. [URI scheme]://fred@horizon.mycompany.com/Finance%20Desktop?domainName=mycompany

    Horizon Client starts and connects to the horizon.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.

  6. [URI scheme]://horizon.mycompany.com/

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

  7. [URI scheme]://horizon.mycompany.com/Primary%20Desktop?action=reset

    Horizon Client starts and connects to the horizon.mycompany.com server. The login dialog box prompts the user for a user name, domain name, and password. After a successful login, Horizon Client resets the specified desktop.

    Note: This action is available only if an administrator has activated the reset feature for the remote desktop.

  8. [URI scheme]://horizon.mycompany.com/Primary%20Desktop?action=restart

    Horizon Client starts and connects to the horizon.mycompany.com server. The login dialog box prompts the user for a user name, domain name, and password. After a successful login, Horizon Client restarts the specified desktop.

    Note: This action is available only if an administrator has activated the restart feature for the remote desktop.

  9.  [URI scheme]://

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

  10. [URI scheme]://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.

  11. [URI scheme]://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.

  12. [URI scheme]://horizon.mycompany.com/Notepad?unauthenticatedAccessEnabled=true&unauthenticatedAccessAccount=anonymous1

    Horizon Client starts and connects to the horizon.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="[URI scheme]://horizon.mycompany.com/Primary%20Desktop?action=start-session">Test Link</a><br>

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

</body>
</html>

Esta página foi útil?

Enviar feedback sobre este tópico

Este tópico foi útil?

Não inclua informações pessoais ou confidenciais.

Gerando o link…