Product Documentation

Install Linux Virtual Delivery Agent for SUSE

May 22, 2017

You can choose to follow the steps below for manual installation or leverage easy install for automatic installation and configuration. Easy install saves time and labor and is less error-prone than the manual installation. 

Note: Use easy install only for fresh installations. Do not use easy install to update an existing installation.

Step 1: Prepare for installation

Step 1a: Launch the YaST tool

The SUSE Linux Enterprise YaST tool is used for configuring all aspects of the operating system.

To launch the text-based YaST tool:

command Copy

su -

yast

Alternatively, launch the UI-based YaST tool:

command Copy

su -

yast2 &

Step 1b: Configure networking

The following sections provide information on configuring the various networking settings and services used by the Linux VDA. Configuring networking should be carried out via the YaST tool, not via other methods such as Network Manager. These instructions are based on using the UI-based YaST tool; the text-based YaST tool can be used but has a different method of navigation which is not documented here.

Configure hostname and DNS

  1. Open YaST Network Settings.
  2. SLED 12 Only: On the Global Options tab, change the Network Setup Method to Wicked Service.
  3. Open the Hostname/DNS tab.
  4. Clear Change hostname via DHCP.
  5. Check Assign Hostname to Loopback IP.
  6. Edit the following to reflect your networking setup:
  • Hostname – Add the DNS hostname of the machine.
  • Domain Name – Add the DNS domain name of the machine.
  • Name Server – Add the IP address of the DNS server. This is typically the IP address of the AD Domain Controller.
  • Domain Search list – Add the DNS domain name.

Note

The Linux VDA currently does not support NetBIOS name truncation, therefore the hostname must not exceed 15 characters.

Tip

Use a-z, A-Z, 0-9 and hyphen (-) characters only. Avoid underscrores (_), spaces, and other symbols. Do not start a hostname with a number and do not end with a hyphen. This rule also applies to Delivery Controller hostnames.

Disable multicast DNS

On SLED only, the default settings have multicast DNS (mDNS) enabled, which can lead to inconsistent name resolution results. mDNS is not enabled on SLES by default, so no action is required. 

To disable mDNS, edit /etc/nsswitch.conf and change the line containing:

command Copy

hosts: files mdns_minimal [NOTFOUND=return] dns

To:

command Copy

hosts: files dns

Check the hostname

Verify that the hostname is set correctly:

command Copy

hostname

This should return only the machine's host name and not its fully qualified domain name (FQDN).

Verify that the FQDN is set correctly:

command Copy

hostname -f

This should return the machine's FQDN.

Check name resolution and service reachability

Verify that you can resolve the FQDN and ping the domain controller and XenDesktop Delivery Controller:

command Copy

nslookup domain-controller-fqdn

ping domain-controller-fqdn

nslookup delivery-controller-fqdn

ping delivery-controller-fqdn

If you cannot resolve the FQDN or ping either of these machines, review the steps before proceeding.

Step 1c: Configure the NTP service

Maintaining accurate clock synchronization between the VDAs, XenDesktop Controllers and domain controllers is crucial. Hosting the Linux VDA as a virtual machine can cause clock skew problems. For this reason, maintaining time using a remote NTP service is preferred. Some changes might be required to the default NTP settings:

  1. Open YaST NTP Configuration and select the General Settings tab.
  2. In the Start NTP Daemon section, check Now and on Boot.
  3. If present, select the Undisciplined Local Clock (LOCAL) item and click Delete.
  4. Add an entry for an NTP server by clicking Add.
  5. Select the Server Type and click Next.
  6. Enter the DNS name of the NTP server in the Address field. This service is normally hosted on the Active Directory domain controller.
  7. Leave the Options field unchanged.
  8. Click Test to check that the NTP service is reachable.
  9. Click OK through the set of windows to save the changes.

Note

For SLES 12 implementations, if the NTP daemon fails to start, this might be due to a known SUSE issue with AppArmor policies. Follow the resolution here for additional information.

Step 1d: Install Linux VDA dependent packages

