Field replaceable units

Citrix ADC field replaceable units (FRU) are ADC 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 for a Citrix ADC appliance include DC or AC power supplies, solid-state or hard-disk drives, and a direct attach cable (DAC).

Note: The solid-state or hard-disk drive stores your configuration information, and it must be restored from a backup after the unit is replaced.

Power supply

For appliances containing two power supplies, the second power supply is optional but recommended. Some appliances can accommodate four power supplies, and require two power supplies as a bare minimum for proper operation. As a best practice, plug in all the power supplies for redundancy.

The appliance ships with a standard power cord that plugs into the appliance’s power supply and a 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 Common Components.

Note: If you suspect that a power-supply fan is not working, 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.
  • 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.

For the complete list of safety precautions, see Safety, Cautions, Warnings, and Other Information.

Replace an AC power supply

Most Citrix ADC MPX platforms can accommodate two power supplies. Some platforms can accommodate four power supplies. All Citrix ADC appliances function properly with a single power supply, except the appliances that can accommodate four power supplies. These appliances need two power supplies for proper operation. The other power supply 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. With two power supplies, you can replace one power supply without shutting down the appliance, provided the other power supply is working. With 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 ADC 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 Citrix ADC appliance.

    Figure 1. Remove the existing AC power supply

    Remove an 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

    Insert the 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: Citrix ADC 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.

Replace a DC power supply

Most Citrix ADC MPX platforms can accommodate two power supplies. Some platforms can accommodate four power supplies. All Citrix ADC appliances function properly with a single power supply, except the appliances that can accommodate four power supplies. These appliances need two power supplies for proper operation. The other power supply 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. With two power supplies, you can replace one power supply without shutting down the appliance, provided the other power supply is working. With 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 ADC 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 Citrix ADC appliance.

    Figure 3. Remove the existing DC power supply Remove the 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

    Insert the DC power supply

  5. When the power supply is 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: Citrix ADC 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.

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 Citrix ADC software and the user data.

All MPX platforms store the Citrix ADC software on the SSD. The SSD is mounted as /flash.

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.

Replace a RAID-supported SSD by using the CLI

You can access the CLI from the ADC GUI by navigating to Configuration > System > Diagnostic > Utility > Command line interface. You can also access the CLI from the serial console port or the management port (0/1 or 0/2).

Note: The RAID status can take READY or DEGRADED values. The drive status can take ONLINE or MISSING values.

To check the status of your SSDs in RAID, at the CLI type:

Command:

sh raid

Output:

RAID1 status: READY
Drive:
       1   ONLINE
       2   ONLINE
Done

If both SSDs show ONLINE and RAID status is READY, no action is required.

In the following table, the values in the first column show the drive number on the back panel of the appliance. The drive number in the other columns refers to the number that should be used in the command or as it appears in the output of the CLI and shell.

Chassis CLI command Shell command Shell command Shell command
Slot in chassis sh raid atacontrol status ar0 atacontrol detach / atacontrol attach atacontrol addspare ar0
SSD 1 drive 1 drive 0 ata2 ad4
SSD 2 drive 2 drive 1 ata3 ad6

The following output indicates SSD 2 has failed and should be replaced.

Command:

sh raid

Output:

RAID1 status: DEGRADED
Drive:
       1   ONLINE
       2   MISSING
Done

Sometimes, the failed drive/SSD may not be reported.

Command:

sh raid

Output:

RAID1 status: DEGRADED
Drive:
       1   ONLINE
Done

From the shell, confirm that drive 1/SSD 2 has failed, RAID status reports DEGRADED and drive 1/SSD 2 reports MISSING, or not present in the output.

  1. At the Citrix ADC command prompt, switch to the shell prompt. Type: shell

  2. Check the status of the RAID array. SSD2 shows missing or is not present in the output.

Command:

root@ns# atacontrol status:ar0

Output:

ar0: ATA RAID1 status: DEGRADED
subdisks:
       0 ad4  ONLINE
       1 ----  MISSING

OR

ar0: ATA RAID1 status: DEGRADED
subdisks:
       0 ad4  ONLINE

Note: Drive numbering changes in the shell: SSD 1 reports as drive 0 and SSD 2 as drive 1.

Perform the following steps to restore the RAID array to health by using the atacontrol utility.

  1. Detach a failed drive. The failed drive is replaced with a new FRU drive.

  2. Attach the FRU drive.

  3. Add the FRU drive to the RAID array.

  4. Verify the replacement drive is recognized.

  5. Start the rebuild process.

  6. Monitor the rebuild process.

  7. Verify that rebuild is successful.

  8. Exit the bash shell and verify from Citrix ADC CLI.

Example when SSD 2 fails

