Product Documentation
ADC
14.1 - Current Release 13.1 13.0 12.1
View PDF

Install, upgrade, and downgrade

May 10, 2024
Contributed by: 
C S

Install and upgrade

How to download a specific Citrix ADC release build package?

For information on downloading a specific Citrix ADC release build package, see Download a Citrix ADC release package.

How to upgrade the system software of a Citrix ADC appliance?

For information on upgrading the system software of a Citrix ADC appliance, see Upgrade a Citrix ADC standalone appliance.

Where do I find the release notes for a Citrix ADC release build?

The release notes document for a Citrix ADC release build lists the following for the release build:

  • Enhancements
  • Fixed issues
  • Known issues

The release notes document for a Citrix ADC release build is found at the following locations:

Where do I find security updates for Citrix ADC appliances?

Citrix security team regularly releases security bulletins on Common Vulnerabilities and Exposures (CVE) for all related Citrix products. This information can be found at Citrix security bulletin. Alternatively, you can search for a specific CVE at Citrix Support site.

What is the use of the zebos.conf file available in a Citrix ADC release?

A Citrix ADC appliance uses ZebOS as the routing suite. The zebos.conf file available in a Citrix ADC release is the configuration file for ZebOS.

I want to change the SSH port (22) on the Citrix ADC appliance to some other port. Is it possible to change the SSH port on the appliance?

Yes. You can change the SSH port on the Citrix ADC appliance by editing the sshd_config file in the /nsconfig directory. If the file does not exist in the /nsconfig directory, copy it from the /etc directory.

In the sshd_config file, edit the entry for Port 22 to Port <Number>, where <Number> is the target port number. If you do not want to restart the appliance and make the changes effective, terminate the sshd process by using the kill command, and then restart the process.

Note:

Some features such as config synchronization, file synchronization, and HA synchronization don’t work after you customize the default SSH port.

The flash directory is missing from the Citrix ADC appliance. What procedure must I follow to mount the flash directory?

To mount the flash directory, do the following:

  1. Start the Citrix ADC appliance in single-user mode.

    When the appliance starts, the following message appears:

    Select [Enter] to boot immediately, or any other key for the command prompt. Booting [kernel] in 10 seconds…” Select space and you must see the following prompt:

    Type ‘?’ for a list of commands, ‘help’ for more detailed help.

  2. Enter the following command to start FreeBSD in single-user mode:

    boot –s

    After the appliance starts, the following message appears:

    Enter full pathname of shell or RETURN for /bin/sh:

  3. Press Enter to display the # prompt.

  4. Run the following command to mount the flash directory:

    mount /dev/ad0s1a /flash

Note: If the preceding command displays an error message about permissions, run the following command to check the disk for consistency:

fsck /dev/ad0s1a

Run the mount command again to mount the flash directory.

  5. Restart the appliance.

  6. From the shell prompt, run the following command to verify that the flash directory is mounted:

    df -kh

I want to log on to the Citrix ADC appliance without entering the password. Is it possible to configure SSH on the appliance to allow that?

Yes. You can configure SSH on the Citrix ADC appliance to log on without a password. However, you must provide your user name. To configure SSH for logging in without a password, do the following:

  1. Run the following command to generate the public and private keys:

    \# ssh-keygen -t rsa

  2. Run the following command to copy the id_rsa.pub file to the .ssh directory of the remote host that you want to log on to:

    \# scp id_dsa.pub \<user>@\<remote_host>/.ssh/id_dsa.pub

  3. Log on to the remote host.

  4. Change to the .ssh directory.

  5. Run the following commands to add the public key of the client to the known public keys:

    \# cat id_dsa.pub >> authorized_keys2

\# chmod 640 authorized_keys2

\# rm id_dsa.pub

What is the procedure to reset the Citrix ADC appliance BIOS? Under what circumstances must I reset the BIOS?

To reset the BIOS of the Citrix ADC appliance, complete the following procedure:

  1. Connect to the appliance through the serial port.

  2. Start the appliance and press Delete when the boot-up process starts.

    Pressing Delete during the POST process displays the appliance’s BIOS settings.

  3. Activate the Exit page of the BIOS settings.

  4. Select the Load Optimal Defaults option. The Load Optimal Settings message box appears.

  5. Select OK.

  6. Make the following changes to the BIOS settings on the various tabs:

    Tab

  7. Activate the Exit page of the BIOS settings.

  8. Select Save changes and Exit.

  9. Select OK to confirm.

  10. Verify that the appliance starts cleanly and the serial console displays output after the appliance starts.

    You must reset BIOS when the serial console does not respond. This usually happens after you upgrade the appliance and the serial console is disabled. However, you can still access the appliance by using the telnet or SSH utility.

