Access Gateway Software Updates

How to Determine the Version of the Software on the Access Gateway Appliance

Complete the following steps to identify the version of the Access Gateway installed:

Point a Web browser to the Access Gateway server on HTTPS port 9001:
https://gateway-FQDN-or-IP:9001/
Log on with the user name root. The default password is rootadmin.
Click the Logging link at the top of the page. The version number and build date appears under the Software Version heading, as shown in the following screen shot:

How to Upgrade the Appliance

The following two options are available to upgrad the software image on the appliance:

Option 1: Download and Install an Upgrade File

Option 2: Create a Bootable Installation CD-ROM/USB

Option 1: Download and Install an Upgrade File

Important: If you have currently installed a version of Access Gateway earlier than version 4.6.x, then you cannot upgrade to version 4.6.x, 5.x or later using an upgrade file, use Option 2. To upgrade the Access Gateway to version 5.x, you must have the Access Gateway 2010 platform model. This version does not run on Access Gateway 2000 platform models.

An upgrade file contains only the software binaries that are updated. When an upgrade file is installed, the version is updated but all configuration settings, licenses, and certificates are maintained on the appliance.

Note: Ensure that you back up the current configuration before upgrading, by using the procedure outlined in the Save Your Current Configuration section in this article.

For Access Gateway 4.5.x/4.6.x

To upgrade an Access Gateway from 4.5.x to a later 4.5.x release – or – 4.6.x to a later release of 4.6.x, follow these instructions:

Note: You can upgrade the Access Gateway 2010 hardware model from 4.6.x to 5.x with upgrade (.upg) file. You cannot upgrade the Access Gateway 4.5.x to 5.x with an upgrade file.

Download the Citrix Access Gateway Upgrade Software file by logging on to My Citrix. From the download page, click the appropriate upgrade software download link.
Open the Access Gateway server on HTTPS port 9001 in a Web browser:
https://gateway-FQDN-or-IP:9001/
Log on with the user name root. The default password is rootadmin.
Click Maintenance.
Click Browse shown after the Upload Server Upgrade or Saved Config field, as shown in the following screen shot:

Browse the local file system, locate the upgrade file and click Open.
Click Upload on the Maintenance page. After approximately three minutes, you are prompted to restart the Access Gateway appliance.

For Access Gateway 5.x

To upgrade an Access Gateway from 5.x to a later 5.x release, follow these instructions:

Download the Citrix Access Gateway Upgrade Software file by logging on to My Citrix. From the download page, click the appropriate upgrade software download link.
Open the Access Gateway server on HTTPS in a Web browser:
https://gateway-FQDN-or-IP/lp/AdminlogonPoint
Log on with the user name admin. The default password is admin.
Click Snapshots.
Click Import.
Select the .bin file with the latest release of Access Gateway 5.x.
Click on the latest Software Version uploaded and either select Initialize or Migrate.
Click on Initialize if you want to revert back to default settings using the latest release.
Click on Migrate if you would like to transfer the old configuration to the new release.

Option 2: Create a Bootable Installation CD-ROM/USB

WARNING! Booting from the installation media erases the hard drive on the appliance and installs the Access Gateway software image. Prior to upgrading, be sure to back up the current configuration using the procedure outlined in the Save Your Current Configuration section in this article.

An ISO image file is available to create a bootable installation disk. To re-image the appliance, insert the CD (or plug-in the USB key in the back of the appliance) and then restart the Access Gateway appliance. The imaging process takes approximately 20 minutes, after which you can remove the CD or USB and restart with factory default settings.

IMPORTANT: Booting from the installation media erases the current certificate, license file, and all configuration settings.

Record the CD-ROM image

Log on to My Citrix and click the Standard Edition - Appliance Software link to go to the download page, where you can start the download.
Extract the downloaded archive to obtain the ISO file.
Record the ISO CD-ROM image to disk using CD-ROM recording software. Users working with the 2010 model appliance (without CD-ROM drives) need to download the appliance imaging tool to create a bootable image on a USB Flash Drive.
If you are planning to create a USB key to re-image the Access Gateway appliance to 5.0.3, you must use the Citrix Access Gateway 5.0.3.227000 of the Access Gateway 2010 Appliance Imaging Tool. This imaging tool contains already the appliance firmware. There is no need to download separately an .ISO file for this version. To create an USB image, click Browse to locate the USB store device, and then, click Image.

The version of the appliance imaging tool can be identified after running imaging_tool.exe as shown in the following screen shot:

If you are planning to create a USB key to re-image the Access Gateway appliance to 5.0.2, you must use the Citrix Access Gateway 5.0.2179500 of the Access Gateway 2010 Appliance Imaging Tool. This imaging tool contains already the appliance firmware. There is no need to download separately an .ISO file for this version. To create an USB image, click Browse to locate the USB store device, and then, click Image.

The version of the appliance imaging tool can be identified after running imaging_tool.exe as shown in the following screen shot:

If you are planning to create a USB key to re-image the Access Gateway appliance to 5.0.1, you must use the Built on 03/18/2010 of the Access Gateway 2010 Appliance Imaging Tool.

The version of the appliance imaging tool can be identified after running imaging_tool.exe as shown in the following screen shot:

If you are planning to create a USB key to re-image the Access Gateway appliance to the latest version of 4.6.x, you must use the v4.6 (build 3 or later) of the Access Gateway 2010 Appliance Imaging Tool.

The version of the appliance imaging tool can be identified after running imaging_tool.exe as shown in the following screen shot:

If you are planning to create a USB key to re-image the Access Gateway appliance to a 4.5.x version, you must use the v1.0 (build 21) of the Access Gateway 2010 Appliance Imaging Tool.

The version of the appliance imaging tool can be identified after running imaging_tool.exe as shown in the following screen shot:

Note: Dragging the .iso image onto the CD-RW drive results in creating an invalid CD-ROM with just the CD-image file stored on it. Make sure that you record the image with recording software that recognizes the ISO format.

Save Your Current Configuration

For Access Gateway 4.5.x/4.6.x:

Note: Before re-imaging the Access Gateway appliance, ensure that you save the configuration settings. The configuration settings are not retained when performing the following steps.

Open the Access Gateway server on HTTPS port 9001 in the Web browser:
https://gateway-FQDN-or-IP:9001/
Log on with the user name root. The default password is rootadmin.
On the Maintenance page, click Save Config. You are prompted to save a file named config.restore. This file includes all current settings, local user accounts, and certificate files.

For Access Gateway 5.x:

Open the Access Gateway server on HTTPS in the Web browser:
https://gateway-FQDN-or-IP/lp/AdminlogonPoint
Log on with the user name admin. The default password is admin.
Click Snapshots.
Click Import.
Select the .bin file with the latest release of Access Gateway 5.x.
Click on the current Software Version, click on Create and then Export. The configuration settings including licenses and certificates are exported.

Re-image the Access Gateway

Shut down the Access Gateway appliance.
Connect a client computer to the serial port using the null modem cable provided. Use Hyperterminal or any other terminal emulation software and connect using the following settings:

Bits per second: 9600
Data bits: 8
Parity: None
Stop bits: 1
Flow control: Hardware

Remove the bezel (only Access Gateway 2000 hardware models) from the front panel of the Access Gateway appliance to reveal the CD-ROM drive. Put the recorded CD into the Access Gateway CD drive and then power on the device. Approximately one minute after it restarts, you should see information about the progress of the installation through the serial console. For hardware models without CD-ROM drives you should insert USB Flash Drive at this point.
Once the installation is complete, remove all installation media and restart the appliance.
Log on through a serial console and enter the basic network configuration settings through the serial console or use the default configured IP address of 10.20.30.40.
When you are able to connect to the Administration Tool, you can upload the saved configuration and the settings are restored.

How to Obtain a License for an Access Gateway Appliance

Customers who purchase Access Gateway appliance receive an e-mail from licenses@citrix.com containing instructions for how to download a license file.

Customers who upgrade from Access Gateway 4.2 or earlier should obtain their license file through MyCitrix.

If the Access Gateway deployment includes the Advanced Access Control Option, then it is not necessary to install a separate license on the appliance. Instead, the Advanced Access Control server manages licenses for all Access Gateway users using a Citrix License server installed on the trusted network. For more information, see the Access Suite Licensing Guide:

CTX106282 – Citrix Access Suite Licensing Guide

For standalone Access Gateway deployments that do not include the Advanced Access Control option, a license must be uploaded onto the appliance using the Access Gateway Administration Tool. Refer to the Access Gateway Administrators Guide for more information.

Important: For Access Gateway 5.x (Standalone or Controller mode), licenses are stored now on the appliance or Citrix License server. When running the Access Gateway in Controller mode, licenses are not configured anymore on the Access Controller server but instead on the Access Gateway Management Console.