Product Documentation

Install Linux Virtual Delivery Agent for Ubuntu

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 Ubuntu for VDA installation

Step 1a: Verify the network configuration

Citrix recommends that the network is connected and configured correctly before proceeding.

Step 1b: Set the hostname

To ensure that the hostname of the machine is reported correctly, change the /etc/hostname file to contain only the hostname of the machine.

hostname

Step 1c: Assign a loopback address to the hostname

To ensure that the DNS domain name and FQDN of the machine are reported back correctly, change the following line of the /etc/hosts file to include the FQDN and hostname as the first two entries:

127.0.0.1  hostname-fqdn hostname localhost

For example:

127.0.0.1  vda01.example.com vda01 localhost

Remove any other references to hostname-fqdn or hostname from other entries in the file.

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.

Step 1d: 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.

Step 1e: Disable multicast DNS

The default settings have multicast DNS (mDNS) enabled, which can lead to inconsistent name resolution results.

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

config Copy

hosts: files mdns_minimal [NOTFOUND=return] dns

To:

config Copy

hosts: files dns

Step 1f: 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 1g: Configure clock synchronization (chrony)

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, synchronizing time with a remote time service is preferred.

Install chrony:

command Copy

apt-get install chrony

As root, edit /etc/chrony/chrony.conf and add a server entry for each remote time server:

config Copy

server peer1-fqdn-or-ip-address iburst

server peer2-fqdn-or-ip-address iburst

In a typical deployment, time should be synchronized from the local domain controllers and not directly from public NTP pool servers. Add a server entry for each Active Directory domain controller in the domain.

Remove any other server or pool entries listed including loopback IP address, localhost, and public server *.pool.ntp.org entries.

Save changes and restart the Chrony daemon:

command Copy

sudo systemctl restart chrony

Step 1h: Install OpenJDK

The Linux VDA is dependent on OpenJDK. The runtime environment should have been installed as part of the operating system installation. Confirm this with:

command Copy

sudo apt-get install -y default-jdk

Step 1i: Install PostgreSQL

The Linux VDA requires PostgreSQL version 9.x on Ubuntu 16.04:

command Copy

sudo apt-get install -y postgresql

sudo apt-get install -y libpostgresql-jdbc-java

Step 1j: Install Motif

command Copy

sudo apt-get install -y libxm4

Step 1k: Install other packages

command Copy

sudo apt-get install -y libsasl2-2

sudo apt-get install -y libsasl2-modules-gssapi-mit

sudo apt-get install -y libldap-2.4-2

sudo apt-get install -y krb5-user

sudo apt-get install -y cups

Step 2: Prepare the 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

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
  • SSSD

Follow the instructions below for your chosen method.

Samba Winbind

Install or update the required packages:

command Copy

sudo apt-get install winbind samba libnss-winbind libpam-winbind krb5-config krb5-locales krb5-user

Enable Winbind Daemon to Start on Boot

The Winbind daemon must be configured to start on boot:

command Copy

sudo systemctl enable winbind

Configure Kerberos

Open /etc/krb5.conf as root, and make the following settings:

config Copy

[libdefaults]
default_realm = REALM
dns_lookup_kdc = false

[realms]
REALM = {
admin_server = domain-controller-fqdn
kdc = domain-controller-fqdn
}

[domain_realm]
domain-dns-name = REALM
.domain-dns-name = REALM

The domain-dns-name property in this context is the DNS domain name, such as example.com. The REALM is the Kerberos realm name in uppercase, such as EXAMPLE.COM.

Configure Winbind Authentication

You should configure manually since Ubuntu does not have a tool like authconfig in RHEL and yast2 in SUSE.

Open /etc/samba/smb.conf, and make the following settings:

config Copy

[global]

workgroup = WORKGROUP
security = ADS
realm = REALM
encrypt passwords = yes

idmap config *:range = 16777216-33554431

winbind trusted domains only = no
kerberos method = secrets and keytab
winbind refresh tickets = yes

template shell = /bin/bash

WORKGROUP is the first field in REALM, and REALM is the Kerberos realm name in uppercase.

Configure nsswitch

Open /etc/nsswitch.conf, and append winbind to the following lines:

config Copy

passwd: compat winbind
group: compat winbind

Join Windows Domain

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

command Copy

sudo net ads join REALM -U user

Where REALM is the Kerberos realm name in uppercase, and user is a domain user with permissions to add computers to the domain.

Restart winbind:

command Copy

sudo systemctl restart winbind

Configure PAM for Winbind

Run the following command and ensure that the Winbind NT/Active Directory authentication and Create home directory on login options are selected:

command Copy

sudo pam-auth-update

Tip

The winbind daemon will stay running only if the machine is joined to a domain.

Verify Domain Membership

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

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

command Copy

sudo net ads testjoin