The Linux VDA software for SUSE Linux Enterprise is dependent on the following packages:

  • PostgreSQL
    • SLED/SLES 11: Version 9.1 or later
    • SLED/SLES 12: Version 9.3 or later
  • OpenJDK 1.7.0
  • OpenMotif Runtime Environment 2.3.1 or later
  • Cups
    • SLED/SLES 11: Version 1.3.7 or later
    • SLED/SLES 12: Version 1.6.0 or later
  • Foomatic filters 
    • SLED/SLES 11: Version 3.0.0 or later
    • SLED/SLES 12: Version 1.0.0 or later
  • ImageMagick
    • SLED/SLES 11: Version 6.4.3.6 or later
    • SLED/SLES 12: Version 6.8 or later

Add repositories

Some required packages are not available in all SUSE Linux Enterprise repositories:

  • SLED 11: PostgreSQL is available for SLES 11 but not SLED 11.
  • SLES 11: OpenJDK and OpenMotif are available for SLED 11 but not SLES 11.
  • SLED 12: PostgreSQL is available for SLES 12 but not SLED 12. ImageMagick is available via the SLE 12 SDK ISO or online repository.
  • SLES 12: There are no issues; all packages are available. ImageMagick is available via the SLE 12 SDK ISO or online repository.

To resolve this, the recommended approach is to obtain missing packages from the media for the alternate edition of SLE from which you are installing. That is, on SLED install missing packages from the SLES media, and on SLES install missing packages from the SLED media. The approach described below mounts both SLED and SLES ISO media files and adds repositories.

SLED 11


sudo mkdir -p /mnt/sles

sudo mount -t iso9660 \

           path-to-iso/SLES-11-SP4-DVD-x86_64-GM-DVD1.iso /mnt/sles

sudo zypper ar -f /mnt/sles sles

SLES 11

sudo mkdir -p /mnt/sled

sudo mount -t iso9660 \

           path-to-iso/SLED-11-SP4-DVD-x86_64-GM-DVD1.iso /mnt/sled

sudo zypper ar -f /mnt/sled sled

SLED 12

sudo mkdir -p /mnt/sles

sudo mount -t iso9660 \

           path-to-iso/SLES-12-SP2-DVD-x86_64-GM-DVD1.iso /mnt/sles

sudo zypper ar -f /mnt/sles sles

SLED/SLES 12

sudo mkdir -p /mnt/sdk

sudo mount -t iso9660 \

           path-to-iso/SLE-12-SP2-SDK-DVD-x86_64-GM-DVD1.iso /mnt/sdk

sudo zypper ar -f /mnt/sdk sdk

Install the Kerberos client

Install the Kerberos client for mutual authentication between the Linux VDA with the XenDesktop Controllers:

command Copy

sudo zypper install krb5-client

The Kerberos client configuration is dependent on which Active Directory integration approach is used, which is described later.

Install OpenJDK

The Linux VDA is dependent on OpenJDK 1.7.0.

Tip

To avoid problems, make sure that you installed only OpenJDK version 1.7.0. Remove all other versions of Java on your system.

SLED

On SLED, the Java runtime environment should have been installed with the operating system. Confirm this with:

sudo zypper info java-1_7_0-openjdk

Update to the latest version if status is reported as out-of-date:

sudo zypper update java-1_7_0-openjdk

Check the Java version:

java -version

SLES

On SLES, the Java runtime environment needs to be installed:

sudo zypper install java-1_7_0-openjdk

Check the Java version:

java -version

Install PostgreSQL

SLED/SLES 11

Install the packages:

sudo zypper install libecpg6

sudo zypper install postgresql-init

sudo zypper install postgresql

sudo zypper install postgresql-server

sudo zypper install postgresql-jdbc

Some post-installation steps are required to initialize the database service and ensure PostgreSQL starts on boot:

sudo /sbin/insserv postgresql

sudo /etc/init.d/postgresql restart

SLED/SLES 12

Install the packages:

sudo zypper install postgresql-init

sudo zypper install postgresql-server

sudo zypper install postgresql-jdbc

Post-installation steps are required to initialize the database service and ensure PostgreSQL starts on boot:

sudo systemctl enable postgresql

sudo systemctl restart postgresql

Database files will reside under /var/lib/pgsql/data.

 

Remove repositories

With dependent packages installed, the alternative edition repositories setup earlier can now be removed and the media unmounted:

SLED 11

Remove the following packages:

sudo zypper rr sles

