For your convenience, almost all configuration settings have both a key=value property and a corresponding command-line option name. For a few settings, there is a command-line option but no corresponding property you can set in a configuration file. For a few other settings, you must set a property because no command-line option is available.

Important:

Some command-line options and configuration keys are available only with the version of Horizon Client provided by third-party vendors. For more information about VMware thin-client and zero-client partners, see the VMware Compatibility Guide at http://www.vmware.com/resources/compatibility/search.php?deviceCategory=vdm.

Table 1. Horizon Client Command-Line Options and Configuration File Keys

Configuration Key

Command-Line Option

Description

view.allMonitors

--allmonitors

Hides the host operating system and opens the Horizon Client user interface in full screen mode on all monitors that are connected when the client is launched.

If you are setting the configuration key, specify "TRUE" or "FALSE". Default is "FALSE".

view.allowDefaultBroker

-l, --lockServer

Using this command-line option, or setting the property to "FALSE", disables the Server field unless the client has never connected to any server, and no server address is provided in the command line or the preferences file.

Example of using the command-line option:

--lockServer -s view.company.com

view.autoConnectBroker

None

Automatically connects to the last View server used unless the view.defaultBroker configuration property is set or unless the --serverURL= command-line option is used.

Specify "TRUE" or "FALSE". Default is "FALSE".

Setting this property and the view.autoConnectDesktop property to "TRUE" is the equivalent of setting the view.nonInteractive property to "TRUE".

view.autoConnectDesktop

None

Automatically connects to the last View desktop used unless the view.defaultDesktop configuration property is set or unless the --desktopName= command-line option is used.

Specify "TRUE" or "FALSE". Default is "FALSE".

Setting this property and the view.autoConnectBroker property to "TRUE" is the equivalent of setting the view.nonInteractive property to "TRUE".

view.autoDisconnectEmptyAppSession

None

When set to "TRUE" (the default), if the application session becomes empty because the user quits all applications, a message is displayed to the end user. This message prompts the user to choose between disconnecting the empty session or keeping the empty session running. If set to "FALSE", the session is closed according to the timeout setting used in View Administrator, which by default would be to disconnect after one minute.

view.defaultAppHeight

None

Specifies the default height of the window for remote applications, in pixels. Use this property in conjunction with view.defaultAppWidth when specifying a custom desktop size (view.defaultAppSize property is set to "5"). Default is "480".

view.defaultAppSize

--appSize=

Sets the default size of the window for remote applications:

  • To use all monitors, specify "1".

  • To use full screen mode on one monitor, specify "2".

  • To use a large window, specify "3".

  • To use a small window, specify "4".

  • To set a custom size, specify "5"and then also set the view.defaultAppWidth and view.defaultAppHeight properties.

Default is "1".

view.defaultAppWidth

None

Specifies the default width of the window for remote applications, in pixels. Use this property in conjunction with view.defaultAppHeight when specifying a custom desktop size (view.defaultAppSize property is set to "5"). Default is "640".

view.defaultBroker

-s, --serverURL=

Adds the name that you specify to the Server field in Horizon Client. Specify a fully qualified domain name. You can also specify a port number if you do not use the default 443.

Default is the most recently used value.

Examples of using the command-line option:

--serverURL=https://view.company.com
-s view.company.com
--serverURL=view.company.com:1443

view.defaultDesktop

-n, --desktopName=

Specifies which desktop to use when autoConnectDesktop is set to "TRUE" and the user has access to multiple desktops.

This is the name you would see in the Select Desktop dialog box. The name is usually the pool name.

view.defaultDesktopHeight

None

Specifies the default height of the window for the View desktop, in pixels. Use this property in conjunction with view.defaultDesktopWidth when specifying a custom desktop size (view.defaultDesktopSize property is set to "5").

view.defaultDesktopSize

--desktopSize=

Sets the default size of the window for the View desktop:

  • To use all monitors, set the property to "1" or use the command-line argument "all".

  • To use full screen mode on one monitor, set the property to "2" or use the command-line argument "full".

  • To use a large window, set the property to "3" or use the command-line argument "large".

  • To use a small window, set the property to "4" or use the command-line argument "small".

  • To set a custom size, set the property to "5"and then also set the view.defaultDesktopWidth and view.defaultDesktopHeight properties. Alternatively, specify the width by height, in pixels, at the command-line as "widthxheight".

Examples of using the command-line option:

--desktopSize="1280x800"
--desktopSize="all"

view.defaultDesktopWidth

None

Specifies the default width of the window for the View desktop, in pixels. Use this property in conjunction with view.defaultDesktopHeight when specifying a custom desktop size (view.defaultDesktopSize property is set to "5").

view.defaultDomain

