4.1. How to Configure the Citrix XenDesktop Connector with Sun Ray Software

The following procedure describes how to configure a Sun Ray server using the Sun Ray Software Admin GUI to automatically provide users direct access to their Windows desktops through the Citrix XenDesktop connector. This configuration is done through the kiosk mode feature and the Citrix XenDesktop session type.

This Citrix XenDesktop connector session type is provided through the following files:

Steps
  1. Log in to the Admin GUI.

  2. Click the Advanced tab and Kiosk Mode sub-tab. Then click Edit.

  3. Choose Citrix XenDesktop Session from the Session (Session Type) menu.

  4. (Optional) Modify the session parameters.

  5. Add the required and any optional session type arguments to the Arguments field as follows:

    session-type-arguments [-- uttsc-arguments]

    See the examples provided at the end of this procedure.

    Table 4.1, “Required Kiosk Session Arguments for Citrix XenDesktop Connector” lists the required session arguments:

    Table 4.1. Required Kiosk Session Arguments for Citrix XenDesktop Connector

    Argument

    Description

    -d domain-name

    Specifies the Windows domain of the virtual desktops, which is preselected in the login screen. You can provide a comma separated list, which provides a pull-down menu to the user.

    -s server-url

    The URL of the Citrix XenDesktop Web Interface Server, either the IP address or hostname. For example, http://192.168.10.1.


    Table 4.2, “Optional Kiosk Session Arguments for Citrix XenDesktop Connector” lists the optional session arguments:

    Table 4.2. Optional Kiosk Session Arguments for Citrix XenDesktop Connector

    Argument

    Description

    -B banner-image-url

    A URL to an image file used as the background for the Available Desktops and Desktop Login dialog screens. Supported file formats are png, gif, and jpg. The URL can be either http:// or file://. Shortened URLs, such as from bitly, are supported.

    -g background-color

    Background color (RGB value) for the Citrix XenDesktop connector screen. When this option is used with the -G option, it defines the top color of the gradient background. Example value is 225,225,225.

    The default background color is a gradient from 143,158,170 to 95,108,120.

    -G bottom-gradient-color

    Bottom color of background gradient (RGB value) for the Citrix XenDesktop connector screen. This option requires the -g option, which becomes the top color of the background gradient. Example value is 225,225,225.

    -M

    Enable the custom service menu. See Section 4.4, “Custom Service Menu” for more information.

    -p proxy-port

    Proxy port number. Default value is 80.

    -P proxy-host

    Proxy host. The value can be either a host name or an IP address, without the http:// prefix. This may be needed when using an external URL with the -B or -W option.

    -r screen-resolutions

    Screen resolution options for the Options menu. Format is width1xheight1[,width2xheight2...]. Example value is 1024x768,1280x800.

    -T text-color

    Text color (RGB value). Example value is 225,225,225.

    -u alt-base

    An alternative for the Citrix Web Interface base URL. The default is /Citrix/DesktopWeb/. The path must be enclosed in slashes. Example value is /path1/path2/.

    -W wallpaper-url

    A URL to an image file used as the wallpaper for the Citrix XenDesktop connector screen. Supported file formats are png, gif, and jpg. The URL can be either http:// or file://. Shortened URLs, such as from bitly, are supported.


  6. Add any Windows connector (uttsc) arguments after the double dash (--) to the Arguments field.

    session-type-arguments [-- uttsc-arguments]

    All options that follow the double dash (--) are passed to the Windows connector (uttsc command). Some uttsc options are sent automatically and should not be specified. Do not include the following uttsc options: -i, -u, -d, -p, and -m.

  7. Click OK.

  8. Configure the server to use kiosk mode for card and non-card users.

    1. Click the System Policy sub-tab on the Advanced menu.

    2. Enable Kiosk Mode for both card and non-card users.

    3. Make sure to disable the Mobile Sessions (NCSM) policy.

  9. Click Save.

  10. If you configured the server to use kiosk mode in the System Policy page, perform a cold restart of the Sun Ray server.

All new or restarted sessions matching the policy configuration to use kiosk mode will access the new session type.