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 Horizon Agent setup script in a terminal window.
Running the Horizon Agent Setup Script
In a terminal window, run the corresponding setup script for the installer format that you used to install Horizon Agent installer.
| Horizon Agent Installer Format | Horizon Agent Setup Script |
|---|---|
| RPM (.rpm) |
Note: The RPM installer and setup script are supported only on RHEL 8.x machines.
sudo /usr/lib/vmware/viewagent/bin/ViewSetup.sh -optional parameter [parameter argument] . . . |
| Tarball (.tar.gz) | sudo ./install_viewagent.sh -optional parameter [parameter argument] . . . |
Command-line Options for Horizon Agent Setup Scripts
Unless otherwise noted, both the install_viewagent.sh and ViewSetup.sh scripts include the following optional parameters.
| Optional Parameters | Description |
|---|---|
| --force | Force the installation of Horizon Agent on a Linux operating system that lies outside the scope 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. |
| --ipv6 |
Enable support for running Linux desktops and applications in an IPv6 environment. By default, this parameter is not included, meaning that IPv4 support is enabled. |
| --multiple-session |
Enable support for multi-session published desktop pools and application pools based on a farm that includes the Linux virtual machine. By default, this parameter is not included.
|
| --no-hosted-app | Deactivates support for single-session application pools running on desktops based on the Linux virtual machine. By default, this parameter is not included and support for single-session application pools is activated. |
| --webcam | Enables webcam redirection. By default, this parameter is not included. For more information, see Install the Real-Time Audio-Video Feature.
Note: To install the Real-Time Audio-Video feature, you must include both the webcam redirection (
--webcam) and audio-in (
-a yes) parameters. Webcam redirection is not supported in multiple-session mode, that is, when the
--multiple-session parameter is included.
|
| -a yes|no | Install or bypass support for audio input (audio-in) redirection. Default is no.
Note: To install the Real-Time Audio-Video feature, you must include both the audio-in (
-a yes) and webcam redirection (
--webcam) parameters.
|
| -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. This option is supported only on RHEL 8.x machines.
Note: To support FIPS 140-2 mode, you must use Transport Layer Security (TLS) protocol version 1.2. You must also enable FIPS mode at the Linux system level and install a CA-signed certificate for the VMwareBlastServer daemon, as described in
Configure a FIPS-compliant Linux Virtual Machine.
|
| -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 VMware General Terms and Federal Information Processing Standards (FIPS) statement. You must specify yes to proceed with the installation. If you do not specify this parameter in the install_viewagent.sh script, you must manually accept the VMware General Terms 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 administrator have different domains. This parameter is only supported when you install Horizon Agent in unmanaged mode. |
| -C yes|no | Install or bypass the Clipboard Redirection feature. Default is yes. |
| -F yes|no | Install or bypass the Client Drive Redirection (CDR) feature. 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 administrator 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 VMware Integrated Printing, which supports client printer redirection. 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 support for single sign-on (SSO). Default is yes. |
| -T yes|no | Install or bypass the True Single Sign-on (True SSO) feature. Default is no. |
| -U yes|no | Install or bypass the USB Redirection feature. Default is no. |
| Scenario | Example Script |
|---|---|
| Perform fresh installation and automatically accept the VMware General Terms 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 |
