Product Documentation

Field Replaceable Units

Aug 31, 2016

Citrix NetScaler field replaceable units (FRU) are NetScaler components that can be quickly and easily removed from the appliance and replaced by the user or a technician at the user's site. The FRUs in a NetScaler appliance can include a CompactFlash card, DC or AC power supplies, and solid-state or hard-disk drives, and a direct attach cable (DAC).

Note: The solid-state or hard-disk drive stores your configuration information, which has to be restored from a backup after replacing the unit.
This document includes the following details:

Power Supply

For appliances containing two power supplies, the second power supply acts as a backup. The MPX 22040/22060/22080/22100/22120 and MPX 24100/24150 appliances can accommodate four power supplies, and require two power supplies for proper operation. The third and fourth power supplies act as backup.

The appliance ships with a standard power cord that plugs into the appliance’s power supply and an NEMA 5-15 plug on the other end for connecting to the power outlet on the rack or in the wall.

For power-supply specifications, see "Hardware Platforms," which describes the various platforms and includes a table summarizing the hardware specifications.

Note: If you suspect that a power-supply fan is not working, please see the description of your platform. On some platforms, what appears to be the fan does not turn, and the actual fan turns only when necessary.

On each power supply, a bicolor LED indicator shows the condition of the power supply.

Electrical Safety Precautions for Power Supply Replacement

  • Make sure that the appliance has a direct physical connection to earth ground during normal use. When installing or repairing an appliance, always connect the ground circuit first and disconnect it last.
  • Always unplug any appliance before performing repairs or upgrades.
  • Never touch a power supply when the power cord is plugged in. As long as the power cord is plugged in, line voltages are present in the power supply even if the power switch is turned off.

Replacing an AC Power Supply

Citrix NetScaler MPX platforms can accommodate two power supplies, except the MPX 22040/22060/22080/22100/22120 and MPX 24100/24150 platforms which can accommodate four power supplies. All NetScaler appliances function properly with a single power supply, except the MPX 22040/22060/22080/22100/22120 and MPX 24100/24150 platforms which need two power supplies for proper operation. The other power supplies serves as a backup. All power supplies must be of the same type (AC or DC).

Note: If the appliance has only one power supply, you have to shut down the appliance before replacing the power supply. If the appliance has two power supplies, you can replace one power supply without shutting down the appliance, provided the other power supply is working, and if the appliance has four power supplies, you can replace one or two power supplies without shutting down the appliance, provided the other two power supplies are working.
To install or replace an AC power supply on a Citrix NetScaler appliance
  1. Align the semicircular handle perpendicular to the power supply. Loosen the thumbscrew and press the lever toward the handle and pull out the existing power supply, as shown in the following figure.
    Note: The illustration in the following figures might not represent the actual NetScaler appliance.
    Figure 1. Removing the Existing AC Power Supply


  2. Carefully remove the new power supply from its box.
  3. On the back of the appliance, align the power supply with the power supply slot.
  4. Insert the power supply into the slot and press against the semicircular handle until you hear the power supply snap into place.
    Figure 2. Inserting the Replacement AC Power Supply


  5. Connect the power supply to a power source. If connecting all power supplies, plug separate power cords into the power supplies and connect them to separate wall sockets.
Note: NetScaler appliances emit a high-pitched alert if one power supply fails or if you connect only one power cable to an appliance in which two power supplies are installed. To silence the alarm, press the small red button on the back panel of the appliance. The disable alarm button is functional only when the appliance has two power supplies.

Replacing a DC Power Supply

Citrix NetScaler MPX platforms can accommodate two power supplies, except the MPX 22040/22060/22080/22100/22120 and MPX 24100/24150 platforms which can accommodate four power supplies. All NetScaler appliances function properly with a single power supply, except the MPX 22040/22060/22080/22100/22120 and MPX 24100/24150 platforms which need two power supplies for proper operation. The other power supplies serves as a backup. All power supplies must be of the same type (AC or DC).