-d, --domainName=

Sets the domain name that Horizon Client uses for all connections and adds the domain name that you specify to the Domain Name field in the authentication dialog box.

view.defaultLogLevel

None

Sets the log level for Horizon Client logs. Set the property to one of the following values:

  • "0" means include all log events.

  • "1" means include trace-level events and events captured for settings 2 though 6.

  • "2" means include debug events and events captured for settings 3 through 6.

  • "3" (the default) means include info-level events and events captured for settings 4 through 6.

  • "4" means include warning, error, and fatal events.

  • "5" means include error and fatal events.

  • "6" means include fatal events.

Default is "3".

view.defaultPassword

-p "-", --password="-"

For VMware Blast, PCoIP, and rdesktop connections, always specify "-" to read the password from stdin.

Sets the password that Horizon Client uses for all connections and adds the password to the Password field in the authentication dialog box if View Connection Server accepts password authentication.

Note:

You cannot use a blank password. That is, you cannot specify --password=""

view.defaultProtocol

--protocol=

Specifies which display protocol to use. Specify "PCOIP" or "RDP". These values are case-sensitive. For example, if you enter rdp the protocol used will be the default. Default is the setting specified in View Administrator, under pool settings for the pool.

If you use RDP and you want to use FreeRDP rather than rdesktop, you must also use the rdpClient setting.

view.defaultUser

-u, --userName=

Sets the user name that Horizon Client uses for all connections and adds the user name that you specify to the User Name field in the authentication dialog box.

For kiosk mode, the account name can be based on the client's MAC address, or it can begin with a recognized prefix string, such as custom-.

view.disableMaximizedApp

--disableMaximizedApp

If set to "FALSE" (the default), the application is launched in full screen mode.

view.enableMMR

None

Enables multimedia redirection (MMR).

Specify "TRUE" or "FALSE". Default is "FALSE".

view.fullScreen

--fullscreen

Hides the host operating system and opens the Horizon Client user interface in full screen mode on one monitor. This option does not affect the screen mode of the desktop session.

If you are setting the configuration key, specify "TRUE" or "FALSE". Default is "FALSE".

view.kbdLayout

-k, --kbdLayout=

Specifies which locale to use for the keyboard layout.

Note:

rdesktop uses locale codes, such as "fr" and "de", whereas freerdp uses keyboard layout IDs. For a list of these IDs, use the following command:

xfreerdp --kbd-list

Example of using the command-line option for rdesktop:

--kbdLayout="en-us"
-k "fr"

Example of using the command-line option for freerdp:

-k "0x00010407"

view.kioskLogin

--kioskLogin

Specifies that Horizon Client is going to authenticate using a kiosk mode account.

If you are setting the configuration key, specify "TRUE" or "FALSE". Default is "FALSE".

For examples, see the kiosk mode example that follows this table.

view.mmrPath

-m, --mmrPath=

(Available only with distributions from third-party vendors) Specifies the path to the directory that contains the Wyse MMR (multimedia redirection) libraries.

Example of using the command-line option:

--mmrPath="/usr/lib/altmmr"

view.monitors

--monitors= numbered list

Allows you to specify which adjacent monitors to use for Horizon Client. Use --allmonitors (or view.allMonitors) to specify that you want to use full screen on all monitors, and use --monitors=numbered list to specify which subset of the monitors to use.

Example of using the command-line option to specify the first and second monitors in a configuration where 3 monitors are set next to each other horizontally:

--allmonitors --monitors="1,2" `

To help distinguish which physical monitor is associated with a monitor icon in the client UI, a rectangle is displayed at the top left corner of the physical monitor you had specified to use. The rectangle has the corresponding color and number that is used in the icon for the chosen monitor.

view.noMenuBar

--nomenubar

Suppresses the Horizon Client menu bar when the client is in full screen mode, so that users cannot access menu options to log off of, reset, or disconnect from a View desktop. Use this option when configuring kiosk mode.

If you are setting the configuration key, specify "TRUE" or "FALSE". Default is "FALSE".

view.nonInteractive

-q, --nonInteractive

Hides unnecessary UI steps from end users by skipping the screens that are specified in the command line or configuration properties.

If you are setting the configuration key, specify "TRUE" or "FALSE". Default is "FALSE".

Setting this property to "TRUE" is the equivalent of setting the view.autoConnectBroker and view.autoConnectDesktop properties to "TRUE".

Example of using the command-line option:

--nonInteractive
--serverURL="https://view.company.com" 
--userName="user1" --password="-" 
--domainName="xyz" 
--desktopName="Windows 7" 

view.once

--once

Specifies that you do not want Horizon Client to retry connecting in the case of an error occurring.

You should usually specify this option if you use kiosk mode, and use the exit code to handle the error. Otherwise, you might find it difficult to kill the vmware-view process remotely.

If you are setting the configuration key, specify "TRUE" or "FALSE". Default is "FALSE".

view.rdesktopOptions

--rdesktopOptions=

(Available if you use the Microsoft RDP display protocol) Specifies command-line options to forward to the rdesktop application. For information about rdesktop options, see the rdesktop documentation.

Example of using the command-line option:

--rdesktopOptions="-f -m"

None

-r, --redirect=

(Available if you use the Microsoft RDP display protocol) Specifies a local device that you want rdesktop to redirect to the View desktop.

Specify the device information that you want to pass to the -r option of rdesktop. You can set multiple device options in a single command.

Example of using the command-line option:

--redirect="sound:off"

view.rdpClient

--rdpclient=

(Available if you use the Microsoft RDP display protocol) Specifies which type of RDP client to use. The default is rdesktop. To use FreeRDP instead, specify xfreerdp.

Note:

To use FreeRDP, you must have the correct version of FreeRDP installed, along with any applicable patches. For more information, see Install and Configure FreeRDP.

None

--save

Saves the user name and domain name that were last used to successfully log in so that you do not need to enter the user name or domain name the next time you are prompted to supply login credentials.

view.sendCtrlAltDelToLocal

None

(Available if you use the VMware Blast or PCoIP display protocol) When set to "TRUE", sends the key combination Ctrl+Alt+Del to the client system rather than opening a dialog box to prompt the user to disconnect from the View desktop. Default is "FALSE".

Note:

If you use the Microsoft RDP display protocol, you can achieve this functionality by using the -K option; for example, vmware-view -K.

This option has the same priority as the setting in the /etc/vmware/view-keycombos-config file.

view.sendCtrlAltDelToVM

None

(Available if you use the VMware Blast or PCoIP display protocol) When set to "TRUE", sends the key combination Ctrl+Alt+Del to the virtual desktop rather than opening a dialog box to prompt the user to disconnect from the View desktop. Default is "FALSE".

This option has a higher priority than the setting in the /etc/vmware/view-keycombos-config file.

view.sendCtrlAltInsToVM

None

(Available if you use the VMware Blast or PCoIP display protocol) When set to "TRUE", sends the key combination Ctrl+Alt+Ins to the virtual desktop rather than sending Ctrl+Alt+Del. Default is "FALSE".

Note:

To use this feature, you must also set the agent-side GPO policy called "Use alternate key for sending Secure Attention Sequence," available in the pcoip.adm template. See the topic called "PCoIP Keyboard Settings" in the "Configuring Policies for Desktop and Application Pools" chapter of the Configuring Remote Desktop Features in Horizon 7 document.

This option has a lower priority than the setting in the /etc/vmware/view-keycombos-config file.

view.shareRemovableStorage

None

When set to "TRUE", enables the Allow access to removable storage option. Default is "TRUE".

view.sslCipherString

--sslCipherString=

Configures the cipher list to restrict the use of certain cryptographic algorithms before establishing an encrypted SSL connection.

For a list of cipher strings, see http://www.openssl.org/docs/apps/ciphers.html .

The default for Horizon Client is "!aNULL:kECDH+AESGCM:ECDH+AESGCM:RSA+AESGCM:kECDH+AES:ECDH+AES:RSA+AES".

view.sslProtocolString

--sslProtocolString=

Configures the cipher list to restrict the use of certain cryptographic protocols before establishing an encrypted SSL connection.

The supported protocols are SSLv3/SSLv3.0, TLSv1.0/TLSv1, TLSv1.1, and TLSv1.2. The cipher list consists of one or more protocol strings separated by colons. The strings are not case-sensitive.

The default is "TLSv1.0:TLSv1.1:TLSv1.2".

view.sslVerificationMode

None

Sets the server certificate verification mode.

Specify "1" to reject connections when the certificate fails any of the verification checks, "2" to warn but allow connections that use a self-signed certificate, or "3" to allow unverifiable connections. If you specify "3" no verification checks are performed. Default is "2".

view.UnauthenticatedAccessEnabled

--unauthenticatedAccessEnabled

When set to "TRUE", the Unauthenticated Access feature is enabled by default. The Log in anonymously using Unauthenticated Access setting is visible in the user interface and is marked as selected.

When set to "FALSE", the Unauthenticated Access feature is disabled. The Log in anonymously using Unauthenticated Access setting is hidden and deselected.

When set to "", the Unauthenticated Access feature is disabled, and the Log in anonymously using Unauthenticated Access setting is visible from the user interface and deselected.

If you are setting the configuration key, specify "TRUE" or "FALSE".

Examples for using the command-line option:

 --unauthenticatedAccessEnabled="TRUE"

view.UnauthenticatedAccessAccount

--unauthenticatedAccessAccount

Specifies the account to use when unauthenticatedAccessEnabled is set to "TRUE".

If the unauthenticatedAccessEnabled is set to "FALSE", then this configuration is ignored.

Example for using the command-line option with the anonymous1 user account:

--unauthenticatedAccessAccount='anonymous1'

view.usbAutoConnectAtStartup

—-usbAutoConnectAtStartUp=

Automatically redirects USB devices to a Horizon desktop if the USB devices were inserted into the host system before the desktop is connected. This option does not apply to remote applications.

Specify "TRUE" or "FALSE". Default is "TRUE".

view.usbAutoConnectOnInsert

-—usbAutoConnectOnInsert=

Automatically redirects USB devices to a Horizon desktop when the USB devices are inserted into the host system after the desktop is connected. This option does not apply to remote applications.

Specify "TRUE" or "FALSE". Default is "TRUE".

view.xfreerdpOptions

--xfreerdpOptions=

(Available if you use the Microsoft RDP display protocol) Specifies command-line options to forward to the xfreerdp program. For information about xfreerdp options, see the xfreerdp documentation.

Note:

To use FreeRDP, you must have the correct version of FreeRDP installed, along with any applicable patches. For more information, see Install and Configure FreeRDP.

None

--enableNla

(Applies if you are using FreeRDP for RDP connections) Enables network-level authentication (NLA). You must use this option in conjunction with the --ignore-certificate option. For more information, see Using FreeRDP for RDP Connections.

NLA is turned off by default if you are using FreeRDP.

You must have the correct version of FreeRDP installed, along with any applicable patches. For more information, see Install and Configure FreeRDP.

Note:

The rdesktop program does not support NLA.

None

--printEnvironmentInfo

Displays information about the environment of a client device, including its IP address, MAC address, machine name, and domain name.

For kiosk mode, you can create an account for the client based on the MAC address. To display the MAC address, you must use this option with the -s option.

Example of using the command-line option:

--printEnvironmentInfo 
-s view.company.com

None

--usb=

Specifies which options to use for USB redirection. See System Requirements for USB Redirection.

None

--version

Displays version information about Horizon Client.

Kiosk Mode Example

Kiosk users might include customers at airline check-in stations, students in classrooms or libraries, medical personnel at medical data entry workstations, or customers at self-service points. Accounts are associated with client devices rather than users because users do not need to log in to use the client device or the View desktop. Users can still be required to provide authentication credentials for some applications.

To set up kiosk mode, you must use the vdmadmin command-line interface on the View Connection Server instance and perform several procedures documented in the chapter about kiosk mode in the View Administration document. After you set up kiosk mode, you can use the vmware-view command on a Linux client to connect to a View desktop in kiosk mode.

To connect to View desktops from Linux clients in kiosk mode, you must, at a minimum, include the following configuration keys or command-line options.

Configuration Key

Equivalent Command-line Options

view.kioskLogin

--kioskLogin

view.nonInteractive

-q, --nonInteractive

view.fullScreen

--fullscreen

view.noMenuBar

--nomenubar

view.defaultBroker

-s, --serverURL=

Omitting any of these configuration settings is not supported for kiosk mode. If View Connection Server is set up to require a non-default kiosk user name, you must also set the view.defaultUser property or use the -u or --userName= command-line option. If a non-default user name is not required and you do not specify a user name, Horizon Client can derive and use the default kiosk user name.

Note:

If you set the view.sslVerificationMode configuration key, be sure to set it in the /etc/vmware/view-mandatory-config file. When the client runs in kiosk mode, the client does not look in the view-preferences file.

The command shown in this example runs Horizon Client on a Linux client system and has the following characteristics:

  • The user account name is based on the client's MAC address.

  • Horizon Client runs in full screen mode without a Horizon Client menu bar.

  • Users are automatically connected to the specified View Connection Server instance and View desktop and are not prompted for login credentials.

  • If a connection error occurs, depending on the error code returned, a script might run or a kiosk monitoring program might handle the error. As a result, for example, the client system might display an out-of-order screen or might wait a certain amount of time before attempting to connect to View Connection Server again.

./vmware-view --kioskLogin --nonInteractive --once --fullscreen --nomenubar 
--serverURL="server.mycomany.com" --userName="CM-00:11:22:33:44:55:66:77" --password="mypassword"
Important:

If a pre-login message has been configured to appear before allowing Horizon Client to connect to a View desktop, the user must acknowledge the message before being allowed to access the desktop. To avoid this issue, use View Administrator to disable pre-login messages.