I need to reset the Citrix ADC appliance to the factory defaults. What procedure must I follow?

To reset the Citrix ADC appliance to the factory defaults, you need to reset two environments: the Citrix ADC application environment and the base FreeBSD environment. To reset the Citrix ADC application environment of the appliance to the factory defaults, do the following:

  1. Make a backup of the appliance’s /nsconfig/ns.conf.
  2. Delete the /nsconfig/ns.conf file.
  3. Restart the appliance. To reset the FreeBSD environment of the appliance to the factory defaults, do the following:
    1. Install a fresh Citrix ADC code image on the appliance. This overwrites several FreeBSD-level configuration files with default values.
    2. Delete any users and groups that are added to the appliance, that is, all except the default users.
    3. Delete the /etc/resolv.conf file.
    4. Delete the entries that you have added to the /etc/hosts file.
    5. If the /etc/rc.netscaler file exists, delete it.
    6. Open the /etc/nsperm_group_suser file and make sure that all IOCTL entries are comment entries.
    7. Open the /etc/rc.conf file and make sure that the syslogd_enable=NO entry is not changed to syslogd_enable=YES.
    8. Open the /etc/syslog.conf file and make sure that there are no additional entries in the file.
    9. Delete the contents of the /var/nslog, /var/nstrace, and /var/crash files.
    10. If the syslog process is enabled on the appliance and the appliance creates log files locally, delete the contents of the log files listed in the /etc/syslog.conf file. The files are created in the /var/log directory. For example, if the syslog process writes system events to the /var/log/events file, and sslvpn access events to the /var/log/sslvpnevents file, delete these files.

The appliance displays a message similar to the “Jun 21 12:20:18 ns /flash/ns-10.0-47.15: [1/2]dc0: NIC hangs condition #663: TX 10000/10000, RX 0, HF 0” message on the console. What is the meaning of this message?

The message consists of the following components (shown here as examples):

  • #663: Number of times this condition has occurred on the appliance.
  • TX 10000/10000: Number of packets that the appliance attempted to transmit, and number of packets transmitted. If both numbers are the same, as in this example, the NIC transmitted all the packets that the appliance attempted to transmit.
  • RX 0: Number of packets received. In this example, no packet was received.
  • HF0: Number of hardware issues reported by the NIC. In this example, the NIC did not report any hardware issue.

If the appliance does not receive any packets, it reports a hang condition, because on a network it is unlikely not to receive any packets. However, if the appliance is plugged into quite the interface, you can ignore this error message.

After I upgraded the Citrix ADC release on the appliance, the appliance still displays the earlier release/build. What can be the reason?

The appliance displays the software version number from the /flash/boot/loader.conf file. If the kernel entry for the current Citrix ADC release is missing from that file, the appliance displays the last Citrix ADC release version for which the entry was available. To resolve this issue, do the following:

  1. Verify that the kernel file exists in the /nsconfig directory.

  2. Check the /flash/boot/loader.conf file for an entry for the kernel.

    (You can expect the entry for the kernel of the release/build that you installed to be missing from the file.)

  3. Open the loader.conf file in a text editor, such as the vi editor, and update the kernel entry for the new release/build.

  4. Save and close the file.

  5. Repeat step 2 through step 4 for the /flash/boot/loader.conf.local file.

  6. Update the release/build entry in the ns.conf file.

  7. Restart the appliance.

Since I upgraded the Citrix ADC release on the appliance, the LCD display on the front panel of the appliance displays the out of service message or does not display anything. How can I resolve this issue?

Run the following command from the appliance’s shell prompt:

/netscaler/nslcd –k

I have upgraded the Citrix ADC release/build. However, after the upgrade process, the appliance fails to start. Can I downgrade the appliance’s software to the previous release/build?

Yes. You can start the appliance with the kernel.old kernel file. When you restart the appliance, press the F1 key when the appliance console displays the Press F1 message. Type kernel.old and press Enter.

After upgrading the Citrix ADC release on the appliance, I accidentally deleted the kernel file from the /flash directory. As a result, I am not able to start the appliance. Is there a method for starting the appliance in this situation?

Yes. You can start the appliance by using the kernel.GENERIC kernel file, as follows:

  1. When you restart the appliance, press the F1 key when the appliance console displays the Press F1 message.
  2. Type kernel. GENERIC and press Enter.
  3. Log in as the root user.
  4. Reinstall the Citrix ADC release.
  5. Restart the appliance.