Note: If the appliance has only one power supply, you have to shut down the appliance before replacing the power supply. If the appliance has two power supplies, you can replace one power supply without shutting down the appliance, provided the other power supply is working, and if the appliance has four power supplies, you can replace one or two power supplies without shutting down the appliance, provided the other two power supplies are working.
To install or replace a DC power supply on a Citrix NetScaler appliance
  1. Loosen the thumbscrew and press the lever towards the handle and pull out the existing power supply, as shown in the following figure.
    Note: The illustration in the following figures might not represent the actual NetScaler appliance.
    Figure 3. Removing the Existing DC Power Supply
  2. Carefully remove the new power supply from its box.
  3. On the back of the appliance, align the power supply with the power supply slot.
  4. Insert the power supply into the slot while pressing the lever towards the handle. Apply firm pressure to insert the power supply firmly into the slot.
    Figure 4. Inserting the Replacement DC Power Supply
  5. When the power supply is completely inserted into its slot, release the lever.
  6. Connect the power supply to a power source. If connecting all power supplies, plug separate power cords into the power supplies and connect them to separate wall sockets.
Note: NetScaler appliances emit a high-pitched alert if one power supply fails or if you connect only one power cable to an appliance in which two power supplies are installed. To silence the alarm, press the small red button on the back panel of the appliance. The disable alarm button is functional only when the appliance has two power supplies.

CompactFlash Card

The NetScaler software is stored on either the solid-state drive or the CompactFlash card. The following MPX platforms store the NetScaler software on the CompactFlash card:
  • Citrix NetScaler MPX 5500
  • Citrix NetScaler MPX 7500 and MPX 9500
  • Citrix NetScaler MPX 9700, MPX 10500, MPX 12500, and MPX 15500
Note: The CompactFlash card is mounted as /flash on the above platforms.

The CompactFlash card specifications vary by NetScaler hardware platform. A CompactFlash card from one platform does not necessarily work on a different platform.

Replacing a CompactFlash Card

Note: These instructions apply to the Citrix® NetScaler® MPX 5500, MPX 7500/9500, and MPX 9700/10500/12500/15500 appliances only.
Replacement CompactFlash cards contain a preinstalled version of the NetScaler software and a generic configuration file (ns.conf), but they do not contain SSL-related certificates and keys, or custom boot settings. Configuration files and customized settings must be restored from a backup storage location at the customer site, if available. The files to be restored might include:
  • /flash/nsconfig/ns.conf: The current configuration file.
  • /flash/nsconfig/ZebOS.conf: The ZebOS configuration file.
  • /flash/nsconfig/license: The licenses for the NetScaler features.
  • /flash/nsconfig/ssl: The SSL certificates and keys required for encrypting data to clients or to backend servers.
  • /nsconfig/rc.netscaler: Customer-specific boot operations (optional).
Note: Verify that the card you receive is the correct type for your NetScaler appliance.

To replace a CompactFlash card

  1. At the NetScaler command prompt, exit to the shell prompt. Type:

    shell

  2. Shut down the NetScaler appliance by typing one of the following commands at the shell prompt.
    • On an MPX appliance, type:

      shutdown -p now

    • On a non-MPX appliance, type:

      shutdown

  3. Locate the CompactFlash slot on the back panel of the appliance.
  4. Disengage the CompactFlash by pushing the lever to the right of the CompactFlash slot. If necessary, use a pen or small screwdriver to push the lever in fully. Pull the existing flash card out of the slot.
    Note: The illustration in the following figures might not represent the actual NetScaler appliance.
    Figure 5. Removing the Existing CompactFlash Card


  5. Insert the new flash card received from Citrix.
    Important: When you insert the card, make sure that the arrow on top of the card is pointing toward the CompactFlash slot. Position the connector grid on the edge of the CompactFlash card to meet the matching connector pins inside the CompactFlash slot.
    Figure 6. Inserting the Replacement CompactFlash Card
  6. Turn on the NetScaler appliance.

    When the appliance starts, it no longer has the previous working configuration. Therefore, the appliance is reachable only through the default IP address of 192.168.100.1/16, or through the console port.

  7. Perform the initial configuration of the appliance, as described in "Initial Configuration." Log on to the default IP address by using a web browser, or connect to the serial console by using a console cable, to perform the initial configuration.
  8. Upload a platform license and any optional feature licenses, including universal licenses, to the NetScaler appliance. For more information, see the licensing chapter of the "."
  9. Once the correct NetScaler software version is loaded, you can restore the working configuration. Copy a previous version of the ns.conf file to the /nsconfig directory by using an SCP utility or by pasting the previous configuration into the /nsconfig/ns.conf file from the NetScaler command prompt. To load the new ns.conf file, restart the NetScaler appliance by entering the reboot command at the NetScaler command prompt.