sudo umount /mnt/sles

sudo rmdir /mnt/sles

SLES 11

Remove the following packages:

sudo zypper rr sled

sudo umount /mnt/sled

sudo rmdir /mnt/sled

SLED 12

Remove the following packages:

sudo zypper rr sles

sudo umount /mnt/sles

sudo rmdir /mnt/sles

SLED/SLES 12

Remove the following packages:

sudo zypper rr sdk

sudo umount /mnt/sdk

sudo rmdir /mnt/sdk

Step 2: Prepare Linux VM for Hypervisor

Some changes are required when running the Linux VDA as a virtual machine on a supported hypervisor. Make the following changes according to the hypervisor platform in use. No changes are required if you are running the Linux machine on bare metal hardware.

Fix time synchronization on Citrix XenServer

If the XenServer Time Sync feature is enabled, within each paravirtualized Linux VM you will experience issues with NTP and XenServer both trying to manage the system clock. To avoid the clock becoming out of sync with other servers, the system clock within each Linux guest must be synchronized with NTP. This requires disabling host time synchronization. No changes are required in HVM mode.

On some Linux distributions, if you are running a paravirtualized Linux kernel with XenServer Tools installed, you can check whether the XenServer Time Sync feature is present and enabled from within the Linux VM:

command Copy

su -

cat /proc/sys/xen/independent_wallclock

This will return either:

  • 0 - The time sync feature is enabled, and needs to be disabled.
  • 1 - The time sync feature is disabled, and no further action is required.

If the /proc/sys/xen/indepent_wallclock file is not present, the following steps are not required.

If enabled, disable the time sync feature by writing 1 to the file:

command Copy

sudo echo 1 > /proc/sys/xen/independent_wallclock

To make this change permanent and persist after reboot, edit the /etc/sysctl.conf file and add the line:

config Copy

xen.independent_wallclock = 1

To verify these changes, reboot the system:

command Copy

reboot

After reboot, check that this has been set correctly:

command Copy

su -

cat /proc/sys/xen/independent_wallclock

This should return the value 1.

Fix time synchronization on Microsoft Hyper-V

Linux VMs with Hyper-V Linux Integration Services installed can leverage the Hyper-V time synchronization feature to use the host operating system's time. To ensure that the system clock remains accurate, this feature must be enabled alongside NTP services.

From the management operating system:

  1. Open the Hyper-V Manager console.
  2. For the settings of a Linux VM, select Integration Services.
  3. Ensure that Time synchronization is selected.

Note

This approach is different from VMware and XenServer, where host time synchronization is disabled to avoid conflicts with NTP. Hyper-V time synchronization can coexist and supplement NTP time synchronization.

Fix time synchronization on ESX and ESXi

If the VMware Time Synchronization feature is enabled, within each paravirtualized Linux VM you will experience issues with NTP and the hypervisor both trying to synchronize the system clock. To avoid the clock becoming out of sync with other servers, the system clock within each Linux guest must be synchronized with NTP. This requires disabling host time synchronization.

If you are running a paravirtualized Linux kernel with VMware Tools installed:

  1. Open the vSphere Client.
  2. Edit settings for the Linux VM.
  3. In the Virtual Machine Properties dialog, open the Options tab.
  4. Select VMware Tools.
  5. In the Advanced box, clear Synchronize guest time with host.

Step 3: Add the Linux virtual machine (VM) to the Windows domain

There are a number of methods for adding Linux machines to the Active Directory domain that are supported by XenDesktop for Linux:

  • Samba Winbind
  • Quest Authentication Service
  • Centrify DirectControl

Follow the instructions below for your chosen method.

Samba Winbind

Join Windows Domain

This requires that your domain controller is reachable and you have an Active Directory user account with permissions to add machines to the domain:

1.  Open YaST Windows Domain Membership.

2.  Make the following changes:

  • Set the Domain or Workgroup to the name of your Active Directory domain or the IP address of the domain controller. Ensure that the domain is entered in uppercase.
  • Check Also Use SMB information for Linux Authentication.
  • Check Create Home Directory on Login.
  • Check Single Sign-on for SSH.
  • Ensure that Offline Authentiation is not checked. This option is not compatible with the Linux VDA.

