The syntax of the vmware-view command controls the operation of Horizon Client.

Use the following form of the vmware-view command from a Windows command prompt.

vmware-view [command_line_option [argument]] ...

The default path to the vmware-view command executable file depends on your system.

  • On 32-bit systems, the path is C:\Program Files\VMware\VMware Horizon View Client\.

  • On 64-bit systems, the path is C:\Program Files (x86)\VMware\VMware Horizon View Client\.

For your convenience, add this path to your PATH environment variable.

The following table shows the command-line options that you can use with the vmware-view command.

Table 1. Horizon Client Command-Line Options

Option

Description

/?

Displays the list of command options.

-appName application_name

Specifies the name of the application as it would appear in the desktop and application selection window. This is the display name that was specified for the application pool in the pool creation wizard.

-appSessionReconnectionBehavior argument

Specifies the application reconnection behavior setting.

  • always implements Reconnect automatically to open applications

  • never implements Do not ask to reconnect and do not automatically reconnect

  • ask implements Ask to reconnect to open applications

When you use this option, the application reconnection settings are disabled on the Settings page in Horizon Client.

-args argument

Specifies command-line arguments to add to remote application launch. For example: vmware-view.exe --serverURL 10.10.10.10 --appName "My Notepad++" --args "\"my new.txt\""

-connectUSBOnStartup

When set to true, redirects all USB devices to the desktop that are currently connected to the host. This option is implicitly set if you specify the -unattended option. The default is false.

-connectUSBOnInsert

When set to true, connects a USB device to the foreground desktop when you plug in the device. This option is implicitly set if you specify the -unattended option. The default is false.

-desktopLayout window_size

Specifies how to display the window for the desktop:

fullscreen

Full-screen display.

multimonitor

Multiple-monitor display.

windowLarge

Large window.

windowSmall

Small window.

length X width

Custom size. For example: 800 X 600

-desktopName desktop_name

Specifies the name of the desktop as it would appear in the desktop and application selection window. This is the display name that was specified for the pool in the pool creation wizard.

Important:

Do not specify this option for clients in kiosk mode. This option has no effect when in the desktop is run in kiosk mode. For kiosk mode, the connection is made to the first desktop in the list of entitled desktops.

-desktopProtocol protocol

Specifies the display protocol to use as it would appear in the desktop and application selection window. The display protocol can be Blast, PCoIP, or RDP.

-domainName domain_name

Specifies the NETBIOS domain that the end user uses to log in to Horizon Client. For example, you would use mycompany rather than mycompany.com.

-file file_path

Specifies the path of a configuration file that contains additional command options and arguments. See Horizon Client Configuration File.

-h

Shows help options.

-hideClientAfterLaunchSession

When set to true, hides the remote desktop and application selector window and the Show VMware Horizon Client menu after launching a remote session. When set to false, shows the remote desktop and application selector window and the Show VMware Horizon Client menu after launching a remote session. The default is true.

-languageId Locale_ID

Provides localization support for different languages in Horizon Client. If a resource library is available, specify the Locale ID (LCID) to use. For US English, enter the value 0x409.

-listMonitors

Lists index values and display layout information for the connected monitors. For example:

1: (0, 0, 1920, 1200)
2: (1920, 0, 3840, 1200)
3: (-900, -410, 0, 1190)

You can use the index values in the -monitors option.

-logInAsCurrentUser

When set to true, uses the credential information that the end user provides when logging in to the client system to log in to the View Connection Server instance and ultimately to the View desktop. The default is false.

-monitors "n[,n,n,n]"

Specifies monitors to use in a multiple-monitor setup, where n is the index value of a monitor. You can use the -listMonitors option to determine the index values of the connected monitors. You can specify up to four index values, separated by commas. For example: -monitors "1,2"

This option has no effect unless -desktopLayout is set to multimonitor.

-nonInteractive

Suppresses error message boxes when starting Horizon Client from a script. This option is implicitly set if you specify the -unattended option.

-noVMwareAddins

Prevents loading of VMware-specific virtual channels such virtual printing.

-password password

Specifies the password that the end user uses to log in to Horizon Client. The password is processed in plain text by the command console or any scripting tool. You do not need to specify this option for clients in kiosk mode if you generate the password automatically. For improved security, it is recommended that you do not specify this option. Users can enter the password interactively.

-printEnvironmentInfo

Displays the IP address, MAC address, and machine name of the client device.

-serverURL connection_server

Specifies the URL, IP address, or FQDN of the View Connection Server instance.

-shutdown

Shuts down all desktops and applications and relevant UI components.

-singleAutoConnect

Specifies that if the user is entitled to only one remote desktop or application, after the user authenticates to the server, the desktop or application is automatically connected and the user is logged in. This setting spares the user from having to select the desktop or application from a list that contains only one item.

-smartCardPIN PIN

Specifies the PIN when an end user inserts a smart card to login.

-usernameHint user_name

Specifies the account name to use as the username hint.

-standalone

Supported for backwards compatibility purposes. This is the default behavior for this client. Specifying -standalone is not necessary. Launches a second instance of the Horizon Client that can connect to the same or a different View Connection Server.

For multiple desktop connections to the same server or to a different server, using the secure tunnel is supported.

Note:

The second desktop connection might not have access to local hardware, such as USB devices, smart, cards, printers, and multiple monitors.

-supportText file_name

Specifies the full path of a text file. The content of the file is displayed in the Support Information dialog.

-unattended

Runs Horizon Client in a noninteractive mode that is suitable for clients in kiosk mode. You must also specify:

  • The account name of the client, if you did not generate the account name from the MAC address of the client device. The name must begin with the string “custom-” or an alternate prefix that you have configured in ADAM.

  • The password of the client, if you did not generate a password automatically when you set up the account for the client.

The -unattended option implicitly sets the -nonInteractive, -connectUSBOnStartup, -connectUSBOnInsert , and -desktopLayout multimonitoroptions.

-useExisting

Enables you to launch multiple remote desktops and applications from a single Horizon Client session.

When you specify this option, Horizon Client determines whether a session with the same username, domain, and server URL already exists and, if it does, reuses that session instead of creating a new session.

For example, in the following command, user-1 launches the Calculator application and a new session is created.

vmware-view.exe -userName user-1 -password secret 
-domainName domain -appName Calculator 
-serverURL view.mycompany.com -useExisting

In the next command, user1 launches the Paint application with the same username, domain, and server URL, and the same session is used.

vmware-view.exe -userName user-1 -password secret 
-domainName domain -appName Paint 
-serverURL view.mycompany.com -useExisting

-userName user_name

Specifies the account name that the end user uses to log in to Horizon Client. You do not need to specify this option for clients in kiosk mode if you generate the account name from the MAC address of the client device.

You can specify all options by Active Directory group policies except for -file, -languageId, -printEnvironmentInfo, -smartCardPIN, and -unattended.

Note:

Group policy settings take precedence over settings that you specify in the command line.