Additional domain and computer object information can be verified with:

command Copy

sudo net ads info

Verify 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’s 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.

Tip

If you succeed in user authentication but can't show your desktop when logging in with a domain account, restart the machine and then try again.

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

Workaround SELinux Policy Enforcement

The default RHEL environment has SELinux fully enforced. This interferes with the Unix domain socket IPC mechanisms used by Quest and prevents domain users from logging on.

Tip

There are a few ways to workaround outlined here.

The easiest is to disable SELinux. As root, edit /etc/selinux/config and change the SELinux setting:

config Copy

SELINUX=disabled

This change requires a reboot:

command Copy

reboot

Important

Use this setting carefully. Reenabling SELinux policy enforcement after disabling can cause a complete lockout, even for the root user and other local users. 

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 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 this will return the domain name. 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

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

SSSD

Configure Kerberos

Install kerberos

command Copy

sudo apt-get install krb5-user

To configure Kerberos, open /etc/krb5.conf as root, and make the following settings:

Setting Copy

[libdefaults]

 default_realm = REALM

 dns_lookup_kdc = false

[realms]

 REALM = {

  admin_server = domain-controller-fqdn

  kdc = domain-controller-fqdn

 }

[domain_realm]

 domain-dns-name = REALM

 .domain-dns-name = REALM

The domain-dns-name property in this context is the DNS domain name, such as example.com. The REALM is the Kerberos realm name in uppercase, such as EXAMPLE.COM.

Join the domain

SSSD must be configured to use Active Directory as its identity provider and Kerberos for authentication. However, SSSD does not provide AD client functions for joining the domain and managing the system keytab file. There are a few methods achieving this:

  • adcli
  • samba
  • realmd

Note

This section only provides information for adcli and samba.

Use adcli to join the domain

Install adcli

Install the required package:

command Copy

sudo apt-get install adcli

Join the domain with adcli

Remove the old system keytab file and join the domain using:

command Copy

su -

rm -rf /etc/krb5.keytab

adcli join domain-dns-name -U user -H hostname-fqdn

The user is a domain user with permission to add machines to the domain, the hostname-fqdn is the  hostname in fqdn format for the machine.

The -H option is needed to let adcli generate SPN in this format: host/hostname-fqdn@REALM, which is required by the Linux VDA.

Verify System Keytab 

The capabilities of the adcli tool are limited and do not provide a way to test whether a machine is joined to the domain. The best alternative to ensure the system keytab file has been created:

command Copy

sudo klist -ket

Verify that the timestamp for each key matches the time the machine was joined to the domain.

Use samba to join the domain

Install the package

command Copy

sudo apt-get install samba

Configure samba

Open /etc/samba/smb.conf, and make the following settings:

config Copy

[global]

   workgroup = WORKGROUP

   security = ADS

   realm = REALM

   client signing = yes

   client use spnego = yes

   kerberos method = secrets and keytab

WORKGROUP is the first field in REALM, and REALM is the Kerberos realm name in uppercase.

Join the domain with samba

This requires that your domain controller is reachable and you have a Windows account with permissions to add computers to the domain.

command Copy

sudo net ads join REALM -U user

Where REALM is the Kerberos realm name in uppercase, and user is a domain user with permissions to add computers to the domain.

Set up SSSD

Install or update required packages

Install the required SSSD and configuration packages if not already installed:

command Copy

sudo apt-get install sssd

If the packages are already installed, an update is recommended:

command Copy

sudo apt-get update sssd

Note

By default, the install process in Ubuntu will automatically configure nsswitch.conf and the PAM login module.

Configure SSSD

SSSD configuration changes are required before starting the SSSD daemon. For some versions of SSSD, the /etc/sssd/sssd.conf configuration file is not installed by default and must be manually created. As root, either create or open /etc/sssd/sssd.conf and make the following settings:

config Copy

[sssd]

services = nss, pam

config_file_version = 2

domains = domain-dns-name

 

[domain/domain-dns-name]

id_provider = ad

access_provider = ad

auth_provider = krb5

krb5_realm = REALM

# Set krb5_renewable_lifetime higher if TGT renew lifetime is longer than 14 days

krb5_renewable_lifetime = 14d

# Set krb5_renew_interval to lower value if TGT ticket lifetime is shorter than 2 hours

krb5_renew_interval = 1h

krb5_ccachedir = /tmp

krb5_ccname_template = FILE:%d/krb5cc_%U

# This ldap_id_mapping setting is also the default value

ldap_id_mapping = true

override_homedir = /home/%d/%u

default_shell = /bin/bash

ad_gpo_map_remote_interactive = +ctxhdx

Note

ldap_id_mapping is set to true so that SSSD itself takes care of mapping Windows SIDs to Unix UIDs. Otherwise, the Active Directory must be able to provide POSIX extensions (for more information, see the RHEL site). PAM service ctxhdx is added into ad_gpo_map_remote_interactive. For more information, see SSSD GPO-Based Access Control.