In the following example, SSD 2/drive 1/ata3 has failed.

  1. Detach a failed drive.

    root@ns# atacontrol detach ata3
    
  2. Physically, remove SSD 2/drive 1 and replace it with a new FRU drive in slot 2.

  3. Attach the FRU drive.

    root@ns# atacontrol attach ata3
    
  4. Add the FRU drive to the RAID array.

    root@ns# atacontrol addspare ar0 ad6
    
  5. Verify the replacement drive is recognized.

    root@ns# atacontrol status ar0
    

    Output:

    ar0: ATA RAID1 status: DEGRADED
    subdisks:
       0 ad4  ONLINE
       1 ad6  SPARE
    
  6. Start the rebuild process.

    root@ns# atacontrol rebuild ar0
    
  7. Monitor the rebuild process.

    root@ns# atacontrol status ar0
    

    Output:

    ar0: ATA RAID1 status: REBUILDING 10% completed
    subdisks:
       0 ad4  ONLINE
       1 ad6  SPARE
    

    Note: Rebuilding the RAID array takes some time.

  8. Verify the REBUILD is successful.

    root@ns# atacontrol status ar0
    

    Output:

    ar0: ATA RAID1 status: READY
    subdisks:
       0 ad4  ONLINE
       1 ad6  ONLINE
    

    Note: After the rebuild operation completes, the subdisks status shows ONLINE and the RAID status shows READY.

  9. Exit the shell and verify the status of the RAID array from the Citrix ADC CLI.

    root@ns# exit
    >sh raid
    

    Output:

    RAID1 status: READY
    Drive:
            1   ONLINE
            2   ONLINE
    Done
    

Example when SSD 1 fails

In the following example, SSD 1/drive 0/ata2 has failed.

  1. Detach a failed drive.

    root@ns# atacontrol detach ata2
    
  2. Physically, remove SSD 1/drive 0 and replace it with a new FRU drive in slot 1.

  3. Attach the FRU drive.

    root@ns# atacontrol attach ata2
    
  4. Add the FRU drive to the RAID array.

    root@ns# atacontrol addspare ar0 ad4
    
  5. Verify the replacement drive is recognized.

    root@ns# atacontrol status ar0
    

    Output:

    ar0: ATA RAID1 status: DEGRADED
    subdisks:
       0 ad4  SPARE
       1 ad6  ONLINE
    
  6. Start the rebuild process.

    root@ns# atacontrol rebuild ar0
    
  7. Monitor the rebuild process.

    root@ns# atacontrol status ar0
    

    Output:

    ar0: ATA RAID1 status: REBUILDING 10% completed
    subdisks:
       0 ad4  SPARE
       1 ad6  ONLINE
    

    Note: Rebuilding the RAID array takes some time.

  8. Verify the REBUILD is successful.

    root@ns# atacontrol status ar0
    

    Output:

    ar0: ATA RAID1 status: READY
    subdisks:
       0 ad4  ONLINE
       1 ad6  ONLINE
    

    Note: After the rebuild operation completes, the subdisks status shows ONLINE and the RAID status shows READY.

  9. Exit the shell and verify the status of the RAID array from the Citrix ADC CLI.

    root@ns# exit
    >sh raid
    

    Output:

    RAID1 status: READY
    Drive:
    1   ONLINE
    2   ONLINE
    Done
    

Replace a solid-state drive

Replacement solid-state drives (SSDs) contain a pre-installed version of the Citrix ADC 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 Citrix ADC features.
  • /flash/nsconfig/ssl: The SSL certificates and keys required for encrypting data to clients or to back-end servers.
  • /nsconfig/rc.netscaler: Customer-specific boot operations (optional).

To replace a solid-state drive:

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

    shell

  2. Shut down the Citrix ADC 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 Citrix ADC appliance.

    Figure 7. Remove the existing solid-state drive

    Remove the 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. Insert the replacement solid-state drive

    Insert the solid state drive

  6. Turn on the Citrix ADC 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 Citrix ADC appliance. For more information, see Licensing.

  9. Once the correct Citrix ADC 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 Citrix ADC command prompt. To load the new ns.conf file, you must restart the Citrix ADC appliance by entering the reboot command at the Citrix ADC 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 ADC platform. Hard drives are used for storing files required at runtime. An HDD is mounted as /var.

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

To install a hard disk drive:

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

    shell

  2. Shut down the Citrix ADC 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 Citrix ADC 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 Citrix ADC appliance.

    Figure 9. Removing the existing hard disk drive

    Remove the 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. Insert the replacement hard disk drive

    Insert the hard disk drive

  7. Turn on the Citrix ADC appliance. The appliance starts the Citrix ADC 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 more than 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 ADC 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.

Install a direct attach cable

Note: The illustrations in the following figures are only for reference and might not represent the actual Citrix ADC 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 hear a click when the DAC properly fits into the port.

    Figure 11. Insert a DAC into the 10G port

    Insert the DAC

  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. Remove a DAC from the 10G port

    Remove the DAC