Solid-State Drive

A solid-state drive (SSD) is a high-performance device that stores data in solid-state flash memory. The MPX solid-state drives contain the boot loader configuration file, configuration file (ns.conf), licenses, and for some models, the NetScaler software and the user data.
The NetScaler software is stored on either the SSD or the CompactFlash card. The following MPX platforms store the NetScaler software on the SSD. The SSD is mounted as /flash.
  • Citrix NetScaler MPX 5550 and MPX 5650
  • Citrix NetScaler MPX 8005, MPX 8015, MPX 8200, MPX 8400, MPX 8600, and MPX 8800
  • Citrix NetScaler MPX 11500, MPX 13500, MPX 14500, MPX 16500, MPX 18500, and MPX 20500
  • Citrix NetScaler MPX 11515, MPX 11520, MPX 11530, MPX 11540, and MPX 11542
  • Citrix NetScaler MPX 14020/14030/14040/14060/14080/14100
  • Citrix NetScaler MPX 17500, MPX 19500, and MPX 21500
  • Citrix NetScaler MPX 17550, MPX 19550, MPX 20550, and MPX 21550
  • Citrix NetScaler MPX 22040, MPX 22060, MPX 22080, MPX 22100, and MPX 22120
  • Citrix NetScaler MPX 24100 and MPX 24150
  • Citrix NetScaler MPX 25100T and MPX 25160T
Note: On the MPX 5550/5650 and MPX 8005/8015/8200/8400/8600/8800 appliances, both /flash and /var are mounted from different partitions of the same SSD drive.

Replacing a Solid-State Drive

Note: These instructions apply to the Citrix NetScaler MPX 5550/5650, MPX 8005/8015/8200/8400/8600/8800, MPX 11500/13500/14500/16500/18500/20500, MPX 11515/11520/11530/11540/11542, MPX 14020/14030/14040/14060/14080/14100, MPX 17500/19500/21500, MPX 17550/19550/20550/21550, MPX 22040/22060/22080/22100/22120, MPX 24100/24150, and MPX 25100T/25160T appliances.
Replacement solid-state drives (SSDs) contain a pre-installed version of the NetScaler software and a generic configuration file (ns.conf), but they do not contain SSL-related certificates and keys, or custom boot settings. Configuration files and customized settings must be restored to a replacement drive from a backup storage location at the customer site, if available. The files to be restored might include:
  • /flash/nsconfig/ns.conf: The current configuration file.
  • /flash/nsconfig/ZebOS.conf: The ZebOS configuration file.
  • /flash/nsconfig/license: The licenses for the NetScaler features.
  • /flash/nsconfig/ssl: The SSL certificates and keys required for encrypting data to clients or to backend servers.
  • /nsconfig/rc.netscaler: Customer-specific boot operations (optional).
To replace a solid-state drive
  1. At the NetScaler command prompt, exit to the shell prompt. Type:

    shell

  2. Shut down the NetScaler appliance by typing the following command at the shell prompt:

    shutdown –p now

  3. Locate the SSD on the back panel of the appliance. Push the safety latch of the drive cover to the right or down, depending on the platform, while pulling out on the drive handle to disengage. Pull out the faulty drive.
    Note: The illustration in the following figures might not represent the actual NetScaler appliance.
    Figure 7. Removing the Existing Solid-State Drive


  4. Verify that the replacement SSD is the correct type for the platform.
  5. Pick up the new SSD, open the drive handle fully to the left or up, and insert the drive into the slot as far as possible. To seat the drive, close the handle flush with the rear of the appliance so that the drive locks securely into the slot.
    Important: When you insert the drive, make sure that the Citrix product label is at the top if the drive is inserted horizontally or at the right if the drive is inserted vertically.
    Figure 8. Inserting the Replacement Solid-State Drive


  6. Turn on the NetScaler appliance. When the appliance starts, it no longer has the previous working configuration. Therefore, the appliance is reachable only through the default IP address of 192.168.100.1/16, or through the console port.
  7. Perform the initial configuration of the appliance, as described in "Initial Configuration." Log on to the default IP address by using a web browser, or connect to the serial console by using a console cable, to perform the initial configuration.
  8. Upload a platform license and any optional feature licenses, including universal licenses, to the NetScaler appliance. For more information, see the licensing chapter of the "."
  9. Once the correct NetScaler software version is loaded, you can restore the working configuration. Copy a previous version of the ns.conf file to the /nsconfig directory by using an SCP utility or by pasting the previous configuration into the /nsconfig/ns.conf file from the NetScaler command prompt. To load the new ns.conf file, you must restart the NetScaler appliance by entering the reboot command at the NetScaler command prompt.