The domain-dns-name property in this context is the DNS domain name, such as example.com. The REALM is the Kerberos realm name in uppercase, such as EXAMPLE.COM. There is no requirement to configure the NetBIOS domain name.

Tip

For information on these configuration settings, see the man pages for sssd.conf and sssd-ad.

The SSSD daemon requires that the configuration file must have owner read permission only:

command Copy

sudo chmod 0600 /etc/sssd/sssd.conf

Start SSSD daemon

Start the SSSD daemon and enable it to start on boot:

command Copy

sudo systemctl start sssd

sudo systemctl enable sssd

PAM configuration

Run the following command and ensure that the SSS authentication and Create home directory on login options are selected:

command Copy

sudo pam-auth-update

Verify Domain Membership

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

Use adcli to verify domain membership

Show the domain information by running the following command:

command Copy

sudo adcli info domain-dns-name

Use samba to verify domain membership

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

command Copy

sudo net ads testjoin

Additional domain and computer object information can be verified with:

command Copy

sudo net ads info

Verify 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.

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

command Copy

sudo klist

Verify user authentication

SSSD does not provide a command-line tool for testing authentication directly with the daemon, and can only be done via PAM.

To verify that the SSSD 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

klist 

exit

Check that the Keberos tickets returned by the klist command are correct for that user and have not expired.

As root, check that a corresponding ticket cache file was created for the uid returned by the previous id -u command:

command Copy

ls /tmp/krb5cc_uid

A similar test can be performed by logging on to KDE or Gnome Display Manager.

Step 4: Install the Linux VDA

Step 4a: Download the Linux VDA package

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

Step 4b: Install the Linux VDA

Install the Linux VDA software using the Debian package manager:

command Copy

sudo dpkg -i xendesktopvda_7.14.0.400-1.ubuntu16.04_amd64.deb

Debian dependency list for Ubuntu:

Dependencies Copy

postgresql (>= 9.5), libpostgresql-jdbc-java (>= 9.2), default-jdk (>= 2:1.8), imagemagick (>= 8:6.8.9.9), ufw (>= 0.35), ubuntu-desktop (>= 1.361), libxrandr2 (>= 2:1.5.0), libxtst6 (>= 2:1.2.2), libxm4 (>= 2.3.4), util-linux (>= 2.27.1), bash (>= 4.3), findutils (>= 4.6.0), sed (>= 4.2.2), cups (>= 2.1), libldap-2.4-2 (>= 2.4.42), libsasl2-modules-gssapi-mit (>= 2.1.~), python-requests (>= 2.9.1), libgoogle-perftools4 (>= 2.4~), xserver-xorg-core (>= 2:1.18), xserver-xorg-core (<< 2:1.19)

Step 4c: Configure the Linux VDA

Important

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 necessary, you can rerun this script at any time to change settings.

The script can either be run manually with prompting, or automatically with pre-configured 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 install, the options required by the setup script can be provided with environment variables. If all of the required variables are present, the script does not prompt the user for any information, allowing for a scripted installation process.

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). 
  • 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.

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 /opt/Citrix/VDA/sbin/ctxcleanup.sh --help

To remove configuration changes:

command Copy

sudo /opt/Citrix/VDA/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 the configuration log file /tmp/xdl.configure.log.

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

Uninstall the Linux VDA software

Query Linux VDA installation status

To check whether the Linux VDA is installed and to view the version of the installed package:

command Copy

dpkg -l xendesktopvda

To view more detailed information:

command Copy

apt-cache show xendesktopvda

Note

Uninstalling the Linux VDA software will delete the associated PostgreSQL and other configuration data. However, the PostgreSQL package and other dependent packages that were set up prior to the installation of the Linux VDA will not be removed.

Tip

The information in this section does not cover the removal of dependent packages including PostgreSQL.

Step 5: Run the Linux VDA

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

Start the Linux VDA

To start the Linux VDA services:

command Copy

sudo systemctl start ctxhdx

sudo systemctl start ctxvda

Stop the Linux VDA

To stop the Linux VDA services:

command Copy

sudo systemctl stop ctxvda

sudo systemctl stop ctxhdx

Restart the Linux VDA

To restart the Linux VDA services:

command Copy

sudo systemctl stop ctxvda

sudo systemctl restart ctxhdx

sudo systemctl restart ctxvda

Check the Linux VDA status

To check the running state of the Linux VDA services:

command Copy

sudo systemctl status ctxvda

sudo systemctl status ctxhdx

Step 6: 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 7: 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. Linux VDA for Ubuntu does not support application delivery.
  • Ensure that 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.

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

Earlier versions of XenDesktop are not supported.