3.  Click OK. If prompted to install some packages, click Install.

4.  If a domain controller is found, it will ask whether you want to join the domain. Click Yes

5.  When prompted, enter the credentials of a domain user with permission to add computers to the domain and click OK

6.  A message indicating success is displayed. 

7.  If prompted to install some samba and krb5 packages, click Install

YaST might have indicated that these changes will require some services to be restarted or the machine needs to be rebooted. It is advisable to reboot:

command Copy

su -

reboot

SLED/SLES 12 Only: Patch Kerberos credential cache name

SLED/SLES 12 has changed the default Kerberos credential cache name specification from the usual FILE:/tmp/krb5cc_%{uid} to DIR:/run/user/%{uid}/krb5cc. This new DIR caching method is not compatible with the Linux VDA and must be manually changed. As root, edit /etc/krb5.conf and add the following setting under the [libdefaults] section if not set:

config Copy

default_ccache_name = FILE:/tmp/krb5cc_%{uid}

Verify domain membership

The XenDesktop Controller requires that all VDA machines, whether Windows or Linux, have a computer object in Active Directory.

Verify that the machine is joined to a domain using Samba's net ads command:

command Copy

sudo net ads testjoin

Verify additional domain and computer object information with:

command Copy

sudo net ads info

Verify the Kerberos configuration 

To verify Kerberos is configured correctly for use with the Linux VDA, check that the system keytab file has been created and contains valid keys:

command Copy

sudo klist –ke

This should display the list of keys available for the various combinations of principal names and cipher suites. Run the Kerberos kinit command to authenticate the machine with the domain controller using these keys:

command Copy

sudo kinit -k MACHINE\$@REALM

The machine and realm names must be specified in uppercase, and the dollar sign ($) must be escaped with a backslash (\) to prevent shell substitution. In some environments, the DNS domain name is different from the Kerberos realm name; ensure that the realm name is used. If this command is successful, no output is displayed.

Verify that the TGT ticket for the machine account has been cached using:

command Copy

sudo klist

Examine the machine account details using:

command Copy

sudo net ads status

Verify user authentication 

Use the wbinfo tool to verify that domain users can authenticate with the domain:

command Copy

wbinfo --krb5auth=domain\\username%password

The domain specified here is the AD domain name, not the Kerberos realm name. For the bash shell, the backslash (\) character must be escaped with another backslash. This command will return a message indicating success or failure.

To verify that the Winbind PAM module is configured correctly, log on locally with a domain user account that has not logged on to the machine previously:

command Copy

ssh localhost -l domain\\username

id -u

Check that a corresponding Kerberos credential cache file was created for the uid returned by the id -u command:

command Copy

ls /tmp/krb5cc_uid

Check that the tickets in the user’s Kerberos credential cache are valid and not expired:

command Copy

klist

Exit the session

command Copy

exit

A similar test can be performed by logging on to the Gnome or KDE console directly.

Quest authentication service

Configure Quest on Domain Controller

This assumes you have installed and configured the Quest software on the Active Directory domain controllers, and have been granted administrative privileges to create computer objects in Active Directory.

Enable Domain Users to Log on to Linux VDA Machines

For each domain user that needs to establish HDX sessions on a Linux VDA machine:

  1. In the Active Directory Users and Computers management console, open Active Directory user properties for that user account.
  2. Select Unix Account tab.
  3. Check Unix-enabled.
  4. Set the Primary GID Number to the group ID of an actual domain user group.

Note

These instructions are equivalent for setting up domain users for logon using the console, RDP, SSH or any other remoting protocol.

Configure Quest on Linux VDA 

Configure VAS daemon

Auto-renewal of Kerberos tickets needs to be enabled and disconnected; authentication (offline logon) needs to be disabled:

command Copy

sudo /opt/quest/bin/vastool configure vas vasd \

auto-ticket-renew-interval 32400

sudo /opt/quest/bin/vastool configure vas vas_auth \

allow-disconnected-auth false

This sets the renewal interval to 9 hours (32400 seconds) which is an hour less than the default 10 hour ticket lifetime. Set this parameter to a lower value on systems with a shorter Kerberos ticket lifetime.

Configure PAM and NSS

Quest requires that PAM and NSS be manually configured to enable domain user login via HDX and other services such as su, ssh, and RDP. To configure PAM and NSS:

command Copy

sudo /opt/quest/bin/vastool configure pam

sudo /opt/quest/bin/vastool configure nss

Join Windows Domain

Join the Linux machine to the Active Directory domain using the Quest vastool command:

command Copy

sudo /opt/quest/bin/vastool -u user join domain-name

The user is any domain user with permissions to join computers to the Active Directory domain. The domain-name is the DNS name of the domain; for example, example.com.

Verify Domain Membership

The XenDesktop Controller requires that all VDA machines, whether Windows or Linux, have a computer object in Active Directory. To verify that a Quest-joined Linux machine is on the domain:

command Copy

sudo /opt/quest/bin/vastool info domain

If the machine is joined to a domain, the domain name is returned. If not joined, you will see the following error:

error Copy

ERROR: No domain could be found.

ERROR: VAS_ERR_CONFIG: at ctx.c:414 in _ctx_init_default_realm

default_realm not configured in vas.conf. Computer may not be joined to domain

Verify User Authentication

To verify that Quest can authenticate domain users using PAM, log on with a domain user account that has not logged on to the machine previously:

command Copy

ssh localhost -l domain\\username

id -u

Check that a corresponding Kerberos credential cache file was created for the uid returned by the id -u command:

command Copy

ls /tmp/krb5cc_uid

Check that the tickets in user’s Kerberos credential cache are valid and not expired:

command Copy

/opt/quest/bin/vastool klist

Exit the session:

command Copy

exit

A similar test can be performed by logging on to the Gnome or KDE console directly.

Centrify DirectControl

Join Windows Domain

With the Centrify DirectControl Agent installed, join the Linux machine to the Active Directory domain using the Centrify adjoin command:

command Copy

su – 

adjoin -w -V -u user domain-name

The user parameter is any Active Directory domain user with permissions to join computers to the Active Directory domain. The domain-name parameter is the name of the domain to join the Linux machine to.

Verify Domain Membership

The XenDesktop Controller requires that all VDA machines, whether Windows or Linux, have a computer object in Active Directory. To verify that a Centrify-joined Linux machine is on the domain:

command Copy

su –

adinfo

Check that the Joined to domain value is valid and the CentrifyDC mode returns connected. If the mode remains stuck in the starting state, then the Centrify client is experiencing server connection or authentication problems.

More comprehensive system and diagnostic information is available using:

command Copy

adinfo --sysinfo all

adinfo –diag

To test connectivity to the various Active Directory and Kerberos services:

command Copy

adinfo --test

Step 4: Install the Linux VDA

Step 4a: Uninstall the old version

If you have previously installed a version of the Linux VDA older than V. 1.1, uninstall it before installing the new version.

     (a) Stop the Linux VDA services:

command Copy

sudo /sbin/service ctxvda stop

sudo /sbin/service ctxhdx stop

     (b) Uninstall the package:

command Copy

sudo rpm -e XenDesktopVDA

Important

Upgrading from the latest two versions is supported.

Note

Starting with Version 1.3, the installation path has changed. In previous releases, installation components were located in /usr/local/; the new location is /opt/Citrix/VDA/.

To execute a command, the full path is needed; alternately, you can add /opt/Citrix/VDA/sbin and /opt/Citrix/VDA/bin to the system path.

Step 4b: Download the Linux VDA package

Go to the Citrix website and download the appropriate Linux VDA package based on your Linux distribution.

Step 4c: Install the Linux VDA

Install the Linux VDA software using Zypper:

For SUSE 12:

command Copy

sudo zypper install XenDesktopVDA-7.14.0.400-1.sle12_2.x86_64.rpm

For SUSE 11:

command Copy

sudo zypper install XenDesktopVDA-7.14.0.400-1.sle11_4.x86_64.rpm

Install the Linux VDA software using the RPM package manager; before doing so, you must resolve the following dependencies before installation:

For SUSE 12:

command Copy

sudo rpm -i XenDesktopVDA-7.14.0.400-1.sle12_2.x86_64.rpm

For SUSE 11:

command Copy

sudo rpm -i XenDesktopVDA-7.14.0.400-1.sle11_4.x86_64.rpm

Step 4d: Upgrade the Linux VDA (optional)