Hard Disk Drive

A hard disk drive (HDD) stores logs and other data files. Files stored on the HDD include the newnslog files, dmesg and messages files, and any core/crash files. The HDD comes in various capacities, depending on the Citrix NetScaler platform. Hard drives are used for storing files required at runtime. An HDD is mounted as /var.
The following MPX platforms support HDD:
  • Citrix NetScaler MPX 9700, MPX 10500, MPX 12500, and MPX 15500
  • Citrix NetScaler MPX 11500, MPX 13500, MPX 14500, MPX 16500, MPX 18500, and MPX 20500
  • Citrix NetScaler MPX 11515, MPX 11520, MPX 11530, MPX 11540, and MPX 11542
  • Citrix NetScaler MPX 17500, MPX 19500, and MPX 21500
  • Citrix NetScaler MPX 17550, MPX 19550, MPX 20550, and MPX 21550
  • Citrix NetScaler MPX 22040, MPX 22060, MPX 22080, MPX 22100, and MPX 22120
  • Citrix NetScaler MPX 24100 and MPX 24150

Replacing a Hard Disk Drive

A hard disk drive (HDD) stores log files and other user files. Collection of new log files begins upon boot-up with the new HDD. Product documentation can be downloaded from "MyCitrix.com" and reinstalled to the /var/netscaler/doc location.

To install a hard disk drive
  1. At the NetScaler command prompt, exit to the shell prompt. Type:

    shell

  2. Shut down the NetScaler appliance by typing one of the following commands at the shell prompt.
    • On an MPX appliance, type:

      shutdown –p now

    • On a non-MPX appliance, type:

      shutdown

  3. Locate the hard disk drive on the back panel of the appliance.
  4. Verify that the replacement hard disk drive is the correct type for the NetScaler platform.
  5. Disengage the hard disk drive by pushing the safety latch of the drive cover to the right or down, depending on the platform, while pulling out on the drive handle to disengage. Pull out the faulty drive.
    Note: The illustration in the following figures might not represent the actual NetScaler appliance.
    Figure 9. Removing the Existing Hard Disk Drive


  6. Pick up the new disk drive, open the drive handle fully to the left, and insert the new drive into the slot as far as possible. To seat the drive, close the handle flush with the rear of the appliance so that the hard drive locks securely into the slot.
    Important: When you insert the drive, make sure that the Citrix product label is at the top.
    Figure 10. Inserting the Replacement Hard Disk Drive


  7. Turn on the NetScaler appliance. The appliance starts the NetScaler software and reads the configuration file from the CompactFlash card.

Direct Attach Cable

A direct attach cable (DAC) assembly is a high performance integrated duplex data link for bi-directional communication. The cable is compliant with the IPF MSA (SFF-8432) for mechanical form factor and SFP+ MSA for direct attach cables. The cable, which can be up to 5 meters long, is data-rate agnostic. Supporting speeds in excess of 10 Gbps, it is a cost-effective alternative to optical links (SFP+ transceivers and fiber optic cables.) The transceiver with DAC is hot-swappable. You can insert and remove the transceiver with the attached cable without shutting down the appliance. The Citrix NetScaler appliance supports only passive DAC.

Important:
  • DAC is supported only on 10G ports. Do not insert a DAC into a 1G port.
  • Do not attempt to unplug the integrated copper cable from the transceiver and insert a fiber cable into the transceiver.

Installing a Direct Attach Cable

Note: The illustrations in the following figures are only for reference and might not represent the actual NetScaler appliance.

To install or remove a direct attach cable

  1. To install the DAC, slide it into the 10G port on the appliance, as shown in the following figure. You will hear a click when the DAC properly fits into the port.
    Figure 11. Inserting a DAC into the 10G port


  2. To remove the DAC, pull the tab on the top of the DAC, and then pull the DAC out of the port, as shown in the following figure.
    Figure 12. Removing a DAC from the 10G port