After upgrading the appliance software, I am not able to log on to the appliance, and the following message appears. I tried to resolve this issue by using the password recovery procedure, but I was not successful. Have I done something incorrectly? 

```
login: nsroot
Password:
connect: No such file or directory
nsnet_connect: No such file or directory
Login incorrect
<!--NeedCopy--> ```

You cannot resolve this issue by using the password recovery procedure. Citrix ADC release 12.1 or later use the new licensing system, based on the Imgrd daemon, which runs during the startup procedure. For this daemon to work properly, the host name of Citrix ADC appliance, which is set in the /nsconfig/rc.conf file, must be resolved by a name server to the NSIP address. Alternately, you can create a hosts file in the /nsconfig directory and add the 127.0.0.1 <Host_Name> entry in file.

Also, make sure that you have copied the license files to the /nsconfig/license/ directory.

During an upgrade of a high availability pair, the following message appears repeatedly. What can be the reason?

<auth.err> ns sshd[5035]: error: Invalid user name or password

This error message appears when the appliances involved in the high availability pairing have either a different Citrix ADC release or a different build of the same release installed. The appliances can have different version installed if you have upgraded or downgraded one appliance but not the other.

I want to change the netmask of the NSIP address on a Citrix ADC appliance. Can I do so without causing an outage?

Changing the netmask of the Citrix ADC IP might result in a short outage. Make sure that you change the netmask on the secondary appliance, and then break the high availability pairing. Check the functionality of the appliance. If everything works as expected, rebuild the high availability pairing.

To change the netmask on the appliance, run the config ns command from the CLI prompt, and then choose the second option in the menu.

I have configured a High Availability pair of Citrix ADC appliances. After upgrading the software release from a preview release to a final release, I noticed that some of the appliance configurations are missing. Can I retrieve the lost configurations?

You can use the following procedure to restore the configuration:

  1. Log on to the Citrix ADC command line of the primary appliance.

  2. Run the following commands:

    save config

shell

\#cp /nsconfig/ns.conf /nsconfig/ns.conf.bkup

The ns.conf.bkup file is a backup for the running configuration.

  3. Upgrade software of both the appliances to the final release.

  4. Log on to the Citrix ADC command line of the primary appliance.

Can the primary appliance and secondary appliance have separate builds?

Recommended practice is to use the same version and build number on both the primary and the secondary appliance.

Can both the appliances in a High Availability (HA) pair be upgraded at the same time?

No. In an HA pair, first upgrade the secondary node and then upgrade the primary node.

For details, refer Upgrading a High Availability Pair.

Does Citrix support firmware upgrades in the Amazon Web Services cloud?

Yes.

Can I upgrade the Citrix ADC instance independently of the SDX version?

It is not required to upgrade the SDX version when the Citrix ADC appliance is upgraded. However, some features might not work.

Can I use the FTP server to upgrade the Citrix ADC appliance?

No. You must first download the firmware from the Citrix download site, save it on your local computer and then upgrade the appliance.

Is the procedure for upgrading the Citrix ADC appliance with GSLB configurations different from an upgrade of an appliance that is not involved in GSLB?

No. The upgrade procedure is similar to the basic upgrade procedure. The only difference is that you can upgrade the standalone or HA appliances on different sites in a phased manner.

Downgrade

I have received a Citrix ADC appliance with the latest Citrix ADC release installed on it. However, I want to downgrade the software release. Can I do so?

No. If you attempt to downgrade the software release, the appliance might not work as expected, because the ns.conf file of the later release might not be compatible with the earlier release, and the appliance might restore to the factory settings.

When downgrading the Citrix ADC release, I followed the instructions. However, the appliance displays the following message. How is the rollback procedure performed on a Citrix ADC appliance? 

root@LBCOL03B# ./installns
installns version (10.0-47.7) kernel (ns-10.0-47.7.gz)
Note:
Installation may pause for up to 3 minutes while data is written to the flash.
Caution:
Do not interrupt the installation process.
Doing so may cause the system to become unusable.
Installation will proceed in 5 seconds, CTRL-C to abort
No Valid Citrix ADC Version Detected
root@LBCOL03B#

The rollback procedure is similar to the basic upgrade procedure. Select the target build that you want to roll back to and perform the downgrade. Before rolling back to a different release, Citrix recommends that you create a copy of your current configuration files. To downgrade from a release, see Downgrading a Citrix ADC Standalone Appliance.

Install, upgrade, and downgrade
May 10, 2024
Contributed by: 
C S
May 10, 2024
Contributed by: 
C S

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.