You can upgrade the Linux VDA software from versions 7.13 and 7.12 using the RPM package manager:

For SUSE 12: 

command Copy

sudo rpm -U XenDesktopVDA-7.14.0.400-1.sle12_2.x86_64.rpm

For SUSE 11:

command Copy

sudo rpm -U XenDesktopVDA-7.14.0.400-1.sle11_4.x86_64.rpm

RPM Dependency list for SUSE 12:

dependencies Copy

postgresql-server >= 9.3
postgresql-jdbc >= 9.2
java-1.7.0-openjdk >= 1.7.0
ImageMagick >= 6.8
dbus-1 >= 1.8.8
dbus-1-x11 >= 1.8.8
libXpm4 >= 3.5.11
libXrandr2 >= 1.4.2
libXtst6 >= 1.2.2
motif >= 2.3
pam >= 1.1.8
bash >= 4.2
findutils >= 4.5
gawk >= 4.1
sed >= 4.2
cups >= 1.6.0
cups-filters-foomatic-rip >= 1.0.0
openldap2 >= 2.4
cyrus-sasl >= 2.1
cyrus-sasl-gssapi >= 2.1
libxml2 >= 2.9
python-requests >= 2.8.1
gperftools >= 2.2
rpmlib(PayloadFilesHavePrefix) <= 4.0-1
rpmlib(CompressedFileNames) <= 3.0.4-1
rpmlib(PayloadIsLzma) <= 4.4.6-1

RPM Dependency list for SUSE 11

dependencies Copy

postgresql-server >= 9.1.9
postgresql-jdbc >= 9.1
java-1_7_0-openjdk >= 1.7.0.6
ImageMagick >= 6.4.3.6
ConsoleKit >= 0.2.10
dbus-1 >= 1.2.10
dbus-1-x11 >= 1.2.10
xorg-x11-libXpm >= 7.4
xorg-x11-libs >= 7.4
openmotif-libs >= 2.3.1
pam >= 1.1.5
libdrm >= 2.4.41
libpixman-1-0 >= 0.24.4
Mesa >= 9.0
openssl >= 0.9.8j
xorg-x11 >= 7.4
xorg-x11-fonts-core >= 7.4
xorg-x11-libXau >= 7.4
xorg-x11-libXdmcp >= 7.4
bash >= 3.2
findutils >= 4.4
gawk >= 3.1
sed >= 4.1
cups >= 1.3.7
foomatic-filters >= 3.0.0
openldap2 >= 2.4
cyrus-sasl >= 2.1
cyrus-sasl-gssapi >= 2.1
libxml2 >= 2.7
python-requests >= 2.0.1
rpmlib(PayloadFilesHavePrefix) <= 4.0-1
rpmlib(CompressedFileNames) <= 3.0.4-1
rpmlib(PayloadIsLzma) <= 4.4.6-1

Important

You must reboot the Linux VDA machine after upgrading.

Step 5: Configure the Linux VDA

After installing the package, you must configure the Linux VDA by running the ctxsetup.sh script. If you have upgraded the package, you must run the ctxsetup.sh script to finalize your upgrade. Before making any changes, this script will verify the environment and ensure that all dependencies are installed. If nevessary, you can rerun this script at any time to change settings.

You can run the script manually with prompting, or automatically with preconfigured responses. Review Help about this script before proceeding:

command Copy

sudo /opt/Citrix/VDA/sbin/ctxsetup.sh –help

Prompted configuration

Run a manual configuration with prompted questions:

command Copy

sudo /opt/Citrix/VDA/sbin/ctxsetup.sh

Automated configuration

For an automated installation, provide the options required by the setup script with environment variables. If all required variables are present, the script does not prompt for any information.

