This article describes the command-line parameters that you can use to install or bypass optional features for Horizon Agent on a Linux desktop. You specify these parameters when running the appropriate Horizon Agent setup script in a terminal window.

Running the Horizon Agent Setup Script

In a terminal window, run the appropriate setup script for your Linux distribution. Use the script format described in the following table.

Operating System Horizon Agent Setup Script
RHEL 8.x
sudo /usr/lib/vmware/viewagent/bin/ViewSetup.sh -optional parameter [parameter argument] . . .
All other Linux distributions
sudo ./install_viewagent.sh -optional parameter [parameter argument] . . .

Command-line Options for Horizon Agent Setup Scripts

Unless otherwise specified, both the install_viewagent.sh and ViewSetup.sh scripts include the following optional parameters.

Table 1. Horizon Agent Optional Parameters
Optional Parameters Description
--force

Force the installation of Horizon Agent on a Linux operating system that is outside the list of supported operating systems described in System Requirements for Horizon Agent for Linux. By default, this parameter is not included.

Note: This parameter is available for the install_viewagent.sh script only. Horizon feature support might be limited when running Horizon Agent on an unsupported operating system.

--help

-h

Display help information and complete parameters list for the script.

--multiple-session

Enable support for multi-session published desktop pools and published application pools based on a farm that includes the Linux virtual machine. By default, this parameter is not included.

  • To prepare the machine for use in an automated instant-clone farm, include the --multiple-session parameter in the installation script. For example:
    sudo ./install_viewagent.sh --multiple-session
    sudo /usr/lib/vmware/viewagent/bin/ViewSetup.sh --multiple-session
  • To prepare the machine for use in a manual farm, include both the --multiple-session parameter and the managed agent -M parameter set to no. For example:
    sudo ./install_viewagent.sh --multiple-session -M no 
    sudo /usr/lib/vmware/viewagent/bin/ViewSetup.sh --multiple-session  -M no
-a yes|no Install or bypass audio input redirection support. Default is no.
-b Hostname or IP address of the Horizon Connection Server. This parameter is only supported when you install Horizon Agent in unmanaged mode.
-d Domain name of the Horizon Connection Server administrator. This parameter is only supported when you install Horizon Agent in unmanaged mode.
-f yes|no Install or bypass support of the cryptographic modules designed for Federal Information Processing Standards (FIPS) 140-2. Default is no. For more information, see the FIPS 140-2 Mode description in Features of Horizon Linux Desktops.
-j JMS SSL keystore password. By default, installer generates a random string.
-k Active Directory address of the Horizon Connection Server administrator. This parameter is only required for Kerberos authentication and is only supported when you install Horizon Agent in unmanaged mode.
-m yes|no Install or bypass the smart card redirection feature. Default is no.
-n Name of the Linux machine. This parameter is only supported when you install Horizon Agent in unmanaged mode. Default is hostname.
-p Administrator password for the Horizon Connection Server. This parameter is only supported when you install Horizon Agent in unmanaged mode.
-r yes|no Restart the system automatically after installation. Default is no.
-s Common Name (CN) of the self-signed certificate for VMwareBlastServer. Default is Blast. This parameter is only supported when you install Horizon Agent in unmanaged mode
-u User name of the Horizon Connection Server administrator. This parameter is only supported when you install Horizon Agent in unmanaged mode.
-A yes |no

For install_viewagent.sh, automatically accept or refuse the End User License Agreement (EULA) and Federal Information Processing Standards (FIPS) statement. You must specify yes for the installation to proceed.

If you do not specify this parameter in the install_viewagent.sh script, you must manually accept the EULA and FIPS statement during the installation.

-B Domain name of the Horizon Connection Server host. This parameter is only required for Kerberos authentication when the Horizon Connection Server host and adminstrator have different domains. This parameter is only supported when you install Horizon Agent in unmanaged mode.
-C yes|no Install or bypass Clipboard Redirection support. Default is yes.
-F yes|no Install or bypass Client Driver Redirection (CDR) support. Default is yes.
-K Active Directory address of the Horizon Connection Server host. This parameter is only required for Kerberos authentication when the Horizon Connection Server host and adminstrator have different domains. This parameter is only supported when you install Horizon Agent in unmanaged mode.
-M yes|no

Install Horizon Agent in managed or unmanaged mode. Default is yes.

When you install Horizon Agent in managed mode, the Linux machine is managed by the vCenter Server instance associated with the Horizon Connection Server.

When you install Horizon Agent in unmanaged mode, the Linux machine is not managed by the vCenter Server instance associated with the Horizon Connection Server.

-P yes|no Install or bypass Printer Redirection support. Default is yes.
-R Register the Linux machine with the Horizon Connection Server host. Use this parameter to perform a new registration or to re-register a machine after changing between managed and unmanaged modes.
-S yes|no Install or bypass single sign-on (SSO) support. Default is yes.
-T yes|no Install or bypass True Single Sign-on (True SSO) support. Default is no.
-U yes|no Install or bypass USB Redirection support. Default is no.
Table 2. Examples of Horizon Agent Setup Scripts with Parameters
Scenario Example Script
Perform fresh installation and automatically accept the EULA and FIPS statement
sudo ./install_viewagent.sh -A yes
Enable smart card redirection
sudo ./install_viewagent.sh -A yes -m yes
sudo /usr/lib/vmware/viewagent/bin/ViewSetup.sh -m yes
Bypass SSO support
sudo ./install_viewagent.sh -S no
sudo /usr/lib/vmware/viewagent/bin/ViewSetup.sh -S no
Enable support for published desktop pools and application pools based on an automated instant-clone farm
sudo ./install_viewagent.sh --multiple-session
sudo /usr/lib/vmware/viewagent/bin/ViewSetup.sh --multiple-session
Enable support for published desktop pools and application pools based on a manual farm
sudo ./install_viewagent.sh --multiple-session -M no
sudo /usr/lib/vmware/viewagent/bin/ViewSetup.sh --multiple-session -M no