Supported environment variables include:

  • CTX_XDL_SUPPORT_DDC_AS_CNAME = Y | N - The Linux VDA supports specifying a Delivery Controller name using a DNS CNAME record. This is typically set to N.
  • CTX_XDL_DDC_LIST = list-ddc-fqdns – The Linux VDA requires a space-separated list of Delivery Controller Fully Qualified Domain Names (FQDNs) to use for registering with a Delivery Controller. At least one FQDN or CNAME alias must be specified.
  • CTX_XDL_VDA_PORT = port-number – The Linux VDA communicates with Delivery Controllers using a TCP/IP port. This is typically port 80.
  • CTX_XDL_REGISTER_SERVICE = Y | N - The Linux Virtual Desktop services support starting during boot. This is typically set to Y.
  • CTX_XDL_ADD_FIREWALL_RULES = Y | N – The Linux Virtual Desktop services require incoming network connections to be allowed through the system firewall. You can automatically open the required ports (by default ports 80 and 1494) in the system firewall for the Linux Virtual Desktop. This is typically set to Y.
  • CTX_XDL_AD_INTEGRATION = 1 | 2 | 3 | 4 – The Linux VDA requires Kerberos configuration settings to authenticate with the Delivery Controllers. The Kerberos configuration is determined from the installed and configured Active Directory integration tool on the system. Specify the supported Active Directory integration method to use:
    • 1 – Samba Winbind
    • 2 – Quest Authentication Service
    • 3 – Centrify DirectControl
    • 4 – SSSD
  • CTX_XDL_HDX_3D_PRO= Y | N – Linux Virtual Desktop supports HDX 3D Pro, a set of graphics acceleration technologies designed to optimize the virtualization of rich graphics applications. HDX 3D Pro requires a compatible NVIDIA GRID graphics card to be installed. If HDX 3D Pro is selected, the Virtual Delivery Agent is configured for VDI desktops (single-session) mode – (i.e. CTX_XDL_VDI_MODE=Y). This is not supported on SUSE. Ensure that this value is set to N.
  • CTX_XDL_VDI_MODE = Y | N - Whether to configure the machine as a dedicated desktop delivery model (VDI) or hosted shared desktop delivery model. For HDX 3D Pro environments, set this to Y. This is typically set to N.
  • CTX_XDL_SITE_NAME = dns-name – The Linux VDA discovers LDAP servers using DNS, querying for LDAP service records. To limit the DNS search results to a local site, specify a DNS site name. This is typically empty [none].
  • CTX_XDL_LDAP_LIST = list-ldap-servers – The Linux VDA by default queries DNS to discover LDAP servers. However if DNS cannot provide LDAP service records, you can provide a space-separated list of LDAP Fully Qualified Domain Names (FQDNs) with LDAP port (e.g. ad1.mycompany.com:389). This is typically empty [none].
  • CTX_XDL_SEARCH_BASE = search-base – The Linux VDA by default queries LDAP using a search base set to the root of the Active Directory Domain (e.g. DC=mycompany,DC=com). However to improve search performance, you can specify a search base (e.g. OU=VDI,DC=mycompany,DC=com). This is typically empty [none].
  • CTX_XDL_START_SERVICE = Y | N - Whether or not the Linux VDA services are started when the Linux VDA configuration is complete. This is typically set to Y.

Note

HDX 3D Pro is not currently available on SUSE.

Set the environment variable and run the configure script:

command Copy

 export CTX_XDL_SUPPORT_DDC_AS_CNAME=Y|N

export CTX_XDL_DDC_LIST=list-ddc-fqdns

export CTX_XDL_VDA_PORT=port-number

export CTX_XDL_REGISTER_SERVICE=Y|N

export CTX_XDL_ADD_FIREWALL_RULES=Y|N

export CTX_XDL_AD_INTEGRATION=1|2|3|4

export CTX_XDL_HDX_3D_PRO=Y|N

export CTX_XDL_VDI_MODE=Y|N

export CTX_XDL_SITE_NAME=dns-name

export CTX_XDL_LDAP_LIST=list-ldap-servers

export CTX_XDL_SEARCH_BASE=search-base

export CTX_XDL_START_SERVICE=Y|N

sudo -E /opt/Citrix/VDA/sbin/ctxsetup.sh

You must provide the -E option with sudo to pass the existing environment variables to the new shell it creates. Citrix recommends that you create a shell script file from the commands above with #!/bin/bash on the first line.

Alternatively, you can specify all parameters with a single command:

command Copy

sudo CTX_XDL_SUPPORT_DDC_AS_CNAME=Y|N \

CTX_XDL_DDC_LIST=list-ddc-fqdns \

CTX_XDL_VDA_PORT=port-number \

CTX_XDL_REGISTER_SERVICE=Y|N \

CTX_XDL_ADD_FIREWALL_RULES=Y|N \

CTX_XDL_AD_INTEGRATION=1|2|3|4 \

CTX_XDL_HDX_3D_PRO=Y|N \

CTX_XDL_VDI_MODE=Y|N \

CTX_XDL_SITE_NAME=dns-name \

CTX_XDL_LDAP_LIST=list-ldap-servers \

CTX_XDL_SEARCH_BASE=search-base \

CTX_XDL_START_SERVICE=Y|N \

/opt/Citrix/VDA/sbin/ctxsetup.sh

Remove configuration changes

In some scenarios, you might have to remove the configuration changes made by the ctxsetup.sh script without uninstalling the Linux VDA package.

Review Help about this script before proceeding:

command Copy

sudo /usr/local/sbin/ctxcleanup.sh --help

To remove configuration changes:

command Copy

sudo /usr/local/sbin/ctxcleanup.sh

Important

This script will delete all configuration data from the database and will make the Linux VDA inoperable.

Configuration logs

The ctxsetup.sh and ctxcleanup.sh scripts display errors on the console, with additional information written to a configuration log file:

command Copy

/tmp/xdl.configure.log

Restart the Linux VDA services to have the changes take effect.

Step 6: Run the Linux VDA

Once you have configured the Linux VDA using the ctxsetup.sh script, you can run the following commands to control the Linux VDA.

Start the Linux VDA

To start the Linux VDA services:

command Copy

sudo /sbin/service ctxhdx start

sudo /sbin/service ctxvda start

Stop the Linux VDA

To stop the Linux VDA services:

command Copy

sudo /sbin/service ctxvda stop

sudo /sbin/service ctxhdx stop

Restart the Linux VDA

To restart the Linux VDA services:

command Copy

sudo /sbin/service ctxvda stop

sudo /sbin/service ctxhdx restart

sudo /sbin/service ctxvda start

Check the Linux VDA status

To check the running status of the Linux VDA services:

command Copy

sudo /sbin/service ctxvda status

sudo /sbin/service ctxhdx status

Step 7: Create the machine catalog in XenApp or XenDesktop

The process for creating machine catalogs and adding Linux VDA machines is very similar to the traditional Windows VDA approach. For a more detailed description of how to complete these tasks, see Create Machine Catalogs and Manage Machine Catalogs.

For creating machine catalogs that contain Linux VDA machines, there are a few restrictions that differentiate the process from creating machine catalogs for Windows VDA machines:

  • For the operating system, select:
    • Windows Server OS or Server OS option for a hosted shared desktops delivery model. 
    • Windows Desktop OS or Desktop OS option for a VDI dedicated desktop delivery model.
  • Ensure that machines are set as not power managed.
  • Because MCS is not supported for Linux VDAs, choose PVS or the Another service or technology (existing images) deployment method.
  • Do not mix Linux and Windows VDA machines in the same machine catalog.

Note

Early versions of Citrix Studio did not support the notion of a "Linux OS"; however, selecting the Windows Server OS or Server OS option implies an equivalent hosted shared desktops delivery model. Selecting the Windows Desktop OS or Desktop OS option implies a XenDesktop single user per machine delivery model.

Tip

If a machine leaves and is rejoined to the Active Directory domain, the machine will need to be removed and re-added again to the machine catalog.

Step 8: Create the delivery group in XenApp or XenDesktop

The process for creating a delivery group and adding machine catalogs containing Linux VDA machines is almost identical to Windows VDA machines. For a more detailed description of how to complete these tasks, see Create Delivery Groups.

For creating delivery groups that contain Linux VDA machine catalogs, the following restrictions apply:

  • For delivery type, select Desktops or Applications.
  • Ensure the AD users and groups you select have been properly configured to log on to the Linux VDA machines.
  • Do not allow logon of unauthenticated (anonymous) users.
  • Do not mix the delivery group with machine catalogs that contain Windows machines.

Important

Publishing applications is supported with Linux VDA version 1.4 and later. However, the Linux VDA does not support the delivery of desktops and apps to the same machine.

The Citrix documentation for creating machine catalogs and delivery groups is referenced below:

Earlier versions of XenDesktop are not supported.