Bluecat DNS DHCP
Bluecat DNS DHCP
Bluecat DNS DHCP
0
Feb 0 2, 20 17
Introduction
Release Notes
Hardware Installation
Common Hardware Components
Hardware Platforms
Initial Configuration
Managing Interfaces
Monitoring and Managing the Real-T ime Status of Entities Configured on NetScaler Devices
Converting a NetScaler MPX 24100 and 24150 Appliance to a NetScaler SDX 24100 and 24150 Appliance
Generating Partition MAC Addresses to Configure Admin Partition on a NetScaler Instance in the SDX Appliance
Consolidation When the Management Service and the NetScaler Instances are in Different Networks
Websense Protector
BlueCat DNS/DHCP
CA Access Gateway
NITRO API
Obtaining the NIT RO Package
Java SDK
.NET SDK
NetScaler
XenServer
T he Citrix NetScaler SDX appliance provides a Management Service that is pre-provisioned on the appliance. T he
Management Service provides a user interface (HT T P and HT T PS modes) and an API to congure, manage, and monitor the
appliance, the Management Service, and the instances. A Citrix self-signed certicate is prepackaged for HT T PS support.
Citrix recommends that you use the HT T PS mode to access the Management Service user interface.
For detailed information about SDX 11.1 enhancements, known issues, and bug fixes, see: NetScaler Release Notes.
Before you decide to upgrade any component of NetScaler SDX, make sure to refer the following points:
Some NetScaler SDX features have minimum version requirements across various NetScaler SDX components. Refer
table 2 for detailed information.
Any combinations of Management Service and NetScaler versions are supported as long as they meet minimum version
requirements for a particular hardware platform.
1. Refer T able 1 for NetScaler SDX hardware, Management Service and NetScaler version compatibility.
2. Refer table 2 for specific feature-component compatibility.
A NetScaler SDX appliance is always shipped with a validated and tested release bundle (that includes a specific
combination of Management Service, XenServer and XS Supplemental Pack versions), and will work out of the box. It is
advised that users looking to upgrade any of these components upgrade to an appropriate release bundle as
recommended on the Citrix download page"
XenServer and supplement packs should be upgraded based on a features requirement, else they should be kept as
those shipped from the factory. Refer table 2 to understand the feature-component compatibility information. If you
need to upgrade XenServer and supplemental packs, then you must download the images for XenServer and
supplemental packs from the Citrix NetScaler SDX Download page.
Make sure to check the Citrix NetScaler SDX download page for the recommended hot fixes applicable for the
Management Service version.
T he following table lists the compatible NetScaler and Management Service versions for NetScaler SDX platform:
T able 1. NetScaler and Management Service Versions f or NetScaler SDX Platf orm
1. Release 9.3 build 52.3 and later 1. Release 9.3 build 52.3 and later
2. Release 10.1 build 118.7 and 2. Release 10.1 build 118.7 and later
later 3. Release 10.5 build 50.10 and later
3. Release 10.5 build 50.10 and 4. Release 11.0 build 66.11 and later
later 5. Release 11.1 build 47.14 and later
4. Release 11.0 build 66.11 and
later
5. Release 11.1 build 47.14 and
later
1. Release 10.0 build 74.4 and 1. Release 10.0 build 74.4 and later
later 2. Release 10.1 build 118.7 and later
2. Release 10.1 build 118.7 and 3. Release 10.5 build 50.10 and later
later 4. Release 11.0 build 66.11 and later
3. Release 10.5 build 50.10 and 5. Release 11.1 build 47.14 and later
later
4. Release 11.0 build 66.11 and
later
5. Release 11.1 build 47.14 and
later
Not Supported
Release 9.3
1. Release 10.1, build 123.11 and 1. Release 10.1, build 123.11 and later
later 2. Release 10.5 build 52.11 and later
2. Release 10.5 build 52.11 and 3. Release 11.0 build 66.11 and later
later 4. Release 11.1 build 47.14 and later
3. Release 11.0 build 66.11 and
Not Supported
later
4. Release 11.1 build 47.14 and Release 9.3
later
Not Supported
Release 9.3
1. Release 10.1, build 124.13 and 1. Release 10.1, build 124.13 and later
later 2. Release 10.5 build 50.10 and later
2. Release 10.5 build 50.10 and 3. Release 11.0 build 66.11 and later
later 4. Release 11.1 build 47.14 and later
3. Release 11.0 build 66.11 and
Not Supported
later
4. Release 11.1 build 47.14 and Release 9.3
later
Not Supported
Release 9.3
1. Release 10.1, build 129.11 and 1. Release 10.1, build 129.11 and later
later 2. Release 10.5 build 51.10 and later
2. Release 10.5 build 51.10 and 3. Release 11.0 build 66.11 and later
Not Supported
Release 9.3
1. Release 10.5, build 59.22, 60.83, 1. Release 10.5, build 59.22, 60.83,
62.9 and later 62.9 and later
2. Release 11.0, Build 66.11 and 2. Release 11.0, build 65.31, 66.11 and
later later
3. Release 11.1 build 47.14 and 3. Release 11.1 build 47.14 and later
later
Not Supported
Not Supported
Release 10.1 and earlier
Release 10.1 and earlier
Supported
Supported
1. Release 10.5, build 60.83, 62.9
and later 1. Release 10.5, build 60.83, 62.9 and
2. Release 11.0, Build 66.11 and later
SDX 14020-40G/14040-40G/14060- later 2. Release 11.0, Build 66.11 and later
40G/14080-40G/25100-40G/25160-40G 3. Release 11.1 build 47.14 and 3. Release 11.1 build 47.14 and later
later
Not Supported
Not Supported
Release 10.1 and earlier
Release 10.1 and earlier
T he following table lists the compatible NetScaler and Management Service versions for NetScaler SDX platform:
*SDX 22040/22060/22080/22100 platforms require XenServer supplemental pack 100013 and higher.
T he following table lists the compatible NetScaler SDX components and feature compatibility. Component implies
Management Service, NetScaler, XenServer and XenServer Supplemental Pack versions.
VLAN Whitelist Supported Supported Release 6.0 Build 100007 and higher
1. Release 10.1, build 1. Release 10.1, build and later
118.7 and later 118.7 and later
2. Release 10.5 build 2. Release 10.5 build
50.10 and later 50.10 and later
Palo Alto Guest Supported NA Release 6.1 Build 100012 and higher
VM 1. Release 10.5 build and later
50.10 and later
Not Supported
Release 9.3
T he Citrix NetScaler SDX appliance is a multi-tenant platform on which you can provision and manage multiple virtual
instances of NetScaler.
On some NetScaler SDX appliances, the LCD on the front panel displays the appliance's model number, but the number
shown might not be the licensed model number. To view the licensed model number of any SDX appliance, log on to the
Management Service and check the licensed model number in the top left corner of the screen. For example, if you have
purchased an SDX 11515 license, the LCD screen displays CIT RIX NSSDX-11500, and the Management Service screen
displays NetScaler SDX (11515).
T he LCD backlight on the NetScaler SDX 22040/22060/22080/22100/22120 is always on. For all other SDX appliances, the
LCD backlight lights up only when the appliance is restarted or powered on. T he backlight on these appliances remains on
for some time and automatically turns off.
On the appliances back panel, system status LEDs indicate the overall status of the appliance. T he following table
describes the indicators of the system status LED.
Note: System status LEDs are available on only the SDX 22040/22060/22080/22100/22120 and SDX 24100/24150
appliances.
OFF No power
On the appliances back panel, power status LEDs indicate the status of each power supply. T he following table describes
the indicators of the power status LED.
OFF No power
T he port LEDs show whether a link is established and trafc is owing through the port. T he following table describes the
LED indicators for each port. T here are two LED indicators for each port type.
Ethernet (RJ45) Left Speed Off No connection, or a traffic rate of 10 megabits per
second (Mbps).
On each power supply, a bicolor LED indicator shows the condition of the power supply.
Ports are used to connect the appliance to external devices. NetScaler appliances support RS232 serial ports,
10/100/1000Base-T copper Ethernet ports, 1-gigabit copper and fiber 1G SFP ports, and 10-gigabit fiber SFP+ ports. All
NetScaler appliances have a combination of some or all of these ports. For details on the type and number of ports
available on your appliance, see the section describing that platform.
RS232 Serial Port
T he RS232 serial console port provides a connection between the appliance and a computer, allowing direct access to the
appliance for initial conguration or troubleshooting.
All hardware platforms ship with an appropriate serial cable used to connect your computer to the appliance. For
instructions on connecting your computer to the appliance, see "Installing the Hardware."
T here are two types of copper Ethernet ports that may be installed on your appliance:
10/100BASE-T port
T he 10/100BASE-T port has a maximum transmission speed of 100 megabits per second (Mbps). Most platforms have at
least one 10/100BASE-T port.
10/100/1000BASE-T port
T he 10/100/1000BASE-T port has a maximum transmission speed of 1 gigabit per second, ten times faster than the other
type of copper Ethernet port. Most platforms have at least one 10/100/1000Base-T port.
To connect any of these ports to your network, you plug one end of a standard Ethernet cable into the port and plug the
other end into the appropriate network connector.
Management Ports
Management ports are standard copper Ethernet ports (RJ45), which are used for direct access to the appliance for system
administration functions.
T he 10G SFP+ ports are high-speed ports that can operate at speeds of up to 10 Gbps. You need a ber optic cable to
connect to a 10G SFP+ port. If the other end of the ber optic cable is attached to a 1G SFP port, the 10G SFP+ port
automatically negotiates to match the speed of the 1G SFP port.
Ports Compatibility
50/125um 550 m
MMF,
400MHz-
km
62.5/125um 300 m
MMF,
200MHz-
km (OM1)
50/125um 550 m
MMF,
400MHz-
km
62.5/125um 275 m
MMF,
200MHz-
km (OM1)
62.5/125um 220 m
MMF,
160MHz-
km
10 GE Pluggable Media
T he following table lists the maximum distance specications for 10G transceivers.
50/125um 66 m
MMF,
400MHz-
km
62.5/125um 33 m
MMF,
200MHz-
km (OM1)
Note: T he solid-state or hard-disk drive stores your configuration information, which has to be restored from a backup
after replacing the unit.
T his document includes the following details:
Power Supply
Solid-State Drive
Hard Disk Drive
Direct Attach Cable
For appliances containing two power supplies, the second power supply acts as a backup. T he SDX
22040/22060/22080/22100/22120 and SDX 24100/24150 appliances can accommodate four power supplies, and require
two power supplies for proper operation. T he third and fourth power supplies act as backup.
T he appliance ships with a standard power cord that plugs into the appliances 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 specications, see "Hardware Platforms," which describes the various platforms and includes a table
summarizing the hardware specications.
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.
Note: If the appliance has only one power supply, you have to shut down the appliance before replacing the 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. T o silence the alarm, press the small red button on the back panel of
the appliance. T he disable alarm button is functional only when the appliance has two power supplies.
Replacing a DC Power Supply
Citrix NetScaler SDX platforms can accommodate two power supplies, except the SDX 22040/22060/22080/22100/22120
and SDX 24100/24150 platforms which can accommodate four power supplies. All NetScaler appliances function properly
with a single power supply, except the SDX 22040/22060/22080/22100/22120 and SDX 24100/24150 platforms which
need two power supplies for proper operation. T he 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.
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. T o silence the alarm, press the small red button on the back panel of
the appliance. T he disable alarm button is functional only when the appliance has two power supplies.
A solid-state drive (SSD) is a high-performance device that stores data in solid-state flash memory.
Replacing a Solid-State Drive
To replace a solid-state drive on SDX 2204 0/22060/22080/22100/22120 and SDX 24 100/24 150 appliances
Note: NetScaler SDX 22040/22060/22080/22100/22120 and SDX 24100/24150 appliances are shipped with four SSDs,
which contain pre-installed configurations of the NetScaler software. From the left, the first and second SSDs are mirrored
and store the configurations of the SDX appliance. T he third and fourth SSDs, which are also mirrored, provide storage for
the NetScaler instances running on the SDX appliance. All the SSDs are hot-swappable.
You can purchase up to four additional SSDs, in groups of two.
1. Locate the SSD on the back panel of the appliance. Push the safety latch of the drive cover down while pulling out on
the drive handle to disengage. Pull out the faulty drive.
Figure 5. Removing the Existing Solid-State Drive
After you replace one of the SSDs, the conguration on the other SSD in the mirrored SSD is copied to the replacement
SSD.
Note: NetScaler SDX 22040/22060/22080/22100/22120 and SDX 24100/24150 appliances support up to 80 instances.
However, the mirrored SSDs in the third and fourth slots provide only enough storage for up to a maximum of 30
instances. T o provision more instances on the appliance, you must purchase and install additional SSDs.
To add additional SSDs on SDX 2204 0/22060/22080/22100/22120 and SDX 24 100/24 150 appliances
Put the rst new SSD into the leftmost empty slot, and put the second new SSD into the adjacent empty slot.
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. After installing the
replacement SSD, you have to restore the configuration files and customized settings from backup storage. If no backups
are available, you have to reconfigure the appliance. T he files to be restored might include:
/flash/nsconfig/ns.conf: T he current configuration file.
/flash/nsconfig/ZebOS.conf: T he ZebOS configuration file.
/flash/nsconfig/license: T he licenses for the NetScaler features.
/flash/nsconfig/ssl: T he SSL certificates and keys required for encrypting data sent to clients or servers.
1. In the configuration utility of the Management Service, navigate to Configuration > System, and in the System pane,
click Shutdown Appliance.
2. 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: T he illustration in the following figures might not represent your actual NetScaler appliance.
Figure 7. Removing the Existing Solid-State Drive
3. Verify that the replacement SSD is the correct type for the platform.
4. 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. T o
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
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. T he 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.
Replacing a Hard Disk Drive
5. 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.
T o 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
A direct attach cable (DAC) assembly is a high performance integrated duplex data link for bi-directional communication.
T he cable is compliant with the IPF MSA (SFF-8432) for mechanical form factor and SFP+ MSA for direct attach cables.
T he 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 ber optic cables.) T he transceiver with DAC is hot-swappable.
You can insert and remove the transceiver with the attached cable without shutting down the appliance. T he Citrix
NetScaler appliance supports only passive DAC.
Note: Autonegotiation is not supported on an interface to which a direct attach cable (DAC) is connected.
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.
1. T o 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. T o 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
T he Citrix NetScaler SDX appliance is a multi-tenant platform on which you can provision and manage multiple virtual
instances of NetScaler.
T he following gure shows the front panel of the SDX 8015/8400/8600 (6x10/100/1000Base-T copper Ethernet ports +
6x1G SFP) appliance.
Figure 1. Citrix NetScaler SDX 8015/8400/8600 (6x10/100/1000Base-T copper Ethernet ports + 6x1G SFP), front panel
T he following gure shows the front panel of the SDX 8015/8400/8600 (6x10/100/1000Base-T copper Ethernet ports +
2x10G SFP+) appliance.
Figure 2. Citrix NetScaler SDX 8015/8400/8600 (6x10/100/1000Base-T copper Ethernet ports + 2x10G SFP+), front panel
T he following gure shows the back panel of the SDX 8015/8400/8600 appliance.
T he following components are visible on the back panel of the SDX 8015/8400/8600 appliance:
256 GB removable solid-state drive, which is used to store the NetScaler software and the user data.
Power switch, which turns off power to the appliance, just as if you were to unplug the power supply. Press the switch
for five seconds to turn off the power.
USB port (reserved for a future release).
Non-maskable interrupt (NMI) button, which is used at the request of T echnical Support to produce a NetScaler core
dump. You must use a pen, pencil, or other pointed object to press this red button, which is recessed to prevent
unintentional activation.
Disable alarm button, which is nonfunctional. T his button is functional only if you install a second power supply.
Press this button to stop the power alarm from sounding when you have plugged the appliance into only one power
outlet or when one power supply is malfunctioning and you want to continue operating the appliance until it is repaired.
T he following gure shows the front panel of the SDX 11500/13500/14500/16500/18500/20500 appliance.
10/100Base-T copper Ethernet Port (RJ45), also called LOM port. You can use this port to remotely monitor and manage
the appliance independently of the NetScaler software.
Note: T he LEDs on the LOM port are not operational by design.
RS232 serial console port.
T wo 10/100/1000Base-T copper Ethernet management ports (RJ45), numbered 0/1 and 0/2 from left to right. T hese
ports are used to connect directly to the appliance for system administration functions.
Eight 1G SFP ports numbered 1/1, 1/2, 1/3, 1/4 from top to bottom in the first column, and 1/5, 1/6, 1/7, and 1/8 from
top to bottom in the second column.
Four 10GE SFP+ ports numbered 10/1 and 10/2 from top to bottom in the first column, and 10/3 and 10/4 from top to
bottom in the second column.
T he following gure shows the back panel of the SDX 11500/13500/14500/16500/18500/20500 appliance.
160 GB removable solid-state drive that is used to store the NetScaler software.
USB port (reserved for a future release).
Power switch, which turns off power to the appliance, just as if you were to unplug the power supply. Press the switch
for five seconds to turn off the power.
Non-maskable interrupt (NMI) Button that is used at the request of T echnical Support and produces a core dump on the
NetScaler. You must use a pen, pencil, or other pointed object to press this red button, which is recessed to prevent
unintentional activation.
T wo removable hard-disk drives that are used to store user data.
Disable alarm button. T his button is functional only when the appliance has two power supplies.
Press this button to stop the power alarm from sounding when you have plugged the appliance into only one power
outlet or when one power supply is malfunctioning and you want to continue operating the appliance until it is repaired.
T he following gure shows the back panel of the SDX 11515/11520/11530/11540/11542 appliance.
256 GB removable solid-state drive that is used to store the NetScaler software.
USB port (reserved for a future release).
Power switch, which turns off power to the appliance, just as if you were to unplug the power supply. Press the switch
for five seconds to turn off the power.
Non-maskable interrupt (NMI) Button that is used at the request of T echnical Support and produces a core dump on the
NetScaler. You must use a pen, pencil, or other pointed object to press this red button, which is recessed to prevent
unintentional activation.
T wo removable hard-disk drives that are used to store user data.
Disable alarm button. T his button is functional only when the appliance has two power supplies.
Press this button to stop the power alarm from sounding when you have plugged the appliance into only one power
outlet or when one power supply is malfunctioning and you want to continue operating the appliance until it is repaired.
T he following gure shows the front panel of the SDX 17500/19500/21500 appliance.
T he following gure shows the back panel of the SDX 17500/19500/21500 appliance.
T he following components are visible on the back panel of the SDX 17500/19500/21500 appliance:
160 GB removable solid-state drive that is used to store the NetScaler software.
USB port (reserved for a future release).
Power switch, which turns off power to the appliance, just as if you were to unplug the power supply. Press the switch
for five seconds to turn off the power.
Non-maskable interrupt (NMI) button that is used at the request of T echnical Support and produces a core dump on the
NetScaler. You must use a pen, pencil, or other pointed object to press this red button, which is recessed to prevent
unintentional activation.
T he following gure shows the front panel of the SDX 17550/19550/20550/21550 appliance.
10/100Base-T copper Ethernet Port (RJ45), also called LOM port. You can use this port to remotely monitor and manage
the appliance independently of the NetScaler software.
Note: T he LEDs on the LOM port are not operational by design.
RS232 serial console port.
T wo 10/100/1000Base-T copper Ethernet management ports (RJ45), numbered 0/1 and 0/2 from left to right. T hese
ports are used to connect directly to the appliance for system administration functions.
Eight 10GE SFP+ ports numbered 10/1, 10/2, 10/3, and 10/4 on the top row from left to right, and 10/5, 10/6, 10/7, and
10/8 on the bottom row from left to right.
T he following gure shows the back panel of the SDX 17550/19550/20550/21550 appliance.
T he following components are visible on the back panel of the SDX 17550/19550/20550/21550 appliance:
160 GB removable solid-state drive that is used to store the NetScaler software.
USB port (reserved for a future release).
Power switch, which turns off power to the appliance, just as if you were to unplug the power supply. Press the switch
for five seconds to turn off the power.
Non-maskable interrupt (NMI) button that is used at the request of T echnical Support and produces a core dump on the
The following gure shows the front panel of the SDX 22040/22060/22080/22100/22120 (12x1G SFP + 24x10G SFP+) appliance.
Figure 1. Citrix NetScaler SDX 22040/22060/22080/22100/22120 (12x1G SFP + 24x10G SFP+), front panel
The following gure shows the front panel of the SDX 22040/22060/22080/22100/22120 (24x10G SFP+) appliance.
The following gure shows the back panel of the SDX 22040/22060/22080/22100/22120 appliances.
Non-maskable interrupt (NMI) Button, used at the request of Technical Support to initiate a core dump. To press this red button, which is
recessed to prevent unintentional activation, use a pen, pencil, or other pointed object. The NMI Button is also available remotely over the
network in the LOM GUI, in the Remote Control menu.
System status LED, which indicates the status of the appliance, as described in LCD Display and LED Status Indicators.
Note: On an SDX 22040/22060/22080/22100/22120 appliance running LOM firmware version 3.22, the system status LED indicates an error
(continuously glows RED) even though the appliance is functioning properly.
Four power supplies, each rated at 750 watts, 100-240 volts. A minimum of two power supplies are required for proper operation. The extra
power supplies act as backup. Each power supply has an LED that indicates the status of the power supply, as described in LCD Display
and LED Status Indicators.
Power switch, which turns off power to the appliance. Press the switch for less than two seconds to turn off the power.
256 GB removable solid-state drives.
T he following gure shows the front panel of the SDX 24100/24150 (12x1G SFP + 24x10G SFP+) appliance.
Figure 1. Citrix NetScaler SDX 24100/24150 (12x1G SFP + 24x10G SFP+), front panel
T he following gure shows the back panel of the SDX 24100/24150 appliances.
Non-maskable interrupt (NMI) Button, used at the request of T echnical Support to initiate a core dump. T o press this red
button, which is recessed to prevent unintentional activation, use a pen, pencil, or other pointed object. T he NMI Button
is also available remotely over the network in the LOM GUI, in the Remote Control menu.
System status LED, which indicates the status of the appliance, as described in LCD Display and LED Status Indicators.
Note: On an SDX 24100/24150 appliance running LOM firmware version 3.22, the system status LED indicates an error
(continuously glows RED) even though the appliance is functioning properly.
Four power supplies, each rated at 750 watts, 100-240 volts. A minimum of two power supplies are required for proper
operation. T he extra power supplies act as backup. Each power supply has an LED that indicates the status of the
power supply, as described in LCD Display and LED Status Indicators.
Power switch, which turns off power to the appliance. Press the switch for less than two seconds to turn off the
power.
Four 600 GB removable solid-state drives. T he first two leftmost solid-state drives store the NetScaler software. T he
next two solid-state drives store user data. Additionally, you can extend the SSD storage (optional) by another 2 or 4
600 GB SSDs.
Not e: For information about NetScaler SDX hardware and component compatibility matrix, see https://docs.citrix.com/en-us/sdx/11/sdx-ag-
supported-versions-ref.html.
The following gure shows the front panel of the SDX 14020/14030/14040/14060/14080/ 14100 ( 16x10G SFP+) appliance.
Figure 1. Cit rix Net Scaler SDX 14020/14030/14040/14060/14080/14100 ( 16x10G SFP+), f ront panel
Note: T he 10G SFP+ ports on these appliances support copper 1G SFP transceivers.
T he following gure shows the back panel of the SDX 14020/14030/14040/14060/14080/ 14100 appliance.
Figure 2. Citrix NetScaler SDX 14 020/14 030/14 04 0/14 060/14 080/14 100, back panel
T wo 240 GB removable solid-state drives (SSDs). T he two leftmost solid-state drives store the NetScaler software. T he
next two solid-state drives, of 300 GB each, store user data. T he remaining four solid-state drives are reserved for future
use. T he NetScaler SDX 14040 appliance has six 300 GB SSDs and NetScaler SDX 14060/14080/14100 appliances have
eight 300 GB SSDs. T hese appliances are redundant array of independent disks (RAID) devices. For more information, see
http://docs.citrix.com/en-us/sdx/11/manage-monitor-appliance-network-configuration/raid-introduction.html.
Power switch, which turns power to the appliance on or off. Press the switch for less than two seconds to turn off the
power.
T wo power supplies, each rated at 1000 watts, 100-240 volts. Each power supply has an LED that indicates the status of
the power supply, as described in http://docs.citrix.com/en-us/sdx/11/hardware-installation/common-hardware-
components.html.
Disable alarm button, which is functional only when the appliance has two powersupplies. Press this button to stop the
power alarm from sounding when you have plugged the appliance into only one power outlet, or when one power supply
is malfunctioning and you want to continue operating the appliance until it is repaired.
Non-maskable interrupt (NMI) Button, used at the request of T echnical Support to initiate a core dump. T o press this
red button, which is recessed to prevent unintentional activation, use a pen, pencil, or other pointed object. T he NMI
Button is also available remotely over the network in the LOM GUI, in the Remote Control menu. For more information
about the lights out management port of the appliance, see http://docs.citrix.com/en-us/sdx/11/hardware-
installation/lights-out-management-port-lom-of-sdx.html.
Memory 32 GB 48 GB 48 GB
Ports - 1G 6x1G SFP + 8x1G SFP ports 8x1G SFP + 4 x10G SFP+ model:
6x10/100/1000Base-T
8xcopper/ber 1G SFP ports
copper Ethernet model:
8x1G SFP + 8x10/100/1000Base-
6xcopper/ber 1G SFP
T copper Ethernet model:
ports,
6xcopper/ber 1G SFP
ports,
Ports - 10G 2x10G SFP+ 4x10G SFP+ ports 8x1G SFP + 4 x10G SFP+ model:
6x10/100/1000Base-T
4x10G SFP+ ports
copper Ethernet model:
Number of Power 1 2 2
Supplies
Maximum NetScaler 5 20 20
Instances
Heat Dissipation 630 BT U per hour 2200 BT U per hour 2200 BT U per hour
14.52 kg 20.87 kg
Height 1U 2U 2U
Width EIA 310-D for 19-inch EIA 310-D for 19-inch racks EIA 310-D for 19-inch racks
racks
Operating 0 40 C 0-40 0 40 C
Temperature
32 104 F 32 104 F
(degree Celsius)
EMC & FCC (Part 15 Class A), CE, FCC (Part 15 Class A), CE, C- FCC (Part 15 Class A), CE, C-T ick,
Susceptibility C-T ick, VCCI-A T ick, VCCI, CCC, KC, NOM, VCCI, CCC, KC, NOM, GOST, SABS,
GOST, SABS, SASO SASO
Processors 2 six-core (24 2 six-core (24 cores 2 eight-core (32 cores 2 eight-core (32 cores
cores with with hyper- with hyper-threading ) with hyper-threading )
hyper-threading) threading)
Ports - 10G 8x10G SFP+ 8x10G SFP+ ports 12x1G SFP + 24 x10G 12x1G SFP + 24 x10G
ports SFP+ model: SFP+ model:
Number of Power 2 2 4 4
Supplies
Maximum NetScaler 20 40 80 80
Instances Supported
AC Power Supply 100-240 VAC 100-240 VAC 12x1G SFP + 24 x10G 12x1G SFP + 24 x10G
input voltage, SFP+ model: SFP+ model:
50-60 Hz 50-60 Hz
frequency, & current
100-240VAC 100-240VAC
6.5-3.5 A 6.5-3.5 A
50/60Hz 50/60Hz
6.0-12.0A 6.0-12.0A
100-240VAC
Maximum Power 650 W 850 W 12x1G SFP + 24 x10G 12x1G SFP + 24 x10G
Consumption SFP+ model: SFP+ model:
1050 W 1050 W
1400 W
Heat Dissipation 2200 BT U per 2900 BT U per hour 12x1G SFP + 24 x10G 12x1G SFP + 24 x10G
hour SFP+ model: SFP+ model:
38.56 kg 38.56 kg
Height 2U 2U 2U 2U
Width EIA 310-D for EIA 310-D for 19- EIA 310-D for 19-inch EIA 310-D for 19-inch
19-inch racks inch racks racks racks
EMC & Susceptibility FCC (Part 15 FCC (Part 15 Class FCC (Part 15 Class A), CE FCC (Part 15 Class A),
Only trained and qualied personnel should install, maintain, or replace the appliance, and efforts should be taken to ensure
that all cautions and warnings are followed.
T he hardware accessories for your particular appliance, such as cables, adapters, and rail kit, vary depending on the
hardware platform you ordered. Unpack the box that contains your new appliance on a sturdy table with plenty of space
and inspect the contents.
Use the following list to verify that you received everything that should have been included in the box.
T he appliance you ordered
One RJ-45 to DB-9 adapter
One 6 ft RJ-45/DB-9 cable
T he following list specifies the number of power cables included for each appliance model:
One power cable for the SDX 8015/8400/8600 appliances
T wo power cables for the SDX 11500/13500/14500/16500/18500/20500, SDX 11515/11520/11530/11540/11542, and
SDX 17500/19500/21500, and SDX 17550/19550/20550/21550 appliances
Four power cables for the SDX 22040/22060/22080/22100/22120 and SDX 24100/24150 appliances
Note: Make sure that a power outlet is available for each cable.
Note: For Brazilian customers, Citrix does not ship a power cable. Use a cable that conforms to the ABNT NBR
14 136:2002 standard.
One standard 4-post rail kit
Note: If the kit that you received does not fit your rack, contact your Citrix sales representative to order the appropriate
kit.
In addition to the items included in the box with your new appliance, you will need the following items to complete the
installation and initial configuration process.
Ethernet cables for each additional Ethernet port that you will connect to your network
One available Ethernet port on your network switch or hub for each NetScaler Ethernet port you want to connect to
your network
Note: T ransceiver modules are sold separately. Contact your Citrix sales representative to order transceiver modules for
your appliance. Only transceivers supplied by Citrix are supported on the appliance.
A computer to serve as a management workstation
Site Requirements
T he appliance should be installed in a server room or server cabinet with the following features:
Environment control
An air conditioner, preferably a dedicated computer room air conditioner (CRAC), capable of maintaining the cabinet or
server room at a temperature of no more than 27 degrees C/80.6 degrees F at altitudes of up to 2100 m/7000 ft, or 18
degrees C/64.4 degrees F at higher altitudes, a humidity level no greater than 45 percent, and a dust-free environment.
Power density
Wiring capable of handling at least 4,000 watts per rack unit in addition to power needs for the CRAC.
Rack Requirements
T he rack on which you install your appliance should meet the following criteria:
Rack characteristics
Racks should be either integrated into a purpose-designed server cabinet or be the floor-to-ceiling type, bolted down at
both top and bottom to ensure stability. If you have a cabinet, it should be installed perpendicular to a load-bearing wall for
stability and sufficient airflow. If you have a server room, your racks should be installed in rows spaced at least 1 meter/3
feet apart for sufficient airflow. Your rack must allow your IT personnel unfettered access to the front and back of each
server and to all power and network connections.
Power connections
At minimum, two standard power outlets per unit.
Network connections
At minimum, four Ethernet connections per rack unit.
Space requirements
One empty rack unit for the Citrix NetScaler SDX 8015/8400/8600, and two consecutive empty rack units for all other
appliance models.
Appliance Precautions
Determine the placement of each component in the rack before you install the rails.
Install the heaviest appliance first, at the bottom of the rack, and then work upward. Distribute the load on the rack
evenly. An unbalanced rack is hazardous.
Allow the power supply units and hard drives to cool before touching them.
Install the equipment near an electrical outlet for easy access.
Mount equipment in a rack with sufficient airflow for safe operation.
For a closed or multiple-unit rack assembly, the ambient operating temperature of the rack environment might be
Most appliances can be installed in standard server racks that conform to EIA-310-D specication. T he appliances ship with
a set of rails, which you must install before you mount the appliance. T he only tools that you need for installing an
appliance are a Phillips screwdriver and a athead screwdriver.
Caution: If you are installing the appliance as the only unit in the rack, mount it at the bottom. If the rack contains other
units, make sure that the heaviest unit is at the bottom. If the rack has stabilizing devices available, install them before
mounting the appliance.
T he following table lists the different hardware platforms and the rack units required for each platform.
Table 1. Height Requirements For Each Platf orm
T he appliance is shipped with rack-rail hardware. T his hardware consists of two inner rails that you attach to the appliance,
one on each side, and a rack-rail assembly that you attach to the rack. T he following gure illustrates the steps involved in
mounting the Citrix NetScaler SDX appliance to a rack.
4. Repeat steps 1 through 3 to install the left inner rail on the other side of the appliance.
3. Install the adjustable rail assembly into the rack as shown in the following figures. Use a screw to lock the rear rail flange
into the rack. With the screw securing the rail in place, you can optionally remove the latching spring.
Figure 4. Installing the Rail Assembly to the Rack
Note: T his section applies to the SDX 8015/8400/8600, SDX 11500/13500/14500/16500/18500/20500, SDX
11515/11520/11530/11540/11542, SDX 22040/22060/22080/22100/22120, and SDX 24100/24150 appliances.
A Small Form-Factor Pluggable (SFP) is a compact transceiver that can operate at speeds of up to 1 gigabit per second and
is available in both copper and ber types. Inserting a 1G SFP copper transceiver converts the 1G SFP port to a 1000BASE-T
port. Inserting a 1G SFP ber transceiver converts the 1G SFP port to a 1000BASE-X port. Auto-negotiation is enabled by
default on the 1G SFP port into which you insert your 1G SFP transceiver. As soon as a link between the port and the
network is established, the speed and mode are matched on both ends of the cable.
Caution: NetScaler appliances do not support 1G SFP transceivers from vendors other than Citrix Systems. Attempting to
install third-party 1G SFP transceivers on your NetScaler appliance voids the warranty.
Insert 1G SFP transceivers into the 1G SFP ports on the front panel of the appliance. Frequent installation and removal of
transceivers shortens their life span. Follow the removal procedure carefully to avoid damaging the 1G SFP transceiver or
the appliance.
Caution: Do not install the transceivers with the cables attached. Doing so can damage the cable, the connector, or the
optical interface of the transceiver.
To install a 1G SFP transceiver
1. Remove the 1G SFP transceiver carefully from its box.
Danger: Do not look directly into fiber optic transceivers or cables. T hey emit laser beams that can damage your eyes.
2. Align the 1G SFP transceiver to the front of the 1G SFP transceiver port on the front panel of the appliance, as shown in
the following figure.
Note: T he illustration in the following figures might not represent your actual appliance.
Figure 6. Installing a 1G SFP transceiver
Note: T his section applies to the SDX 8015/8400/8600, SDX 11500/13500/14500/16500/18500/20500, SDX
11515/11520/11530/11540/11542, SDX 17500/19500/21500, SDX 17550/19550/20550/21550, SDX
22040/22060/22080/22100/22120 , and SDX 24100/24150 appliances.
A 10-Gigabit Small Form-Factor Pluggable (SFP+) is a compact optical transceiver that can operate at speeds of up to 10
gigabits per second. Autonegotiation is enabled by default on the 10G SFP+ ports into which you insert your 10G SFP+
transceiver. As soon as a link between the port and the network is established, the mode is matched on both ends of the
cable and for 10G SFP+ transceivers, the speed is also autonegotiated.
Caution: NetScaler appliances do not support 10G SFP+ transceivers provided by vendors other than Citrix Systems.
Attempting to install third-party 10G SFP+ transceivers on your NetScaler appliance voids the warranty.
Insert the 10G SFP+ transceivers into the 10G SFP+ ports on the front panel of the appliance. Frequent installation and
removal of transceivers shortens their life span. Follow the removal procedure carefully to avoid damaging the transceiver or
the appliance.
Caution: Do not install the transceivers with the cables attached. Doing so can damage the cable, the connector, or the
optical interface of the transceiver.
When the appliance is securely mounted on the rack, you are ready to connect the cables. Ethernet cables and the optional
console cable are connected rst. Connect the power cable last.
Danger: Before installing or repairing the appliance, remove all jewelry and other metal objects that might come in contact
with power sources or wires. When you touch both a live power source or wire and ground, any metal objects can heat up
rapidly and cause burns, set clothing on fire, or fuse the metal object to an exposed terminal.
Connecting the Ethernet Cables
Ethernet cables connect your appliance to the network. T he type of cable you need depends on the type of port used to
connect to the network. Use a category 5e or category 6 Ethernet cable with a standard RJ-45 connector on a
10/100/1000BASE-T port or 1G SFP copper transceiver. Use a ber optic cable with an LC duplex connector with a 1G SFP
ber transceiver, 10G SFP+ transceiver. T he type of connector at the other end of the ber optic cable depends on the
port of the device that you are connecting to.
1. Insert the RJ-45 connector on one end of your Ethernet cable into an appropriate port on the front panel of the
appliance, as shown in the following figure.
Figure 7. Inserting an Ethernet cable
2. Insert the RJ-45 connector on the other end into the target device, such as a router or switch.
1. Insert the DB-9 connector at the end of the cable into the console port that is located on the front panel of the
appliance, as shown in the following figure.
Figure 8. Inserting a console cable
Note: T o use a cable with an RJ-45 converter, insert the optional converter provided into the console port and attach
the cable to it.
2. Insert the RJ-45 connector at the other end of the cable into the serial port of the computer or terminal.
1. Connect one end of the power cable to the power outlet on the back panel of the appliance, next to the power supply,
as shown in the following figure.
Figure 9. Inserting a power cable
After you have installed the appliance in a rack and connected the cables, verify that the power cable is properly
connected. If you have installed a second power supply, make sure the second cable is connected to an outlet for a
different circuit than the first. After verifying the connections, you are ready to switch on the appliance.
To switch on the appliance
1. Verify that the appliance is connected through a console or Ethernet port. T his will ensure that you can configure the
appliance after it is switched on.
2. Press the ON/OFF toggle power switch on the back panel of the appliance.
Caution: Be aware of the location of the emergency power off (EPO) switch, so that if an electrical accident occurs you
can quickly remove power from the appliance.
NetScaler SDX IP address and subnet mask: T he management IP address and the mask used to define the subnet in
which the SDX appliance is located. T his IP address is used to access the NetScaler SDX Management Service user
interface.
XenServer IP address: T he IP address of the XenServer hypervisor.
Default gateway: T he IP address of the router that forwards traffic out of the appliances subnet. T he default gateway
should be in the same subnet as the NSIP address.
Root password: T he root user (nsroot) has full administrative privileges on the appliance. T he root password is used to
authenticate the root user. T he default root password is nsroot. You can change this password during initial
configuration of the appliance.
T o set up the appliance by using the Management Service user interface, connect a workstation or laptop to the same
network as the appliance.
To congure the NetScaler SDX appliance by using the Management Service user
interface
1. Connect the NetScaler SDX appliance to a management workstation or network by using interface 0/1.
Note: T he NetScaler SDX Management Service is preconfigured with the IP address 192.168.100.1 and the XenServer
hypervisor is preconfigured with the IP address 192.168.100.2.
Note
c. In the Gateway eld, enter the IP address of the router that forwards trafc out of the appliance's subnet.
d. In the DNS eld, enter the IPv4 address of the primary DNS server.
Note: IPv6 addresses are not support for primary DNS server.
e. Select the IPv4 checkbox if you want to use IPv4 address for the Management Service and enter the details for
the following parameters:
i. Appliance Management IP T he IPv4 address that is used to access the Management Service by using a Web
browser.
ii. Netmask T he mask used to dene the subnet in which the SDX appliance is located.
f. Select the IPv6 checkbox if you want to use IPv6 address for the Management Service and enter the details for the
following parameters:
i. Management Service IP Address T he IPv6 address that is used to access the Management Service by using a
Web browser.
Note: T he XenServer IP address and Management Service IP address should be in the same subnet.
ii. Gateway IPv6 Address T he IPv4 address of the router that forwards trafc out of the appliance's subnet.
g. Select the Additional DNS checkbox to add DNS server IP addresses as additional DNS server apart from the
primary DNS server. T he IP addresses can be either IPv4 or IPv6.
Note
Make sure that:
You add a DNS server IP address or two DNS server IP address as additional DNS server.
You do not use the same DNS server IP address for the primary DNS server and additional DNS servers.
Cascading of DNS servers for AAA in not supported. In case of AAA for LDAP referrals, RADIUS, and T ACACS, the primary DNS
server configured for address resolution is always considered for AAA.
To conrm that the NetScaler SDX appliance is congured correctly, you can either ping the new Management Service IP
address or use the new IP address to open the user interface in a browser.
Note
Log on to the NetScaler SDX appliance using command-line interface (CLI), make sure that the le /etc/resolv.conf le included
the added additional DNS server IP addresses. Also, the /mpscong/svm.conf le reects the added additional DNS server IP
For example:
/mps/changenameserver.sh 127.0.0.1
/mps/addnameserver.sh 1.2.3.4
To perform initial conguration of the SDX appliance from outside the L2 domain, connect to the console port of the
appliance and follow the instructions carefully.
You can now use the new IP address to log on to the Management Service user interface.
T he default user account provides complete access to all features of the Citrix NetScaler SDX appliance. T herefore, to
preserve security, the nsroot account should be used only when necessary, and only individuals whose duties require full
access should know the password for the nsroot account. Citrix recommends changing the nsroot password frequently. If
you lose the password, you can reset the password to the default by reverting the appliance settings to factory defaults ,
and you can then change the password.
You can change the password of the default user account in the Users pane. In the Users pane, you can view the following
details:
Name
Lists the user accounts configured on the SDX appliance.
Permission
Displays the permission level assigned to the user account.
By connecting the LOM port to a dedicated channel that is separate from the data channel, you can make sure that
connectivity to the appliance is maintained even if the data network is down. You thereby eliminate the data cable and
data network as a single point of failure.
You can access the LOM port through a browser and use the graphical user interface (GUI) for most tasks. All tasks can be
performed through the NetScaler shell.
You can use either the GUI or a shell for the following tasks:
Configuring the network settings
Health monitoring
Power control operations
Factory reset
Note: T he terms LOM and Baseboard Management Controller (BMC) are used interchangeably.
Caution: LOM firmware versions are platform specific. Upgrading to a LOM firmware version other than one shown for your
platform in the LOM Support Matrix, below, results in the LOM becoming unusable.
T he LOM Support Matrix shows the LOM rmware versions shipped with the various platforms, along with the
recommended versions, and the earliest NetScaler software versions that support both the shipped and the recommended
LOM rmware versions. T he latest available LOM package can be found on the Citrix downloads website under LOM
Firmware Upgrade.
For initial conguration, connect the network port on your laptop or workstation directly to the LOM port with a crossover
cable, or to a switch in the same local subnet(192.168.1.x) as the LOM port. Assign a network-reachable IP address and
change the default credentials. After saving the new settings, the LOM restarts and the changes take effect. After the
restart, you must use the new address to access to the LOM.
If you make a mistake that results in losing network connectivity at both the old and new IP addresses, you must use the
local shell method to recover.
See the Secure Deployment Guide for best practices for managing administrative credentials and conguring your network
for a secure LOM deployment.
Note: On all SDX platforms, except SDX 22040/22060/22080/22100/22120 and SDX 24100/24150, the LEDs on the LOM
port are nonoperational by design.
T ip: For first-time setup in a network, to facilitate troubleshooting, make sure that a laptop/PC is connected directly to the
LOM port. If you can ping and access the LOM GUI at the default IP address (192.168.1.3) by using static addressing on the
laptop/PC, but remote access does not work, take a closer look at network firewall settings and access control list (ACL)
policies of all network devices along the network path.
T ip: If some LOM GUI features work but others do not, (for example, normal NetScaler console output is visible in the
NetScaler console window in the LOM GUI, but typing in the console does not work), try the above method to isolate the
cause to the specific BMC protocol being blocked by the network.
T ip: Some LOM GUI features, such as the NetScaler console, require the latest Java security updates on the laptop/PC.
Make sure that the latest Java updates are installed on your laptop/PC.
To congure the NetScaler LOM port by using the GUI
1. In a web browser, type http://192.168.1.3 and enter the default user credentials.
Note: T he NetScaler LOM port is preconfigured with IP address 192.168.1.3 and subnet mask 255.255.255.0.
2. On the Configuration tab, click Network and type new values for the following parameters:
IP Address IP address of the LOM port
Subnet Mask Subnet mask used to define the subnet of the LOM port
Default Gateway IP address of the router that connects the LOM port to the network
3. Click Save.
4. If you want to change the user credentials, navigate to Configuration > Users, select the user, click Modify User, and
change the credentials.
2. Optionally, to configure Ethernet VLAN ID and priority, at the NetScaler shell prompt type:
ipmitool lan set 1 vlan id <of f |<ID>>
ipmitool lan set 1 vlan priority <priority>
You can either disable or enable the VLAN. Set the VLAN ID to a value from 1 to 4094, and the VLAN priority to a value
from 0 to 7. After the network settings have been correctly applied, you can access the ipmitool remotely from a
physically separate machine over the network. For remote access, enter the BMC username, BMC password, and the
BMC IP address. For example, to run the ipmitool mc info command, at the shell prompt on a remote machine, type:
T here are two NetScaler MIBs: the NetScaler software management MIB and the NetScaler IPMI LOM hardware
management MIB. T he software management MIB is primarily used for monitoring the application software and the
application software's utilization of hardware resources, such as CPU % and memory %. It provides a high level view of the
appliance and is therefore suitable for the application monitoring function carried out by an application group within an
organization. T he LOM MIB is used for monitoring the hardware health and therefore provides a lower level view of the
appliance, more applicable to the network monitoring function carried out by a network monitoring group.
T he LOM SNMP traps in the LOM MIB report hardware failures. T he NetScaler SNMP traps in the NetScaler MIB report
software failures and hardware load issues.
T he NetScaler MIB has a very small subset of hardware sensors. It does not cover any BIOS level failures, because the BIOS
checks the hardware primarily during boot time , before the NetScaler software starts. If the BIOS detects a failure, it does
not load the boot loader. If the boot loader does not load, the operating system does not load, and therefore
theNetScaler SNMP software service responsible for sending the traps does not load.
T he NetScaler Software Management MIB issues a warning under the following conditions only:
1. If the failure is gradual enough for the main CPU to issue an SNMP alert. An electrical failure close to the CPU, such as a
failed electrical capacitor, occurs too quickly for the CPU to issue an alert.
2. If the failure happens after the BIOS, Operating System, and SNMP service have started and normal boot-up has been
successful.
3. If the failure happens while the operating system and other system software is in a stable enough state for the SNMP
software service to run.
T he NetScaler IPMI LOM hardware management MIB SNMP rmware runs on the BMC microcontroller chip. T he BMC chip
CPU sends a warning in the case of a hardware failure, regardless of whether any of the above conditions occurs. For
example, if the BIOS halts the system during boot-up because of a memory DIMM failure, the BMC chip uses the BIOS
POST code snooping mechanism to detect the failure, and sends a bad DIMM SNMP alert.
You can log on to the LOM port to view the health information about the appliance. All system sensor information, such as
system temperature, CPU temperature, and status of fans and power supplies, appears on the sensor readings page. T he
Event Log records time stamps of routine events such as a power cycle, in addition to recording hardware-failure events. If
SNMP traps are enabled, these events can be sent to your SNMP Network Monitoring software. For more information
about how to set up an SNMP alert, see Conguring SNMP Alerts.
Download the IPMI SNMP management information base (MIB) for your LOM rmware version, and import it into the
SNMP monitoring software.
You can congure SNMP alerts on the LOM. Optionally, you can congure an alert to send emails.
To congure the alerts, you can use the LOM GUI or the NetScaler Shell.
T he latest IPMI specications are available from the IPMI section of the Intel website:
http://www.intel.com/content/www/us/en/servers/ipmi/ipmi-specications.html
Usually, customization in the SNMP Network Management Software is the preferred method, because it can be done one
time at a central location. T herefore, the settings below send all events for all sensors to the SNMP network management
software. T hese are very low trafc events and therefore should not result in any signicant network usage.
ipmitool raw 4 0x12 0x6 0x10 0x80 1 1 0 0xf f 0xf f 0xf f 0xf f 0xf f 0xf f 0xf f 0 0xf f 0 0 0xf f 0 0 0xf f 0
T he following command creates a policy list for all sensors and events:
Where, <x.x.x.x> is the IP address to which the SNMP event should be sent.
To encrypt SNMP alerts, setup an SSL certicate and private key. In the GUI, navigate to Conguration > SSL
Certication and apply the SSL certicate and private key. See the NetScaler Secure Deployment Guide for more
information about how to securely deploy the LOM in your network. To enable encryption and learn the security measures
for LOM, see http://support.citrix.com/article/CT X129514.
If you make a mistake, you must restore the BMC to the factory defaults to erase the certicate and key. Use the
following shell command:
Note: T he certificate file must contain only the certificate. T he certificate and key must not be in the same file. Make sure
that the certificate contains only the certificate and that the key file contains only the key.
To upload a trusted certicate and private key by using the LOM GUI
2. In the right pane, click the Choose File buttons to select a new SSL certificate and a new private key.
4. Click Upload. A message informs you that uploading a new SSL certificate replaces the existing (default) certificate.
5. Click OK.
T he reset takes approximately 60 seconds. You are then redirected to the logon page.
To obtain the MAC address, serial number, and host properties of the appliance by using the LOM GUI
To obtain the MAC address and host properties of the BMC by using the appliance shell
A warm restart, cold restart, or a power cycle of the appliance, using the power button, does not include power cycling the
BMC. T he BMC runs on standby power directly from the power supply. T herefore, the BMC is not affected by any state of
the power button on the appliance. T he only way to power cycle the BMC is to remove all power cords from the appliance
for 60 seconds.
Perf orming power control operations on the BMC by using the appliance shell
When performing either a warm or cold restart of the BMC microcontroller, you cannot communicate with the LOM port.
Both actions restart the BMC but not the main CPU. To perform a warm restart of LOM from the appliance, type:
To perf orm a warm restart remotely f rom another computer on the network, type:
To perf orm a warm restart remotely f rom another computer on the network, type:
If the appliance fails or becomes unresponsive, you can remotely perform a core dump. T his procedure has the same effect
as pressing the NMI button on the back panel of the appliance.
You can set this switch to direct LOM trafc through the dedicated LOM port or through the shared management port. A
dedicated LOM port removes the management port as a single point of failure, while a shared LOM/management port
reduces the cabling costs.
You can connect to the Management Service user interface by using one of the following supported browsers:
Internet Explorer
Google Chrome
Apple Safari
Mozilla Firefox
or
2. On the Login page, in User Name and Password, type the user name and password of the Management Service. T he
default user name and password are nsroot and nsroot. However, Citrix recommends that you change the password
after initial configuration. For information about changing the nsroot password, see Changing the Password of the
Default User Account.
3. Click Show Options, and then do the following:
1. In the Start in list, select the page that must be displayed immediately after you log on to the user interface. T he
available options are Home, Monitoring, Configuration, Documentation, and Downloads. For example, if you want the
Management Service to display the Configuration page when you log on, select Configuration in the Start in list.
2. In T imeout, type the length of time (in minutes, hours, or days) after which you want the session to expire. T he
minimum timeout value is 15 minutes.
T he Start in and T imeout settings persist across sessions. T heir default values are restored only after you clear the
cache.
You can use the Setup Wizard to complete all the rst time congurations in a single ow.
You can use the wizard to congure network conguration details and system settings, change the default administrative
password, and manage and update licenses.
You can also use this wizard to modify the network conguration details that you specied for the NetScaler SDX
To access the wizard, navigate to Conguration > System and, under Set Up Appliance, click Setup Wizard.
On the Platform Conguration page, you can congure network conguration details, system settings, and change the
default administrative password.
Interface* T he interface through which clients connect to the Management Service. Possible values: 0/1, 0/2. Default:
0/1.
XenServer IP Address* IP address of the XenServer server.
Management Service IP Address* IP address of the Management Service.
Netmask* Mask for the subnet in which the SDX appliance is located.
Gateway* Default gateway for the network.
DNS Server IP address of the DNS server.
Under System Settings, you can specify that the Management Service and a NetScaler instance should communicate with
each other only over a secure channel. You can also restrict access to the Management Service user interface. Clients can
log on the Management Service user interface only by using https.
You can modify the time zone of the Management Service and the XenServer server. T he default time zone is UTC. You can
change the Administrative password by selecting the Change Password check box and typing the new password.
Under Manage Licenses you can manage and allocate licenses. You can use your hardware serial number (HSN) or your
license activation code (LAC) to allocate your licenses. Alternatively, if a license is already present on your local computer,
you can upload it to the appliance.
Select the licenses on the appliance and click Done to complete the initial conguration.
You can provision one or more NetScaler or third-party instances on the SDX appliance by using the Management Service.
T he number of instances that you can install depends on the license you have purchased. If the number of instances added
is equal to the number specied in the license, the Management Service does not allow provisioning more instances.
For information about provisioning third-party instances, see T hird-Party Virtual Machines.
Console Access
You can access the console of NetScaler instances, the Management Service, XenServer, and third party VMs from the
Management Service interface. T his is particularly helpful in debugging and troubleshooting the instances hosted on the
NetScaler SDX appliance.
To access the console of VMs, navigate to the instance listing, select the VM from the list, and under Action drop down
menu, click Console Access.
To access the console of Management Service or XenServer, navigate to Conguration > System, and under Console
Access, click Management Service or XenServer link.
Note: Console access is not supported by the Internet Explorer browser. Citrix recommends using the console access
feature through Management Service HT T PS sessions only.
Management Service Statistics
Logging on to the Management Service gives you direct access to the NetScaler instances that are provisioned on the
appliance, if the instances are running release 10 build 53 and later. If you log on to the Management Service by using your
user credentials, you do not have to provide the user credentials again for logging on to an instance. By default, the
Timeout value is set to 30 minutes and the conguration tab is opened in a new browser window.
T he Management Service Home page provides you with a high-level view of the performance of the SDX appliance and the
instances provisioned on your appliance. SDX appliance and instance information is displayed in gadgets that you can add
and remove depending on your requirement.
System Resources
Displays the total number of CPU cores, total number of SSL chips, number of free SSL chips, total memory, and free
memory on the appliance.
System CPU | Memory Usage (%)
Displays the percentage of CPU and memory utilization of the appliance in graphical format.
System WAN/LAN Throughput (Mbps)
Displays the total throughput of the SDX appliance for incoming and outgoing traffic in a graph that is plotted in real time
and updated at regular intervals.
NetScaler Instances
Displays the properties of the NetScaler instances. T he properties displayed are Name, VM State, Instance State, IP
Address, Rx (Mbps), T x (Mbps), HT T P Req/s, and CPU Usage (%) and Memory Usage (%).
Note: On first log on, the Home page does not display any data related to the NetScaler instances because you have not
provisioned any instances on your appliance.
Health Monitoring Events
Displays the last 25 events, with their severity, message, and the date and time that the event occurred.
Currently, you can add the following gadgets to the Home page:
Hypervisor Details
T he Hypervisor Details gadget displays details about XenServer uptime, edition, version, iSCSI Qualified Name (IQN), product
code, serial number, build date, and build number.
Licenses
T he Licenses gadget displays details about the SDX hardware platform, the maximum number of instances supported on
the platform, the maximum supported throughput in Mbps, and the available throughput in Mbps.
If you remove a gadget that is available on the Home page by default, you can add them back to the Home page by
performing a search for the gadget, as described earlier.
Single bundle upgrade combines all the components except the NetScaler image and LOM rmware in a single image le,
called the NetScaler SDX image. Using this image, you can upgrade all the components in a single step, eliminating the
chances of incompatibility between various components. Single bundle upgrade also ensures that your appliance is always
running a version that is tested and supported by Citrix. Because all the SDX components are combined in a single le, the
NetScaler SDX image le is signicantly larger than the Management Service image le.
T he NetScaler SDX image is the single bundle image le, which includes all the SDX components, including the Management
Service, except NetScaler image and LOM rmware. Use this image le to upgrade the entire appliance. T he le name of the
image is of the format build-sdx-12.0-<build_number>.tgz
After the Management Service is upgraded to NetScaler SDX 12.0, the new GUI does not display the options to upload the
XenServer image le, supplemental packs, or hotxes. T his is because NetScaler SDX 12.0 does not support upgrading
individual components.
If you are currently running version 10.5.57.x or later of the NetScaler SDX Management Service, you can use the NetScaler
SDX 11.1 image le to upgrade the appliance. If your Management Service is running an older version, you must rst upgrade
it to version 10.5.57.x.
1. Upload the single bundle image file, navigate to Conf iguration> Management Service > Sof tware Images and then
click Upload.
2. Navigate to Conf iguration > System > System Administration.
3. In the System Administration group, click Upgrade Management Service.
1. Upload the single bundle image file, navigate to Conf iguration> Management Service > Sof tware Images and then
click Upload.
2. Navigate to Conf iguration > System > System Administration.
3. In the System Administration group, click Upgrade Appliance.
Before clicking Upgrade Appliance, make sure that you have reviewed all the information displayed on the screen. You
cannot abort the upgrade process once it starts.
If a task that you need to perform is not described below, see the list of tasks at the left.
To modify the network conguration of the SDX appliance, click System. In the System pane, under the Setup Appliance
group, click Network Conguration and enter the details in the wizard.
You can modify the network conguration details that you provided for the NetScaler SDX appliance during initial
conguration.
To modify the network conguration of the SDX appliance, click System. In the System pane, under the Setup Appliance
group, click Network Conguration and enter the details in the wizard.
To change the password of the default user account, click System > User Administration > Users. Select a user and click
Edit to change the password.
To modify the time zone, click System and in the System Settings group, click Change Time Zone.
VLAN Filtering
VLAN ltering provides segregation of data between NetScaler VPX instances that share a physical port. For example, if
you have congured two NetScaler VPX instances on two different VLANs and you enable VLAN ltering, one instance
cannot view the other instance's trafc. If VLAN ltering is disabled, all of the instances can see the tagged or untagged
broadcast packets, but the packets are dropped at the software level. If VLAN ltering is enabled, each tagged broadcast
packet reaches only the instance that belongs to the corresponding tagged VLAN. If none of the instances belong to the
If VLAN ltering is enabled on an interface, a limited number of tagged VLANs can be used on that interface (63 tagged
VLANs on a 10G interface and 32 tagged VLANs on a 1G interface). A VPX instance receives only the packets that have the
congured VLAN IDs. Restart the NetScaler VPX instances associated with an interface if you change the state of the
VLAN lter from DISABLED to ENABLED on that interface.
VLAN ltering is enabled by default on the NetScaler SDX appliance. If you disable VLAN ltering on an interface, you can
congure up to 4096 VLANs on that interface.
Note: VLAN ltering can be disabled only on a NetScaler SDX appliance running XenServer version 6.0.
To enable VLAN ltering on an interface, click System > Interf aces. Select an interface and click VLAN Filter and enter the
details to enable VLAN ltering.
You can congure your NetScaler SDX appliance to synchronize its local clock with a Network T ime Protocol (NT P) server.
As a result, the clock on the SDX appliance has the same date and time settings as the other servers on your network. T he
clock synchronization conguration does not change if the appliance is restarted, upgraded, or downgraded. However, the
conguration does not get propagated to the secondary NetScaler instance in a high availability setup.
T he clock is synchronized immediately if you add a new NT P server or change any of the authentication parameters. You
can also explicitly enable and disable NT P synchronization.
Note: If you do not have a local NT P server, you can find a list of public, open access, NT P servers at the official NT P site,
http://www.ntp.org. Before configuring your NetScaler to use a public NT P server, be sure to read the Rules of
Engagement page (link included on all Public T ime Servers pages).
To congure an NT P server, click System > NT P Servers.
You can view system properties such as the number of CPU cores and SSL chips, total available memory and free memory,
and various product details on the Conguration tab.
To view the properties of the NetScaler SDX appliance, click the Conguration tab.
You can view the following information about system resources, Hypervisor, License, and System:
System Resources
Total CPU Cores
T he number of CPU cores on the SDX appliance.
Total SSL Chips
T he total number of SSL chips on the SDX appliance.
Free SSL chips
T he total number of SSL chips that have not been assigned to a instance.
Total Memory (GB)
T otal appliance memory in gigabytes.
Free Memory (GB)
Free appliance memory in gigabytes.
To view the throughput of the SDX appliance, on the Monitoring tab, in the navigation pane, expand Monitoring, and then
click T hroughput.
To view the CPU and memory usage of the SDX appliance, on the Monitoring tab, in the navigation pane, expand
Monitoring, and then click CPU / Memory Usage.
You can view the usage of each CPU core on the NetScaler SDX appliance.
Core Number
T he CPU core number on the appliance.
Physical CPU
T he physical CPU number of that core.
Hyper Threads
T he hyper threads associated with that CPU core.
Instances
T he instances that are using that CPU core.
Average Core Usage
T he average core usage, expressed as a percentage.
To view the CPU usage for all the cores on the SDX appliance, navigate to the Dashboard tab.
T he NetScaler SDX appliance is shipped with a default SSL certificate. For security reasons, you may want to replace this
certificate with your own SSL certificate. T o do so, you must first upload your SSL certificate to the Management Service
and then install the certificate. Installing an SSL certificate terminates all current client sessions with the Management
Service, so you have to log back on to the Management Service for any additional configuration tasks.
To install an SSL certicate, click System. In the Set Up Appliance group, click Install SSL Certicate and enter the details in
the wizard.
T he Management Service uses an SSL certificate for secure client connections. You can view the details of this certificate,
such as validity status, issuer, subject, days to expire, valid from and to dates, version, and serial number.
To view the SSL certicate, click System and in the Set Up Appliance group, click View SSL Certicate.
Separate views of SSL certicates and keys for NetScaler instances provide enhanced usability. You can use a new
Management Service node, SSL Certicate Files, to upload and manage the SSL certicates and corresponding public and
private key pairs that can be installed on NetScaler instances.
To access the SSL certicates and keys for NetScaler instances, navigate to Conguration > NetScaler > SSL Certicate
Files.
For security reasons, you can specify that the Management Service and a NetScaler VPX instance should communicate
with each other only over a secure channel. You can also restrict access to the Management Service user interface. Clients
can log on the Management Service user interface only by using https.
To modify system settings, click Conguration > System and in the System Settings group, click Change System Settings.
T he Management Service provides an option to restart the SDX appliance. During the restart, the appliance shuts down all
hosted instances, and then restarts XenServer. When XenServer restarts, it starts all hosted instances along with the
Management Service.
To restart the appliance, click Conguration > System and in the System Administration group, click Reboot Appliance.
You can shut down the NetScaler SDX appliance from the Management Service.
To shut down the appliance, click Conguration > System, and in the System Administration group, click Shut Down
Appliance.
A NetScaler SDX appliance is shipped with xed resources, such as CPU cores, data throughput, memory, disk space, SSL
chips, and a specic number of instances that can be provisioned. T he number of instances that you can create depends on
the license.
A NetScaler SDX appliance supports up to three levels of administrative domains. When the appliance is shipped, all the
resources are allocated to owner.
Any administrative domains that you create are subdomains of the owner domain. In each case, the subdomain's resources
are allocated from the parent domain's pool of resources. T he users in an administrative domain have access to that
domain's resources. T hey do not have access to the resources of other domains at the same hierarchical level, nor to the
parent-domain resources that have not been specically allocated to their domain. However, users in a parent domain can
access the resources of that domain's subdomains.
T able 1 lists the resources of a root domain named nsroot (which is the default name of the root domain). T he SDX
administrator can allocate these resources to subdomains. In this case, the administrator can allocate a maximum of, for
example, 10 CPU cores and 840 GB of disk space.
Table 1. Owner Resources
CPU core 10
SSL Chips 36
Instances 36
T able 2 lists the resources allocated a subdomain named Test . T his subdomain has been allocated 5 of its parent domain's
10 CPU cores, leaving 5 cores that can be allocated to other subdomains of Owner.
Table 2. Test Domain's Resources
CPU core 5
SSL Chips 8
Instances 4
When creating subdomains, the Test domain administrator can allocate only the resources listed in Table 2. T he Test domain
can have only one level of subdomains, because only three levels of domains can be created.
T he following gure shows another example of resource allocation among subdomains, using different values from the
ones listed in tables 1 and 2.
To create an administrative domain, navigate to Conguration > System > Administrative Domain and select the options
that you want. follow the on-screen instructions. Once a new domain is created, log in to the newly created domain by
using the Management Service's login page and provide the domain name and user name in the User Name eld. For
example, if you created a domain named NewDomain with a user NewUser then login as NewDomain\NewUser.
When a sub-domain is created, two user groups are automatically created: an admin group and a read-only group. By
default, each user is the part of the admin group. A user can be added to multiple groups.
T he SDX appliance is shipped with a conguration that includes logical drive 0, which is allocated for the Management
Service and XenServer, and logical drive 1, which is allocated for NetScaler instances that you will provision. To use additional
physical drives, you have to create new logical drives.
A NetScaler SDX appliance supports a maximum of eight physical-drive slots, that is, a pair of four slots on each side of the
appliance. You can insert physical drives into the slots. Before you can use a physical drive, you must make it part of a logical
drive needs.
In the Management Service, the Conguration > System > RAID screen includes tabs for logical drives, physical drives, and
storage repositories.
Logical Drives
On the Conguration > System > RAID > Logical Drives tab, you can view the name, state, size, of each logical drive, and
information about its component physical drives. T he following table describes the states of the virtual drive.
State Description
Optimal T he virtual drive operating condition is good. All configured drives are online.
Degraded T he virtual drive operating condition is not optimal. One of the configured drives has failed or is offline.
You can also view the details the physical drives associated with the logical drive by selecting the logical drive and clicking
Show Physical Drive.
1. Navigate to Conf iguration > System > RAID, and select the Logical Drives tab.
2. Click Add.
3. In the Create Logical Disk dialog box, select two slots that contain operational physical drives, and then click Create.
Physical Drives
A NetScaler SDX appliance supports a maximum of eight physical slots, that is, a pair of four slots on each side of the
appliance. On the Configuration > System > RAID > Physical Drives tab, you can view the following information:
Slot Physical slot associated with the physical drive.
Size Size of the physical drive.
Firmware State State of the firmware. Possible Values:
Online, spun up Physical drive is up and is being controlled by RAID.
Unconfigured (good) Physical drive is in good condition and can be added as a part of the logical drive pair.
Unconfigured (bad) Physical drive is not in good condition and cannot be added as part of a logical drive.
Foreign State Indicates if the disk is empty.
Logical Drive Associated logical drive.
In the Physical Drives pane, you can perform the following actions on the physical drives:
Initialize Initialize the disk. You can initialize the physical drive if it is not in good state and needs to be added as a part
of logical drive pair.
Rebuild Initiate a rebuild of the drive. When a drive in a drive group fails, you can rebuild the drive by re-creating the
data that was stored on the drive before it failed. T he RAID controller re-creates the data stored on the other drives in
the drive group.
Locate Locate the drive on the appliance, indicated by causing the Drive Activity LED associated with the drive to
blinnk.
Stop Locate Stop locating the drive on the appliance.
Prepare to Remove Deactivate the selected physical drive so that it can be removed.
Storage Repository
On the Conguration > System > RAID > Storage Repository tab, you can view the status of storage repositories on
NetScaler SDX appliance. You can also view information about a storage-repository drive that is not attached, and you can
remove such a drive by selecting the it and then clicking Remove. T he Storage Repository tab displays the following
information about each storage repository:
Note: In Management Service, the slot number begins with zero. So the slot numbering in Management Service differs
from the slot numbering on the physical appliance.
T he logical drive is created and is listed under the Logical Drive tab. Click the refresh icon to update the order of the logical
drives.
T o add another logical drive, insert the SSDs in slot numbers 6 and 7. In the Create Logical Disk page, select 6 from the
First Slot drop-down list and select 7 from the Second Slot drop-down list.
Click the refresh icon to check the status of the rebuild process. When the rebuild process is complete, you can see Online,
Spun Up status in the Firmware State column.
For all other functionality, such as returning or reallocating your license, you must use the licensing portal. Optionally, you
can still use the licensing portal for license allocation. For more information about the licensing portal, see
"http://support.citrix.com/article/CT X131110."
Prerequisites
T o use the hardware serial number or license activation code to allocate your licenses:
1. You must be able to access public domains through the appliance. For example, the appliance should be able to access
www.citrix.com. T he license allocation software internally accesses the Citrix licensing portal for your license. T o access a
public domain, you must configure the Management Service IP address and set up a DNS server.
2. Your license must be linked to your hardware, or you must have a valid license activation code (LAC). Citrix sends your LAC
by email when you purchase a license.
If your license is already linked to your hardware, the license allocation process can use the hardware serial number.
Otherwise, you must type the license activation code (LAC).
You can partially allocate licenses as required for your deployment. For example, if your license le contains ten licenses, but
your current requirement is for only six licenses, you can allocate six licenses now, and allocate additional licenses later. You
cannot allocate more than the total number of licenses present in your license le.
Click Get Licenses. Depending on the option that you selected, one of the following dialog boxes appears.
T he following dialog box appears if you selected Hardware Serial Number.
Select the license file that you want to use to allocate your licenses.
In the Allocate column, enter the number of licenses to be allocated. T hen click Get.
If you selected Hardware Serial Number, enter the number of licenses, as shown in the following screen shot.
If you downloaded your license le to your local computer by accessing the licensing portal, you must upload the license to
the appliance.
Using resource visualizer, all the available resource which can be used to provision an instance are displayed in a single
dashboard. All the available and used resources are shown in a graphical format. Resource visualizer also displays other
parameters such as power supply status, temperature etc apart from the resources that can be allocated.
T he resource visualizer also displays the various resources that an instance is using. To see the various resources associated
with an instance, click on the instance name in the visualizer. T he right hand side of the visualizer displays all the available
and used resources in a graphical format.
1. On the Configuration tab, in the navigation pane, expand System, and then click Interfaces.
2. In the Interfaces pane, click the interface that you want to configure, and then click Edit.
3. In the Configure Interface window, specify values for the following parameters:
Auto Negotiation* Enable auto-negotiation. Possible values: ON, OFF. Default: OFF.
Speed* Ethernet speed for the interface, in Mb/s. Possible values: 10, 100, 1000, and 10000.
Duplex* T ype of duplex operation of the interface. Possible values: Full, Half, NONE. Default: NONE.
Flow Control Auto Negotiation* Automatically negotiate flow control parameters. Possible values: ON, OFF.
Default: ON
Rx Flow Control* Enable Rx flow. Possible values: ON, OFF. Default: ON
T x Flow Control* EnableT x flow control is enabled. Possible values: ON, OFF. Default: ON
* A required parameter
1. On the Configuration tab, in the navigation pane, expand System, and then click Interfaces.
2. In the Interfaces pane, click the interface that you want to reset, and then click Reset.
Displaying the Mapping of Virtual Interf aces on the VPX Instance to the Physical Interf aces on the NetScaler
SDX Appliance
If you log on to the NetScaler virtual instance, the configuration utility and the command line interface display the mapping
of the virtual interfaces on the instance to the physical interfaces on the appliance.
After logging on to the NetScaler VPX instance, in the conguration utility, navigate to Network, and then click Interf aces.
T he virtual interface number on the instance and the corresponding physical interface number on the appliance appear in
the Description eld, as shown in the following gure:
In the NetScaler command line interface, type the show interface command. For example:
> show interface
1) Interface 10/3 (10G VF Interface, PF 10/4) #2
flags=0xe460 <ENABLED, UP, UP, HAMON, 802.1q>
MTU=1500, native vlan=1, MAC=6e:b6:f5:21:5d:db, uptime 43h03m35s
Actual: media FIBER, speed 10000, duplex FULL, fctl NONE, throughput 10000
RX: Pkts(2547925) Bytes(287996153) Errs(0) Drops(527183) Stalls(0)
TX: Pkts(196) Bytes(8532) Errs(0) Drops(0) Stalls(0)
NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0)
If, while you are provisioning a NetScaler instance on an SDX appliance, XenServer internally assigns a MAC address to a
virtual interface associated with that instance, the same MAC address might be assigned to a virtual interface associated
with another instance on the same appliance or on another appliance. T o prevent assignment of duplicate MAC addresses,
you can enforce unique MAC addresses.
T here are two ways of assigning a MAC address to an interface:
1. Assign a base MAC address and a range to an interface: T he Management Service assigns a unique MAC address by using
the base address and range.
2. Assign a global base MAC address: A global base MAC address applies to all interfaces. T he Management Service then
generates the MAC addresses for all interfaces. If you set the global base MAC address, the range for a 1G interface is
set to 8 and the range for a 10G interface is set to 64. See the following table for sample base MAC addresses if the
global base MAC address is set to 00:00:00:00:00:00.
Table 1. Example of Base MAC Addresses Generated f rom a Global Base MAC Address
0/1 00:00:00:00:00:00
0/2 00:00:00:00:00:08
1/1 00:00:00:00:00:10
1/2 00:00:00:00:00:18
1/3 00:00:00:00:00:20
1/4 00:00:00:00:00:28
1/5 00:00:00:00:00:30
1/6 00:00:00:00:00:38
1/7 00:00:00:00:00:40
1/8 00:00:00:00:00:48
10/1 00:00:00:00:00:50
10/2 00:00:00:00:00:90
T he base MAC address for the management ports is for reference only. T he Management Service generates MAC
addresses, on the basis of the base MAC address, for 1/x and 10/x ports only.
Note: You cannot assign a base MAC address to a channel.
To perform the various operations with MAC address, click System > Interfaces. Select an interface and then click Edit.
Perform the MAC address operation, in he Congure Interface window.
Disabling or Enabling the Physical Interf aces on the NetScaler SDX Appliance
If you are not using any of the physical interfaces on the NetScaler SDX appliance, for security purpose, you can disable
the physical interface using the Management Service.
Note: By default, all the physical interfaces on the NetScaler SDX appliance is enabled. Also, if an interface is used by an
VPX or channel, you cannot disable the interface.
1. On the Conf iguration tab, in the navigation pane, expand System, and then click Interf aces.
2. In the Interf aces pane, select the interface that you want to disable.
3. In the Action drop-down list, click Disable.
If you want to use the disabled physical interface, you can enable the interface using the Management Service.
1. On the Conf iguration tab, in the navigation pane, expand System, and then click Interf aces.
2. In the Interf aces pane, select the disable interface that you want to enable.
3. In the Action drop-down list, click Enable.
A NetScaler appliance can use jumbo frames in the following deployment scenarios:
Jumbo to Jumbo: T he appliance receives data as jumbo frames and sends it as jumbo frames.
Non-Jumbo to Jumbo: T he appliance receives data as non-jumbo frames and sends it as jumbo frames.
Jumbo to Non-Jumbo: T he appliance receives data as jumbo frames and sends it as non-jumbo frames.
T he NetScaler instances provisioned on NetScaler SDX appliance support jumbo frames in a load balancing configuration
for the following protocols:
T CP
Any other protocol over T CP
SIP
For more information about jumbo frames, see the use cases.
Updated: 2015-02-06
Consider an example of a jumbo to jumbo setup in which SIP load balancing virtual server LBVS-1, congured on NetScaler
instance NS1, is used to load balance SIP trafc across servers S1 and S2. T he connection between client CL1 and NS1, and
the connection between NS1 and the servers support jumbo frames.
Interface 10/1 of NS1 receives or sends trafc from or to client CL1. Interface 10/2 of NS1 receives or sends trafc from or
to server S1 or S2. Interfaces 10/1 and 10/2 of NS1 are part of VLAN 10 and VLAN 20, respectively.
For supporting jumbo frames, the MT U is set to 9216 for interfaces 10/1, 10/2, and VLANs VLAN 10, VLAN 20.
All other network devices, including CL1, S1, S2, in this setup example are also congured for supporting jumbo frames.
S2 198.51.100.20
MT Us specified for interfaces (by using the Management Service interface) and VLANs on 10/1 9000
NS1 (by using NetScaler command line interface).
10/2 9000
VLAN 9000
10
VLAN 9000
20
SVC- IP address:
S2 198.51.100.20
Protocol: SIP
Port: 5060
1. Server S1 creates a 30000-byte SIP response to send to the SNIP address of NS1.
2. S1 sends the response data in IP fragments to NS1. T he size of each IP fragment is either equal to or less than the MT U
(9000) set on the interface from which S1 sends these fragments to NS1.
Size of the first IP fragment = [IP header + UDP header + SIP data segment] = [20 + 8 + 8972] = 9000
Size of the second and third IP fragment = [IP header + SIP data segment] = [20 + 8980] = 9000
Size of the last IP fragment=[IP header + SIP data segment] = [20 + 3068] = 3088
3. NS1 receives the response IP fragments at interface 10/2. NS1 accepts these fragments, because the size of each
fragment is equal to or less than the MT U (9000) of interface 10/2.
4. NS1 reassembles these IP fragments to form the 27000-byte SIP response. NS1 processes this response.
5. NS1 sends the response data in IP fragments to CL1. T he size of each IP fragment is either equal or less than the MT U
(9000) of the interface 10/1, from which NS1 sends these fragments to CL1. T he IP fragments are sourced with LBVS-1s
IP address. T hese IP packets are sourced from LBVS-1s IP address and destined to CL1s IP address.
Size of the first IP fragment = [IP header + UDP header + SIP data segment] = [20 + 8 + 8972] = 9000
Size of the second and third IP fragment = [IP header + SIP data segment] = [20 + 8980] = 9000
Size of the last IP fragment=[IP header + SIP data segment] = [20 + 3068] = 3088
Conguration Tasks
On the NetScaler SDX Management Service, navigate to Conguration > System > Interfaces page. Select the required
interface and click Edit. Set the MT U value and click OK.
Example
Set the MT U value for interface 10/1 as 9000 and for interface 10/2 as 9000.
Log on to NetScaler instance and use the NetScaler command line interface to complete the remaining conguration
steps.
T he following table list the tasks, NetScaler commands, and examples for creating the required conguration on the
NetScaler instances.
Create VLANs and set the MT U of the desired add vlan <id> -mtu add vlan 10 -mtu 9000
VLANs for supporting jumbo frames. <positive_integer>
add vlan 20 -mtu 9000
show vlan <id>
Bind interfaces to VLANs. bind vlan <id> -ifnum bind vlan 10 -ifnum 10/1
<interface_name>
show ns ip
Create services representing SIP servers. add service <serviceName> add service SVC-S1
<ip> SIP_UDP <port> 198.51.100.19 SIP_UDP 5060
Create SIP load balancing virtual servers and bind the add lb vserver <name> add lb vserver LBVS-1 SIP_UDP
services to it SIP_UDP <ip> <port> 203.0.113.15 5060
show ns cong
Updated: 2015-02-06
Consider an example of a non-jumbo to jumbo setup in which load balancing virtual server LBVS1, congured on a NetScaler
instance NS1, is used to load balance trafc across servers S1 and S2. T he connection between client CL1 and NS1 supports
non-jumbo frames, and the connection between NS1 and the servers supports jumbo frames.
Interface 10/1 of NS1 receives or sends trafc from or to client CL1. Interface 10/2 of NS1 receives or sends trafc from or
to server S1 or S2.
Interfaces 10/1 and 10/2 of NS1 are part of VLAN 10 and VLAN 20, respectively. For supporting only non-jumbo frames
between CL1 and NS1, the MT U is set to the default value of 1500 for both interface 10/1 and VLAN 10.
For supporting jumbo frames between NS1 and the servers, the MT U is set to 9000 for interface 10/2 and VLAN 20.
Servers and all other network devices between NS1 and the servers are also configured for supporting jumbo frames. Since
HT T P traffic is based on T CP, MSSs are set accordingly at each end point for supporting jumbo frames:
For the connection between CL1 and virtual server LBVS1 of NS1, the MSS on NS1 is set in a T CP profile, which is then
bound to LBVS1.
For the connection between a SNIP address of NS1 and S1, the MSS on NS1 is set in a T CP profile, which is then bound
to the service (SVC-S1) representing S1 on NS1.
S2 198.51.100.20
MT U for interface 10/1 (by using the Management Service interface). 1500
MT U set for interface 10/2( by using the Management Service interface). 9000
MT U for VLAN 10 on NS1 (by using NetScaler command line interface). 1500
MT U set for VLAN 20 on NS1 (by using NetScaler command line 9000
interface).
4. NS1 receives the request packet at interface 10/1 and then processes the HT T P request data in the packet.
5. LBVS-1's load balancing algorithm selects server S1, and NS1 opens a connection between one of its SNIP addresses and
S1. NS1 and CL1 exchange their respective T CP MSS values while establishing the connection.
6. Because S1's MSS is larger than the HT T P request, NS1 sends the request data in a single IP packet to S1.
1. Size of the request packet = [IP Header + T CP Header + [T CP Request] = [20 + 20 + 200] = 240
Conguration Tasks
On the NetScaler SDX Management Service, navigate to Conguration > System > Interfaces page. Select the required
interface and click Edit. Set the MT U value and click OK.
Example
Log on to NetScaler instance and use the NetScaler command line interface to complete the remaining conguration
T he following table list the tasks, NetScaler commands, and examples for creating the required conguration on the
NetScaler instances.
Create VLANs and set the MT U of the desired add vlan <id> -mtu add vlan 10 -mtu 1500
VLANs for supporting jumbo frames. <positive_integer>
add vlan 20 -mtu 9000
show vlan <id>
Bind interfaces to VLANs. bind vlan <id> -ifnum bind vlan 10 -ifnum 10/1
<interface_name>
bind vlan 20 -ifnum 10/2
show vlan <id>
show ns ip
Create services representing HT T P servers add service <serviceName> add service SVC-S1 198.51.100.19
<ip> HT T P <port> http 80
Create HT T P load balancing virtual servers and add lb vserver <name> add lb vserver LBVS-1 http
bind the services to it HT T P <ip> <port> 203.0.113.15 80
Create a custom T CP profile and set its MSS for add tcpProle <name> -mss add tcpprofile NS1-SERVERS-
supporting jumbo frames. <positive_integer> JUMBO -mss 8960
Bind the custom T CP profile to the desired set service <Name> - set service SVC-S1 -tcpProleName
services. tcpProleName <string> NS1- SERVERS-JUMBO
show ns cong
Use Case: Coexistence of Jumbo and Non-Jumbo ows on Same Set of Interf aces
Updated: 2015-04-14
Consider an example in which load balancing virtual servers LBVS1 and LBVS2 are congured on NetScaler instance NS1.
LBVS1 is used to load balance HT T P trafc across servers S1 and S2, and global is used to load balance trafc across servers
S3 and S4.
CL1 is on VLAN 10, S1 and S2 are on VLAN20, CL2 is on VLAN 30, and S3 and S4 are on VLAN 40. VLAN 10 and VLAN 20
support jumbo frames, and VLAN 30 and VLAN 40 support only non-jumbo frames.
In other words, the connection between CL1 and NS1, and the connection between NS1 and server S1 or S2 support jumbo
frames. T he connection between CL2 and NS1, and the connection between NS1 and server S3 or S4 support only non-
jumbo frames.
Interface 10/1 of NS1 receives or sends trafc from or to clients. Interface 10/2 of NS1 receives or sends trafc from or to
the servers.
Interface 10/1 is bound to both VLAN 10 and VLAN 20 as a tagged interface, and interface 10/2 is bound to both VLAN 30
and VLAN 40 as a tagged interface.
For supporting jumbo frames, the MT U is set to 9216 for interfaces 10/1 and 10/2.
On NS1, the MT U is set to 9000 for VLAN 10 and VLAN 30 for supporting jumbo frames, and the MT U is set to the default
value of 1500 for VLAN 20 and VLAN 40 for supporting only non-jumbo frames.
T he effective MT U on a NetScaler interface for VLAN tagged packets is of the MT U of the interface or the MT U of the
VLAN, whichever is lower. For example:
T he MT U of interface 10/1 is 9216. T he MT U of VLAN 10 is 9000. On interface 10/1, the MT U of VLAN 10 tagged
packets is 9000.
T he MT U of interface 10/2 is 9216. T he MT U of VLAN 20 is 9000. On interface 10/2, the MT U of VLAN 20 tagged
packets is 9000.
T he MT U of interface 10/1 is 9216. T he MT U of VLAN 30 is 1500. On interface 10/1, the MT U of VLAN 30 tagged
packets is 1500.
T he MT U of interface 10/2 is 9216. T he MT U of VLAN 40 is 1500. On interface 10/2, the MT U of VLAN 40 tagged
packets is 9000.
CL1, S1, S2, and all network devices between CL1 and S1 or S2 are congured for jumbo frames.
Since HT T P traffic is based on T CP, MSSs are set accordingly at each end point for supporting jumbo frames.
For the connection between CL1 and virtual server LBVS-1 of NS1, the MSS on NS1 is set in a T CP profile, which is then
bound to LBVS1.
For the connection between a SNIP address of NS1 and S1, the MSS on NS1 is set in a T CP profile, which is then bound
to the service (SVC-S1) representing S1 on NS1.
CL2 192.0.2.20
S2 198.51.100.20
S3 198.51.101.19
S4 198.51.101.20
10/2 9216
VLAN 10 9000
VLAN 30 9000
VLAN 40 1500
Conguration Tasks
On the NetScaler SDX Management Service, navigate to Conguration > System > Interfaces page. Select the required
interface and click Edit. Set the MT U value and click OK.
Example:
T he following table list the tasks, NetScaler commands, and examples for creating the required conguration on the
NetScaler instances.
Create VLANs and set the MT U of the desired add vlan <id> -mtu add vlan 10 -mtu 9000
VLANs for supporting jumbo frames. <positive_integer>
add vlan 20 -mtu 9000
show vlan <id>
Bind interfaces to VLANs. bind vlan <id> -ifnum bind vlan 10 -ifnum 10/1 -
<interface_name> tagged
Create services representing HT T P servers. add service <serviceName> add service SVC-S1
<ip> HT T P <port> 198.51.100.19 http 80
Create HT T P load balancing virtual servers and bind add lb vserver <name> HT T P add lb vserver LBVS-1 http
Create a custom T CP profile and set its MSS for add tcpProle <name> -mss add tcpprole ALL-JUMBO -mss
supporting jumbo frames. <positive_integer> 8960
Bind the custom T CP profile to the desired load set service <Name> - set lb vserver LBVS-1 -
balancing virtual server and services. tcpProleName <string> tcpProleName ALL-JUMBO
show ns cong
In addition to conguring an SNMP trap destination, downloading MIB les, and conguring one or more SNMP managers,
you can congure the NetScaler appliance for SNMPv3 queries.
T he following gure illustrates a network with a NetScaler SDX appliance that has SNMP enabled and congured. In the
gure, each SNMP network management application uses SNMP to communicate with the SNMP agent on the NetScaler
SDX appliance.
T he SNMP agent on the SDX appliance generates traps that are compliant with SNMPv2 only. T he supported traps can be
viewed in the SDX MIB le. You can download this le from the Downloads page in the SDX user interface.
1. On the configuration tab, in the navigation pane, expand System > SNMP, and then click SNMP T rap Destinations.
2. In the SNMP T rap Destinations pane, click Add.
3. In the Configure SNMP T rap Destination page, specify values for the following parameters:
Destination Server IPv4 address of the trap listener to which to send the SNMP trap messages.
Port UDP port at which the trap listener listens for trap messages. Must match the setting on the trap listener, or
the listener drops the messages. Minimum value: 1. Default: 162.
Community Password (string) sent with the trap messages, so that the trap listener can authenticate them. Can
include letters, numbers, and hyphen (-), period (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore (_)
characters.
Note: You must specify the same community string on the trap listener device, or the listener drops the messages.
Default: public.
4. Click Add, and then click Close. T he SNMP trap destination that you added appears in the SNMP T raps pane.
To modify the values of the parameters of an SNMP trap destination, in the SNMP Trap Destinations pane, select the
To remove an SNMP trap, in the SNMP Trap Destinations pane, select the trap destination that you want to remove,
and then click Delete. In the Conrm message box, click to remove the SNMP trap destination.
You must download the following le before you start monitoring a NetScaler SDX appliance.
You must configure the NetScaler SDX appliance to allow the appropriate SNMP managers to query it. You must also
provide the SNMP manager with the required appliance-specific information. For an IPv4 SNMP manager you can specify a
host name instead of the manager's IP address. If you do so, you must add a DNS name server that resolves the host name
of the SNMP manager to its IP address.
You must congure at least one SNMP manager. If you do not congure an SNMP manager, the appliance does not accept
or respond to SNMP queries from any IP address on the network. If you congure one or more SNMP managers, the
appliance accepts and responds only to SNMP queries from those specic IP addresses.
Simple Network Management Protocol Version 3 (SNMPv3) is based on the basic structure and architecture of SNMPv1
and SNMPv2. However, SNMPv3 enhances the basic architecture to incorporate administration and security capabilities,
such as authentication, access control, data integrity check, data origin verication, message timeliness check, and data
condentiality.
SNMP Views
SNMP Users
T hese entities function together to implement the SNMPv3 security features. Views are created to allow access to
subtrees of the MIB.
You must congure at least one SNMP manager. If you do not congure an SNMP manager, the appliance does not accept
or respond to SNMP queries from any IP address on the network. If you congure one or more SNMP managers, the
appliance accepts and responds only to SNMP queries from those specic IP addresses.
SNMP views restrict user access to specific portions of the MIB. SNMP views are used to implement access control.
To congure a view
1. On the Configuration tab, in the navigation pane, expand System, and then expand SNMP.
2. Click Views.
3. In the details pane, click Add.
4. In the Add SNMP View dialog box, set the following parameters:
Name Name for the SNMPv3 view. Can consist of 1 to 31 characters that include uppercase and lowercase letters,
numbers, and the hyphen (-), period (.) pound (#), at (@), equals (=), colon (:), and underscore (_) characters. You should
choose a name that helps identify the SNMPv3 view.
Subtree A particular branch (subtree) of the MIB tree, which you want to associate with this SNMPv3 view. You
must specify the subtree as an SNMP OID.
T ype Include or exclude the subtree, specified by the subtree parameter, in or from this view. T his setting can be
useful when you have included a subtree, such as A, in an SNMPv3 view and you want to exclude a specific subtree of
After you have created an SNMP view, add SNMP users. SNMP users have access to the MIBs that are required for
querying the SNMP managers.
To congure a user
1. On the Configuration tab, in the navigation pane, expand System, and then expand SNMP.
2. Click Users.
3. In the details pane, click Add.
4. In the Create SNMP Userpage, set the following parameters:
Name Name for the SNMPv3 user. Can consist of 1 to 31 characters that include uppercase and lowercase letters,
numbers, and the hyphen (-), period (.) pound (#), at (@), equals (=), colon (:), and underscore (_) characters.
Security Level Security level required for communication between the appliance and the SNMPv3 users. Select from
one of the following options:
noAuthNoPriv Require neither authentication nor encryption.
authNoPriv Require authentication but no encryption.
authPriv Require authentication and encryption.
Authentication Protocol Authentication algorithm used by the appliance and the SNMPv3 user for authenticating
the communication between them. You must specify the same authentication algorithm when you configure the
SNMPv3 user in the SNMP manager.
Authentication Password Pass phrase to be used by the authentication algorithm. Can consist of 1 to 31 characters
that include uppercase and lowercase letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals
(=), colon (:), and underscore (_) characters.
Privacy Protocol Encryption algorithm used by the appliance and the SNMPv3 user for encrypting the
communication between them. You must specify the same encryption algorithm when you configure the SNMPv3
user in the SNMP manager.
View Name Name of the configured SNMPv3 view that you want to bind to this SNMPv3 user. An SNMPv3 user can
access the subtrees that are bound to this SNMPv3 view as type INCLUDED, but cannot access the ones that are
type EXCLUDED.
T he appliance provides a predened set of condition entities called SNMP alarms. When the condition set for an SNMP
alarm is met, the appliance generates SNMP trap messages that are sent to the congured trap listeners. For example,
when the deviceAdded alarm is enabled, a trap message is generated and sent to the trap listener whenever a device
(instance) is provisioned on the appliance. You can assign a severity level to an SNMP alarm. When you do so, the
corresponding trap messages are assigned that severity level.
Following are the severity levels dened on the appliance, in decreasing order of severity:
Critical
Major
Minor
Warning
Informational (default)
For example, if you set a Warning severity level for the SNMP alarm named deviceAdded, the trap messages generated
You can also congure an SNMP alarm to log the corresponding trap messages generated whenever the condition on that
alarm is met.
To modify a predened SNMP alarm, click System > SNMP > Alarms.
When you run a SYSLOG server, it connects to the SDX appliance. T he appliance then starts sending all the log information
to the SYSLOG server, and the server can lter the log entries before storing them in a log le. A SYSLOG server can receive
log information from more than one SDX appliance, and an SDX appliance can send log information to more than one
SYSLOG server.
T he log information that a SYSLOG server collects from an SDX appliance is stored in a log file in the form of messages.
T hese messages typically contain the following information:
T he IP address of the SDX appliance that generated the log message
A time stamp
T he message type
T he log level (Critical, Error, Notice, Warning, Informational, Debug, Alert, or Emergency)
T he message information
You can use this information to analyze the source of the alert and take corrective action if required. First congure a
syslog server that the appliance sends log information to, and then specify the data and time format for recording the log
messages.
You can monitor the real-time values of the state and health of a virtual server. You can also view the attributes of a virtual
server, such as name, IP address, and type of virtual server.
To view the status of a virtual server
1. On the Configuration tab, in the navigation pane, click NetScaler > Entities > Virtual Servers.
2. In the right pane, under Virtual Servers, view the following statistics:
Device Name Name of the NetScaler VPX on which the virtual server is configured.
Name Name of the virtual server.
Protocol Service type of the virtual server. For example, HT T P, T CP, and SSL.
Effective State Effective state of the virtual server, based on the state of the backup vservers. For example, UP,
DOWN, or OUT OF SERVICE.
State Current state of the virtual server. For example, UP, DOWN, or OUT OF SERVICE.
Health Percentage of services that are in the UP state and are bound to the virtual server. T he following formula is
used to calculate the health percentage: (Number of bound UP services * 100) / T otal bound services
IP Address IP address of the virtual server. Clients send connection requests to this IP address.
Port ort on which the virtual server listens for client conections.
Last State Change Elapsed time (in days, hours, minutes, and seconds) since the last change in the state of the
virtual server, that is, the duration of time for which the virtual server has been in the current state. T his information is
You can monitor the real-time values of the state of a service and the duration for which the service has been in the
current state.
You can monitor the real-time state of a service group member from the NetScaler SDX interface.
You can monitor and manage the states of servers across the NetScaler instances. T his gives you visibility into the real-time
status of the servers and makes management of these servers easy when you have a large number of servers.
You can set the time interval for which you want the NetScaler SDX appliance to poll the real-time values of the virtual
servers, services, service groups, and servers. By default, the appliance polls the values every 30 minutes.
To conf igure the polling interval f or virtual servers, services, service groups, and Servers.
1. On the Configuration tab, click NetScaler > Entities, and in the right pane, click Configure Polling Interval.
2. In the Configure Polling Interval dialog box, type the number of minutes you want to set as the time interval for which
NetScaler SDX must poll the entity value. Minimum value of the polling interval is 30 minutes. Click OK.
You can view all the events generated on the NetScaler instances provisioned on the NetScaler SDX appliance. You can
view the details such as severity, category, date, source, and message for the each of the events.
To view the events, navigate to Conguration > NetScaler > Events > All Events
You can view the event history and entity details by selecting the event and clicking the Details button. You can also search
for a particular event or delete it from this page.
Note: After you delete the events, you will not be able to recover them.
Viewing Reports
T he Reports page displays the events summary in a graphical format. Your view of the reports can be based on various time
scales. By default the time scale is Day.
T o display the reports, navigate to Configuration > NetScaler > Events > Reports. Following are the graphical reports
supported on the Management Service
Events
T he Events report is a pie chart representation of the number of events, segmented and color coded on the basis of
their severity.
Note: T his list can contain counter names for all threshold-related events, entity names for all entity-related events, and
certificate names for certificate-related events.
3. Click Save.
4. Under Rule Actions, you can assign the notification actions for the event.
1. Mail Profile Mail server and mail profile details. An email is triggered when the events meet the defined filter criteria.
2. SMS Profile SMS server and SMS profile details. An SMS is triggered when the events meet the defined filter criteria.
2. On the Configure Events Configuration page, select the required severity level from the drop-down list.
3. Alternatively, you can suppress the events by selecting the Suppress check box. You can also specify the NetScaler
instances for which you want to suppress this event by using the Advanced option.
4. Click OK.
Note: T he NetScaler instance has to be registered with the Citrix T echnical Support server before Call Home can upload the
system data to the server when predefined error conditions occur on the appliance. Enabling the Call Home feature on the
NetScaler instance initiates the registration process.
Enabling and Disabling Call Home on a NetScaler Instance
You can enable the Call Home feature on NetScaler instance from the Management Service. When you enable the Call
Home feature, the Call Home process registers the NetScaler instance with the Citrix Technical Support server. T he
registration takes some time to complete. During that time, the Management Service displays the progress of registration..
To enable the Call Home feature, navigate to Conguration > NetScaler > Call Home, select the NetScaler instance, and
click the Enable button. In the conrmation page, click Yes.
To disable the Call Home feature, navigate to Conguration > NetScaler > Call Home, select the NetScaler instance, and
click the Disable button. On the conrmation page, click Yes.
If you enable Call Home, you can configure the following options:
1. (Optional) Specify the administrator's email address. T he Call Home process sends the email address to the Support
server, where it is stored for future correspondence regarding Call Home.
2. (Optional) Enable Call Home proxy mode. Call Home can upload your NetScaler instances data to the Citrix T aaS server
through a proxy server. T o use this feature, enable it on your NetScaler instance and specify the IP address and port
number of an HT T P proxy server. All traffic from the proxy server to the T aaS servers (over the Internet) is over SSL and
encrypted, so data security and privacy are not compromised.
To conf igure Call home on the NetScaler instance f rom the Management Service
You can congure the Call Home feature on a single instance or on multiple instances at the same time.
To congure Call Home feature on a single NetScaler instance, navigate to Conguration > NetScaler > Call Home, select
the NetScaler instance and click Congure button. In the Congure Call Home page, click OK.
In the Monitoring tab, click System Health. A summary of all the components is displayed. To view details of the monitored
components, expand System Health, and then click the component that you want to monitor.
Name
Name of the component, such as CPU, memory, or BMC firmware version.
Status
State (condition) of the component. For Hardware and for BMC Firmware Version, ERROR indicates a deviation from the
expected value. For calls to XenServer, ERROR indicates that the Management Service is unable to communicate with
XenServer by using an API, HT T P, PING, or SSH call. For Health Monitor Plugin, ERROR indicates that the plugin is not
installed on XenServer.
Current Value
Current value of the component. In normal conditions, current value is the same as the expected value.
Expected Value
Expected value for the component. Does not apply to software calls to XenServer.
You can monitor the disks on the NetScaler SDX appliance and take corrective action if required. To view the components
monitored, in the Monitoring tab, expand System Health, and then click Storage. Details are displayed for physical disks and
for virtual disks or partitions created from physical disks.
Name
Name of the physical disk.
Size
Size of the disk, in gigabytes (GB).
Utilized
Amount of data on the disk, in gigabytes (GB).
For virtual disks or partitions (Storage Repository), the following details are displayed:
Drive Bay
Number of the drive in the drive bay. You can sort the data on this parameter.
Status
State (condition) of the drive in the drive bay. Possible values:
GOOD: T he drive is in a good state and is ready for use.
FAIL: T he drive has failed and has to be replaced.
MISSING: A drive is not detected in the drive bay.
UNKNOWN: A new unformatted drive exists in the drive bay.
Name
System defined name of the storage depository.
Size
Size of the storage repository, in gigabytes (GB).
Utilized
Amount of data in the storage repository, in gigabytes (GB).
You can monitor the hardware components on the NetScaler SDX appliance and take corrective action if required. In the
Monitoring tab, expand System Health, and then click Hardware Sensors. T he monitoring function displays details about
the speed of different fans, the temperature and voltage of different components, and the status of the power supply.
Name
Name of the fan.
Status
State (condition) of the fan. ERROR indicates a deviation from the expected value. NA indicates that the fan is not present.
Current Value (RPM)
Current rotations per minute.
Name
Name
Name of the component, such as CPU core.
Status
State (condition) of the component. ERROR indicates that the current value is out of range.
Current Value (Volts)
Current voltage present on the component.
Name
Name of the component.
Status
State (condition) of the component. Possible values:
Error: Only one power supply is connected or working.
OK: Both the power supplies are connected and working as expected.
You can monitor the interfaces on the NetScaler SDX appliance and take corrective action if required. In the Monitoring
tab, expand System Health, and then click Interfaces. T he monitoring function details the following information about
each interface:
Interf ace
Interface number on the SDX appliance.
Status
State of the interface. Possible values: UP, DOWN.
VFs Assigned/Total
Number of virtual functions assigned to the interface, and the number of virtual functions available on that interface. You
can assign up to seven virtual functions on a 1G interface and up to 40 virtual functions on a 10G interface.
Tx Packets
Number of packets transmitted since the appliance was last started.
Rx Packets
Number of packets received since the appliance was last started.
Tx Bytes
Number of bytes transmitted since the appliance was last started.
Rx Bytes
Number of bytes received since the appliance was last started.
Tx Errors
Note
After you upgrade to NetScaler SDX Management Service release 11.1, system notication is enabled for all the event categories,
and the notications are sent to the existing email or SMS prole.
1. Navigate to System > Notif ications > Settings, and then click Change Notif ication Settings.
2. In the Conf igure System Notif ication Settings page, enter the following details:
- Category Category or categories of the events generated by the NetScaler SDX Management Service.
- Email Select an email distribution list from the drop-down menu. You can also create a new email distribution list
by clicking on the + icon and entering the new email server details in the appropriate fields.
- SMS (Text Message) Select an SMS distribution list from the drop-down menu. You can also create a
new SMS distribution list by clicking on the + icon and entering the new SMS server details in the appropriate fields.
3. Click OK.
If a task that you need to perform is not described below, see the list of tasks at the left.
A client session is created when a user logs on to the Management Service. You can view all the client sessions on the
appliance in the Sessions pane.
User Name
T he user account that is being used for the session.
IP Address
T he IP address of the client from which the session has been created.
Port
T he port being used for the session.
Login Time
T he time at which the current session was created on the SDX appliance.
Last Activity Time
T he time at which user activity was last detected in the session.
Session Expires In
T ime left for session expiry.
To view client sessions, on the Conguration tab, in the navigation pane, expand System, and then click Sessions.
To end a client session, in the Sessions pane, click the session you want to remove, and then click End Session.
You cannot end a session from the client that has initiated that session.
Conguring Policies
To keep the size of logged data within manageable limits, the SDX appliance runs backup and data-pruning policies
automatically at a specied time.
T he prune policy runs at 00:00 A.M every day and species the number of days of data to retain on the appliance. By
default, the appliance prunes data older than 3 days, but you can specify the number of days of data that you want to
keep. Only event logs, audit logs, and task logs are pruned.
T he backup policy runs at 00:30 A.M. every day and creates a backup of logs and conguration les. By default, the policy
retains three backups, but you can specify the number of backups you want to keep. And, using the backup policy, you can:
You can restart the Management Service from the System pane. Restarting the Management Service does not affect the
working of the instances. T he instances continue to function during the Management Service restart process.
Updated: 2013-10-07
You can remove any unneeded Management Service build and documentation les from the SDX appliance.
1. On the Conf iguration tab, in the navigation pane, expand Management Service, and then click the file that you want
to remove.
2. In the details pane, select the file name, and then click Delete.
You can use the Technical Support option to generate a tar archive of data and statistics for submission to Citrix technical
support. T his tar can be generated for the Management Service or the XenServer, or for both at the same time. You can
then download the le to your local system and send it to Citrix technical support.
In the Technical Support pane, you can view the following details.
Name
T he name of the tar archive file. T he file name indicates whether the tar is for the Management Service or the XenServer
server.
Last Modif ied
T he date when this file was last modified.
Size
T he size of the tar file.
1. In the Technical Support pane, select the technical support file that you want to download.
2. From the Action list, select Download. T he file is saved to your local computer.
You can now use the command line interface to perform operations on the Management Service. T he following operations
are supported:
Add, Set, Delete T o configure the resources.
Do T o perform system level operations. For example, management service upgrade or shutdown, or reboot.
Save T o add interfaces, which are used for NetScaler provisioning.
To access the CLI, start the secure shell (SSH) client from any workstation connected to the Management Service IP
address. Log on by using the administrator credentials.
You can access detailed information about command usage and syntax from the man pages.
T he Management Service also supports authentication requests from SSH. T he SSH authentication supports only
keyboard-interactive authentication requests. T he authorization of SSH users is limited to admin privileges only. Users with
readonly privileges cannot log on through SSH.
To congure authentication, specify the authentication type, and congure an authentication server.
Authorization through the Management Service is local. T he Management Service supports two levels of authorization.
Users with admin privileges are allowed to perform any action on the management service. Users with readonly privileges are
allowed to perform only read operations. T he authorization of SSH users is limited to admin privileges only. Users with
readonly privileges cannot log on through SSH.
Authorization for RADIUS and LDAP is supported by group extraction. You can set the group extraction attributes during
the conguration of RADIUS or LDAP servers on the Management Service. T he extracted group name is matched with the
group names on the Management Service to determine the privileges given to the user. A user can belong to multiple
groups. In that case, if any group to which the user belongs has admin privileges, the user has admin privileges. A Default
Authentication group attribute can be set during conguration. T his group is considered along with the extracted groups
for authorization.
In the case of TACACS authorization, the TACACS server administrator must permit a special command, admin for a user
who is to have admin privileges and deny this command for users with readonly privileges. When a user logs on to NetScaler
SDX appliance, the Management Service checks if the user has permission to execute this command and if the user has
permission, the user is assigned the admin privileges else the user is assigned readonly privileges.
Groups are logical sets of users that need to access common information or perform similar kinds of tasks. You can
organize users into groups dened by a set of common operations. By providing specic permissions to groups rather than
individual users, you can save time when creating new users.
If you are using external authentication servers for authentication, groups in NetScaler SDX can be congured to match
groups congured on authentication servers. When a user belonging to a group whose name matches a group on an
authentication server, logs on and is authenticated, the user inherits the settings for the group in NetScaler SDX appliance.
1. On the Conf iguration tab, under System, expand Administration, and then click Groups.
2. In the details pane, click Add.
3. In the Create System Group dialogue box, set the following parameters:
Name Name of the Group. Maximum length: 128
Updated: 2014-04-11
A user logs on to the NetScaler SDX appliance to perform appliance management tasks. To allow a user to access the
appliance, you must create a user account on the SDX appliance for that user. Users are authenticated locally, on the
appliance.
Important: T he password applies to the SDX appliance, Management Service, and XenServer. Do not change the password
directly on the XenServer.
To congure a user account
1. On the Conf iguration tab, under System, expand Administration, and then click Users. T he Users pane displays a list of
existing user accounts, with their permissions.
2. In the Users pane, do one of the following:
T o create a user account, click Add.
T o modify a user account, select the user, and then click Modify.
3. In the Create System User or Modify System User dialog box, set the following parameters:
Name* T he user name of the account. T he following characters are allowed in the name: letters a through z and A
through Z, numbers 0 through 9, period (.), space, and underscore (_). Maximum length: 128. You cannot change the
name.
Password* T he password for logging on to the appliance. Maximum length: 128
Confirm Password* T he password.
Permission* T he user's privileges on the appliance. Possible values:
admin T he user can perform all administration tasks related to the Management Service.
readonly T he user can only monitor the system and change the password of the account.
Default: admin.
Enable External Authentication Enables external authentication for this user. Management Service attempts
external authentication before database user authentication. If this parameter is disabled, user is not authenticated
with the external authentication server.
Configure Session T imeout Enables you to configure the time period for how long a user can remain active. Specify
the following details:
Session T imeout T he time period for how long a user session can remain active.
Session T imeout Unit T he timeout unit, in minutes or hours.
Groups Assign the groups to the user.
*A required parameter
4. Click Create or OK, and then click Close. T he user that you created is listed in the Users pane.
Updated: 2014-04-11
From the Management Service interface, you can specify local or external authentication. External authentication is
disabled for local users by default. It can be enabled by checking the Enable External Authentication option when adding
the local user or modifying the settings for the user.
Important: External authentication is supported only after you set up a RADIUS, LDAP, or T ACACS authentication server.
To set the authentication type
You can authenticate to the Management Service NIT RO interface using basic authentication. By default, basic
authentication is enabled in the SDX appliance. Perform the following to disable basic authentication using the
Management Service interface.
To congure an external authentication, specify the authentication type, and congure an authentication server.
T o configure RADIUS authentication, specify the authentication type as RADIUS, and configure the RADIUS
authentication server.
Management Service supports RADIUS challenge response authentication according to the RADIUS specications. RADIUS
users can be congured with a one-time password on RADIUS server. When the user logs on to NetScaler SDX appliance
the user is prompted to specify this one time password.
1. On the Conf iguration tab, under System, expand Authentication, and then click Radius.
2. In the details pane, click Add.
3. In the Create Radius Server dialogue box, type or select values for the parameters:
Name* Name of the server.
IP Address* Server IP address.
Port* Port on which the RADIUS server is running. Default value: 1812.
T ime-out* Number of seconds the system will wait for a response from the RADIUS server. Default value: 3.
Secret Key* Key shared between the client and the server. T his information is required for communication between
the system and the RADIUS server.
Enable NAS IP Address Extraction If enabled, the system's IP address (Management Service IP) is sent to the server
as the "nasip" in accordance with the RADIUS protocol.
NASID If configured, this string is sent to the RADIUS server as the "nasid" in accordance with the RADIUS protocol.
Group Prefix Prefix string that precedes group names within a RADIUS attribute for RADIUS group extraction.
Group Vendor ID Vendor ID for using RADIUS group extraction.
Group Attribute T ype Attribute type for RADIUS group extraction.
Group Separator Group separator string that delimits group names within a RADIUS attribute for RADIUS group
extraction.
IP Address Vendor Identifier Vendor ID of the attribute in the RADIUS which denotes the intranet IP. A value of 0
denotes that the attribute is not vendor encoded.
IP Address Attribute T ype Attribute type of the remote IP address attribute in a RADIUS response.
Password Vendor Identifier Vendor ID of the password in the RADIUS response. Used to extract the user password.
Password Attribute T ype Attribute type of the password attribute in a RADIUS response.
Password Encoding How passwords should be encoded in the RADIUS packets traveling from the system to the
T o configure LDAP authentication, specify the authentication type as LDAP, and configure the LDAP authentication
server.
To add an LDAP server
1. On the Conf iguration tab, under System, expand Authentication, and then click LDAP.
2. In the details pane, click Add.
3. In the Create LDAP Server dialogue box, type or select values for the parameters:
Name* Name of the server.
IP Address* Server IP address.
Port* Port on which the LDAP server is running. Default value: 389.
T ime-out* Number of seconds the system will wait for a response from the LDAP server.
Base DN Base, or node where the LDAP search should start.
T ype T ype of LDAP server. Possible values: Active Directory (AD) and Novell Directory Service (NDS).
Administrative Bind DN Full distinguished name that is used to bind to the LDAP server.
Administrative Password Password that is used to bind to the LDAP server.
Validate LDAP Certificate Check this option to validate the certificate received from LDAP server.
LDAP Host Name Hostname for the LDAP server. If the validateServerCert parameter is enabled, this parameter
specifies the host name on the certificate from the LDAP server. A host-name mismatch causes a connection failure.
Server Logon Name Attribute Name attribute used by the system to query the external LDAP server or an Active
Directory.
Search Filter String to be combined with the default LDAP user search string to form the value. For example,
vpnallowed=true with ldaploginame samaccount and the user-supplied username bob would yield an LDAP
search string of: (&(vpnallowed=true)(samaccount=bob).
Group Attribute Attribute name for group extraction from the LDAP server.
Sub Attribute Name Subattribute name for group extraction from the LDAP server.
Security T ype T ype of encryption for communication between the appliance and the authentication server. Possible
values:
PLAINT EXT : No encryption required.
Default Authentication Group Default group that is chosen when the authentication succeeds in addition to
extracted groups.
Referrals Enable following of LDAP referrals received from LDAP server.
Maximum LDAP Referrals Maximum number of LDAP referrals to follow.
Enable Change Password Allow user to modify the password if the password expires. You can change the password
only when the Security T ype configured is T LS or SSL.
Enable Nested Group Extraction Enable Nested Group extraction feature.
Maximum Nesting Level Number of levels at which group extraction is allowed.
T o configure T ACACS authentication, specify the authentication type as T ACACS, and configure the T ACACS
authentication server.
To add a TACACS server
1. On the Conf iguration tab, under System, expand Authentication, and then click TACACS.
2. In the details pane, click Add.
3. In the Create T ACACS Server dialogue box, type or select values for the parameters:
Name Name of the T ACAS server
IP Address IP address of the T ACACS server
Port Port on which the T ACACS Server is running. Default value: 49
T ime-out Maximum number of seconds the system will wait for a response from the T ACACS server
T ACACS Key Key shared between the client and the server. T his information is required for the system to
communicate with the T ACACS server
Accounting Enables Management Service to log audit information with T ACACAS server.
Default Authentication Group Default group that is chosen when the authentication succeeds in addition to
extracted groups.
4. Click Create, and then click Close.
When a network interface is bound to a channel, the channel parameters have precedence over the network interface
parameters. (T hat is, the network interface parameters are ignored.) A network interface can be bound only to one channel.
When a network interface is bound to a channel, it drops its VLAN conguration. T he interface is removed from the VLAN
that it originally belonged to and added to the default VLAN. However, you can bind the channel back to the old VLAN, or
to a new one. For example, if you bind network interfaces 1/2 and 1/3 to a VLAN with ID 2 (VLAN 2), and then bind them to
channel LA/1, the network interfaces are moved to the default VLAN, but you can bind the channel to VLAN 2.
Note:
An interface must be part of only one channel.
A minimum of two interfaces are required to configure a channel.
T he interfaces that form part of a channel are not listed in the Network Settings view when you add or modify a
NetScaler instance. Instead of the interfaces, the channels are listed.
If you congure a channel by using three interfaces that are assigned to one instance, and a second instance uses some of
these interfaces, the Management Service shuts down the second instance, modies the network settings, and restarts
the instance. For example, assume two instances, Instance1 and Instance2. When these instances are provisioned,
interfaces 10/1, 10/2, and 10/3 are assigned to Instance1, and interfaces 10/1 and 10/2 are assigned to Instance2. If an LA
channel is created with interfaces 10/1, 10/2, and 10/3, instance1 is not restarted. However, the Management Service shuts
down Instance2, assigns interface 10/3 to Instance2, and then restarts Instance2.
If you remove an interface from an LA channel, the changes are stored in the database, and the interface appears in the
Network Settings view when you add or modify an instance. Before you delete the interface, only the channel that the
interface is a part of is listed.
For example, consider a six-node cluster, across two NetScaler SDX appliances, in which all six nodes are connected to an
upstream switch. A cluster LA channel (CLA/1) is formed by binding interfaces 0/1/2, 1/1/3, 2/1/4, 3/1/2, 4/1/3, and 5/1/4.
Each channel has a unique MAC address agreed upon by cluster nodes.
T he channel can bind both local and remote SDX nodes' interfaces.
A maximum of four cluster LA channels are supported in a cluster.
A maximum of 16 interfaces can be bound to each cluster LA channel.
Backplane interfaces cannot be part of a cluster LA channel.
When an interface is bound to a cluster LA channel, the channel parameters take precedence over the network
interface parameters.
A network interface can be bound to only one channel.
Management access to a cluster node must not be configured on a cluster LA channel (for example, CLA/1) or its
member interfaces. When the node is INACT IVE, the corresponding cluster LA interface is marked as POWER OFF, which
causes it to lose management access.
Points to remember:
Enable LACP (by specifying the LACP mode as either ACT IVE or PASSIVE).
Note: Make sure the LACP mode is not set as PASSIVE on both the NetScaler cluster and the external connecting
device.
For creating a cluster LA channel, the LACP key can have a value from 5 through 8. T hese LACP Keys are mapped to
CLA/1, CLA/2, CLA/3, and CLA/4.
On the NetScaler SDX appliance, the cluster link aggregation group (CLAG) member interfaces cannot be shared with
other virtual machines.
On the upstream switch, set LACP timeout to "short" to avoid long-duration traffic black holes on cluster nodes when
the upstream switch is not notified of power down of the CLAG and its member interfaces until after LACP timeout.
Prerequisites
Make sure that you have created a cluster of NetScaler instances. T he nodes of the cluster can be NetScaler instances on
the same SDX appliance or on other SDX appliances that are available on the same subnet.
3. On the Cluster Instances page, select the cluster and click CLAG.
b. In the Interf aces section, from the Available selection box, select the interfaces and click +.
i. In the Alias eld, enter an alternative name for the cluster LA channel.
ii. In the LACP Timeout eld, select any one of the following values to dene the interval after which a link is not
aggregated, if the link does not receive an LACPDU.
T he value must match on all the ports participating in link aggregation on the SDX appliance and the partner
node:
Long 30 seconds
Short 1 second
iii. For High Availability (HA) conguration, select the HA Monitoring checkbox to monitor the channel for failure
events. Failure of any LA channel that has HA MON enabled triggers HA failover.
iv. Select Tag All to add a four-byte 802.1q tag to every packet sent on this channel. T he ON setting applies tags
for all VLANs that are bound to this channel. OFF applies the tag for all VLANs other than the native VLAN.
Limitations
Citrix Cipher Name Openssl CipherName Hex Code Protocol Key Auth MAC
Exchange
T LS1.2-AES128-GCM- AES-
SHA256 AES128-GCM-SHA256 0x009C T LSv1.2 RSA RSA GCM(128)
T LS1-ECDHE-RSA- ECDHE-RSA-AES256-
AES256-SHA SHA 0xC014 SSLv3 ECC-DHE RSA AES(256)
T LS1-ECDHE-RSA- ECDHE-RSA-AES128-
AES128-SHA SHA 0xC013 SSLv3 ECC-DHE RSA AES(128)
T LS1.2-ECDHE-RSA-AES- ECDHE-RSA-AES128-
128-SHA256 SHA256 0xC027 T LSv1.2 ECC-DHE RSA AES(128)
T LS1.2-DHE-RSA-AES- DHE-RSA-AES256-
256-SHA256 SHA256 0x006B T LSv1.2 DH RSA AES(256)
T LS1.2-DHE-RSA-AES- DHE-RSA-AES128-
128-SHA256 SHA256 0x0067 T LSv1.2 DH RSA AES(128)
T LS1-DHE-RSA-AES- DHE-RSA-AES256-
256-CBC-SHA SHA 0x0039 SSLv3 DH RSA AES(256)
T LS1-DHE-RSA-AES-128- DHE-RSA-AES128-
CBC-SHA SHA 0x0033 SSLv3 DH RSA AES(128)
T LS1-DHE-DSS-AES- DHE-DSS-AES256-
256-CBC-SHA SHA 0x0038 SSLv3 DH DSS AES(256)
T LS1-DHE-DSS-AES- DHE-DSS-AES128-
128-CBC-SHA SHA 0x0032 SSLv3 DH DSS AES(128)
T LS1-ECDHE-RSA-DES- ECDHE-RSA-DES-
CBC3-SHA CBC3-SHA 0xC012 SSLv3 ECC-DHE RSA 3DES(168)
SSL3-EDH-RSA-DES- EDH-RSA-DES-CBC3-
0x0016 SSLv3 DH RSA 3DES(168)
SSL3-EDH-DSS-DES- EDH-DSS-DES-CBC3-
CBC3-SHA SHA 0x0013 SSLv3 DH DSS 3DES(168)
T LS1-ECDHE-RSA-RC4-
SHA ECDHE-RSA-RC4-SHA 0xC011 SSLv3 ECC-DHE RSA RC4(128)
SSL3-EXP-RC2-CBC-
MD5 EXP-RC2-CBC-MD5 0x0006 SSLv3 RSA(512) RSA RC2(40)
DHE-DSS-AES128-
SSL2-DES-CBC-MD5 SHA256 0x0040 SSLv2 RSA RSA DES(56)
SSL3-EDH-DSS-DES- EDH-DSS-DES-CBC-
CBC-SHA SHA 0x0012 SSLv3 DH DSS DES(56)
SSL3-EXP-EDH-DSS- EXP-EDH-DSS-DES-
DES-CBC-SHA CBC-SHA 0x0011 SSLv3 DH(512) DSS DES(40)
SSL3-EDH-RSA-DES- EDH-RSA-DES-CBC-
CBC-SHA SHA 0x0015 SSLv3 DH RSA DES(56)
SSL3-EXP-EDH-RSA- EXP-EDH-RSA-DES-
DES-CBC-SHA CBC-SHA 0x0014 SSLv3 DH(512) RSA DES(40)
SSL3-ADH-DES-CBC-
SHA ADH-DES-CBC-SHA 0x001A SSLv3 DH None DES(56)
T LS1-ADH-AES-128-
CBC-SHA ADH-AES128-SHA 0x0034 SSLv3 DH None AES(128)
T LS1-ADH-AES-256-
CBC-SHA ADH-AES256-SHA 0x003A SSLv3 DH None AES(256)
SSL3-EXP-ADH-RC4-
MD5 EXP-ADH-RC4-MD5 0x0017 SSLv3 DH(512) None RC4(40)
SSL3-EXP-ADH-DES- EXP-ADH-DES-CBC-
CBC-SHA SHA 0x0019 SSLv3 DH(512) None DES(40)
T he following table lists the predened cipher groups provided by the SDX appliance.
To view the predened cipher groups, on the Conguration tab, in the navigation pane, expand Management Service, and
then click Cipher Groups.
You can create custom cipher groups from the list of supported SSL ciphers.
1. On the Conf iguration tab, in the navigation pane, expand Management Service, and then click Cipher Groups.
2. In the Cipher Groups pane, click Add.
3. In the Create Cipher Group dialog box, perform the following:
1. In the Group Name field, enter a name for the custom cipher group.
2. In the Cipher Group Description field, enter a brief description of the custom cipher group.
3. In the Cipher Suites section, click Add and select the ciphers to include in the list of supported SSL ciphers.
To view the existing cipher bindings, on the Conguration tab, in the navigation pane, expand System, and then click
Change SSL Settings under System Settings.
Note
After you upgrade to the latest version of the Management Service, the list of existing cipher suites shows the OpenSSL names.
Once you bind the ciphers from the upgraded Management Service, the display uses the Citrix naming convention.
1. On the Conf iguration tab, in the navigation pane, expand Management Service, and then click Backup Files.
2. In the Backup Files pane, click Back Up.
3. in the New Backup File dialog box, select the Password Protect f ile check box to encrypt the backup file.
4. In the Password and Conf irm Password fields, enter and confirm the password for the backup file.
5. Click Continue.
T he backup process creates a backup le and the lename of the backup le inculdes the current IP address of the
Management Service and the timestamp when the backup was taken.
Scheduled Backup
By default, NetScaler SDX creates a backup every 24 hours using a backup policy. Using the backup policy, you can dene
the number of backup les that you want to retain in the SDX appliance and also you can encrypt the scheduled backup
les using a password to ensure that the backup le is secure.
You can manually transfer the backup le to an external backup server. Make sure that you have the external backup server
details before you manually transfer the backup le.
You can restore the NetScaler SDX appliance to the conguration available in the backup le. During the appliance restore,
all the current conguration is deleted.
Note
If you are restoring the NetScaler SDX appliance using the backup of a different NetScaler SDX appliance, make sure that you add
the licenses and congure Management Service network settings in the appliance as per the settings available in the backup le
before you start the restore process.
Make sure that the platform variant on which the backup was taken is same as on which you are trying to restore (restoring the
backups between different platform variants is not supported).
1. On the Conf iguration tab, in the navigation pane, expand Management Service, and then click Backup Files.
2. In the Backup Files pane, select the backup file and then click Restore.
3. In the Restore dialog box, select Appliance Restore, and then click OK.
4. (Optional) If the backup file is encrypted, when prompted, enter the password and then click OK.
You can restore the NetScaler instance in the NetScaler SDX appliance to the NetScaler instances that are available in the
backup le.
1. On the Conf iguration tab, in the navigation pane, expand Management Service, and then click Backup Files.
2. In the Backup Files pane, select the backup file and then click Restore.
3. In the Restore dialog box, select Instance Restore.
4. Select the NetScaler instances that you want to restore and then click OK.
5. (Optional) If the backup file is encrypted, when prompted, enter the password and then click OK.
Before performing an appliance reset, back up all the data stored on the appliance, including the settings of all the
NetScaler instances provisioned on the appliance.
Citrix recommends that you store the les outside the appliance. Performing an appliance reset terminates all current client
sessions with the Management Service, so you have to log back on to the Management Service for any additional
conguration tasks. When you are ready to restore the data, import the backup les by using the Management Service.
Config Reset
Factory Reset
Clean Install
T he Management Service provides the Cong Reset option to reset the conguration of the Appliance. T he Cong Reset
option performs the following:
1. Under Conf iguration tab, click the System node and then under the System Administration group, click Appliance
Reset.
2. In the Appliance Reset dialog box, select Conf ig Reset in the Reset Type drop-down list, and click OK.
Before performing a factory reset, back up all the data stored on the appliance, including the settings of all the NetScaler
instances provisioned on the appliance. Citrix recommends that you store the les outside the appliance. Performing a
factory reset terminates all current client sessions with the Management Service, so you have to log back on to the
Management Service for any additional conguration tasks. When you are ready to restore the data, import the backup
les by using the Management Service.
Important
Make sure you connect a serial console cable to the appliance before performing a factory reset.
1. Under Conf iguration tab, click System node and then under the System Administration group, click Appliance Reset.
2. In the Appliance Reset dialog box, select Factory Reset in the Reset Type drop-down list, and click OK.
T he Management Service provides the Clean Install option that allows you to install an arbitrary version of single bundle
image on the appliance. It enables you to perform fresh install of the single bundle image as the new default boot image
and it removes the existing conguration in the NetScaler SDX appliance.
SDX 14xxx
SDX 25xxx
11.0.xx
Note: T he clean-install option is supported on other NetScaler SDX platforms if they have
10G factory partition.
SDX 14xxx
SDX 25xxx
11.1.xx
Note: T he clean-install option is supported on other NetScaler SDX platforms if they have
10G factory partition.
Prerequisites
Make sure that:
Important
Make sure that you do not restart or power cycle the appliance while using the Clean Install option.
1. Under Conf iguration tab, click System node and then under the System Administration group, click Appliance Reset.
2. In the Appliance Reset dialog box, select Clean Install in the Reset Type drop-down list, and click OK.
To enable cascading authentication, you need to add the external authentication servers to the Management Service. For
more information, see Conguring External Authentication. You can add any type of the supported external authentication
servers (RADIUS, LDAP, and TACACS). For example, if you want to add four external authentication servers for cascading
authentication, you can add two RADIUS servers, one LDAP server, and one TACACS server, or four servers of the same
type. You can congure up to 32 external authentication servers in NetScaler MAS.
T he selected servers are displayed on the Authentication Servers page as shown in the gure below. You can specify the
order of authentication by using the icon next to a server name to move the server up or down in the list.
To provision NetScaler instances on the SDX appliance, rst, you need to dene an admin prole to attach to the NetScaler
instance. T his prole species the user credentials that are used by the Management Service to provision the NetScaler
instance and later, to communicate with the instance to retrieve conguration data. You can also use the default admin
prole. Next, you need to upload the .xva image le to the Management Service. After uploading the .xva le, you can begin
adding NetScaler instances using the Management Service. T he Management Service implicitly deploys the NetScaler
instances on the SDX appliance and then downloads conguration details of the instances.
Warning
Make sure that you modify the provisioned network interfaces or VLANS of an instance using the Management Service instead of
performing the modications directly on the instance.
Admin proles specify the user credentials that are used by the Management Service when provisioning the NetScaler
instances, and later when communicating with the instances to retrieve conguration data. T he user credentials specied in
an admin prole are also used by the client when logging on to the NetScaler instances through the CLI or the
conguration utility.
Admin proles also enable you to specify that the Management Service and a NetScaler VPX instance should communicate
with each other only over a secure channel or using HT T P.
T he default admin prole for an instance species a user name of nsroot, and the password is also nsroot. T his prole
cannot be modied or deleted. However, you should override the default prole by creating a user-dened admin prole and
attaching it to the instance when you provision the instance. T he Management Service administrator can delete a user-
dened admin prole if it is not attached to any NetScaler instance.
Important:
Do not change the password directly on the NetScaler VPX instance. If you do so, the instance becomes unreachable from
the Management Service. To change a password, rst create a new admin prole, and then modify the NetScaler instance,
selecting this prole from the Admin Prole list.
To change the password of NetScaler instances in a high availability setup, rst change the password on the instance
designated as the secondary node, and then change the password on the instance designated as the primary node.
Remember to change the passwords only by using the Management Service.
If you do not want to use a user-dened admin prole, you can remove it from the Management Service. To remove a
user-dened admin prole, in the Admin Proles pane, select the prole you want to remove, and then click Delete.
You have to upload the NetScaler .xva les to the SDX appliance before provisioning the NetScaler instances. You can also
download an .xva image le to a local computer as a backup. T he .xva image le format is: NSVPX-XEN-ReleaseNumber-
BuildNumber_nc.xva
Note: By default, an .xva image file based on the NetScaler 9.3 release is available on the SDX appliance.
In the NetScaler XVA Files pane, you can view the following details.
Name
Name of the .xva image file. T he file name contains the release and build number. For example, the file name NSVPX-XEN-
9.3-25_nc.xva refers to release 9.3 build 25.
Last Modif ied
Date when the .xva image file was last modified.
Size
Size, in MB, of the .xva image file.
When you add NetScaler instances from the Management Service, you need to provide values for some parameters, and
the Management Service implicitly congures these settings on the NetScaler instances.
Typically, the Management Service and the management address (NSIP) of the NetScaler VPX instance are in the same
subnetwork, and communication is over a management interface. However, if the Management Service and the instance
are in different subnetworks, you have to specify a VLAN ID at the time of provisioning a NetScaler VPX instance, so that
the instance can be reached over the network when it starts. If your deployment requires that the NSIP not be accessible
through any interface other than the one selected at the time of provisioning the VPX instance, select the NSVLAN option.
Citrix recommends the default setting NSVLAN not selected. You cannot change this setting after you have provisioned
the NetScaler instance.
Note: For a high availability setup (active-active or active-standby), Citrix recommends that you congure the two
NetScaler instances on different SDX appliances. Make sure that the instances in the setup have identical resources, such
as CPU, memory, interfaces, packets per second (PPS), and throughput.
Name*
T he host name assigned to the NetScaler instance.
IP Address*
T he NetScaler IP (NSIP) address at which you access a NetScaler instance for management purposes. A NetScaler instance
can have only one NSIP. You cannot remove an NSIP address.
Netmask*
T he subnet mask associated with the NSIP address.
Gateway*
T he default gateway that you must add on the NetScaler instance if you want access through SSH or the conguration
utility from an administrative workstation or laptop that is on a different network.
Nexthop*
T he alternate IP address for the static route in VPX that should be used to establish connection with the Management
Service, if the default route is not available.
XVA File*
T he .xva image le that you need to provision. T his le is required only when you add a NetScaler instance.
Feature License*
Species the license you have procured for the NetScaler. T he license could be Standard, Enterprise, and Platinum.
Admin Prole*
T he prole you want to attach to the NetScaler instance. T his prole species the administrator (nsroot) user credentials
that are used by the Management Service to provision the NetScaler instance and later, to communicate with the instance
to retrieve conguration data. T he user credentials used in this prole are also used while logging on to the NetScaler
instance by using the GUI or the CLI. It is recommended that you change the default password of the admin prole. T his is
done by creating a new prole with a user-dened password. For more information, see Creating Admin Proles above.
#SSL chips*
Number of SSL chips assigned to the NetScaler instance. SSL chips cannot be shared. T he instance is restarted if you
modify this value.
Throughput (Mbps)*
T he total throughput allocated to the NetScaler instance. T he total used throughput should be less than or equal to the
maximum throughput allocated in the SDX license. If the administrator has already allocated full throughput to multiple
instances, no further throughput can be assigned to any new instance.
CPU
Assign a dedicated core or cores to the instance, or the instance shares a core with other instance(s). If you select shared,
then one core is assigned to the instance but the core might be shared with other instances if there is a shortage of
resources. Reboot affected Instances if CPU cores are reassigned. Restart the instances on which CPU cores are reassigned
to avoid any performance degradation.
From NetScaler SDX release 11.1.x.x (MR4), if you are using SDX 25000xx platform, you can assign a maximum of 16 cores to
an instance. Also, if you are using SDX 2500xxx platform, you can assign a maximum of 11 cores to an instance.
Note: For an instance, the maximum throughput that you congure is 180 Gbps.
T he following table lists the supported NetScaler VPX, Single bungle image version, and the number of cores you can assign
to an instance:
1 to 8 cores
11.1 MR4 11.1 MR3 or earlier
Note: You cannot assign 9 cores.
1 to 8 cores
11.1 MR4 11.0/10.5
Note: You cannot assign 9 cores.
Password*
T he password for the instance administrator's user name.
Conrm Password*
T he password for the instance administrator's user name.
Allow L2 Mode
Allow L2 mode on the NetScaler instance. Select this option before you log on to the instance and enable L2 mode. For
more information, see Allowing L2 Mode on a NetScaler Instance.
Note: If you disable L2 mode for an instance from the Management Service, you must log on to the instance and disable L2
mode from that instance. Failure to do so might cause all the other NetScaler modes to be disabled after you restart the
instance
Management LA
Select to associate the management channel to the instance.
VLAN Tag
Specify a VLAN ID for the management channel member interfaces.
Important: T he interface IDs of interfaces that you add to an instance do not necessarily correspond to the physical
interface numbering on the SDX appliance. For example, if the rst interface that you associate with instance 1 is SDX
interface 1/4, it appears as interface 1/1 when you log on to the instance and view the interface settings, because it is the
rst interface that you associated with instance 1.
If a non-zero VLAN ID is specified for a NetScaler instance interface, all the packets transmitted from the NetScaler
instance through that interface will be tagged with the specified VLAN ID. If you want incoming packets meant for the
NetScaler instance that you are configuring to be forwarded to the instance through a particular interface, you must
tag that interface with a VLAN ID and ensure that the incoming packets specify that VLAN ID.
For an interface to receive packets with multiple VLAN tags, you must specify a VLAN ID of 0 for the interface, and you
must specify the required VLAN IDs for the NetScaler instance interface.
VLAN ID
An integer that uniquely identies the VLAN. Minimum value: 2. Maximum value: 4095.
Allowed VLANs
Specify a list of VLAN IDs that can be associated with a NetScaler instance.
VRID IPV4
VRID IPV6
T he IPv6 VRID that identies the VMAC. Possible values: 1 to 255. For more information, see Conguring VMACs on an
Interface.
MAC Address
Specify a MAC address that overrides the generated MAC address. Used with the Custom mode setting.
NSVLAN
A VLAN to which the subnet of the NetScaler management IP (NSIP) address is bound. T he NSIP subnet is available only on
interfaces that are associated with the NSVLAN. Select this check box if your deployment requires that the NSIP not be
accessible through any interface other than the one you select in the VLAN Settings dialog box. T his setting cannot be
changed after the NetScaler instance is provisioned.
Note:
HA heartbeats will be sent only on the interfaces that are part of the NSVLAN.
You can configure an NSVLAN only from VPX XVA build 9.3-53.4 and later.
Important: If NSVLAN is not selected, running the "clear cong full" command on the VPX instance deletes the VLAN
conguration.
Tagged
Designate all interfaces associated with the VLAN as 802.1q tagged interfaces.
Note: If you select tagged, make sure that management interfaces 0/1 and 0/2 are not added.
Interf aces
Bind the selected interfaces to the VLAN.
T he NetScaler SDX appliance administrator can enforce specic 802.1Q VLANs on the virtual interfaces associated with
NetScaler instances. T his capability is especially helpful in restricting the usage of 802.1Q VLANs by the instance
administrators. If two instances belonging to two different companies are hosted on an SDX appliance, you can restrict
the two companies from using the same VLAN ID, so that one company does not see the other company's trafc. If an
instance administrator, while provisioning or modifying a VPX instance, tries to assign an interface to an 802.1Q VLAN, a
validation is performed to verify that the VLAN ID specied is part of the allowed list.
By default, any VLAN ID can be used on an interface. To restrict the tagged VLANs on an interface, specify the VLAN IDs in
the Network Settings at the time of provisioning a NetScaler instance, or later by modifying the instance. To specify a
range, separate the IDs with a hyphen (for example 10-12). If you initially specify some VLAN IDs but later delete all of them
from the allowed list, you can use any VLAN ID on that interface. In effect, you have restored the default setting.
After creating a list of allowed VLANs, the SDX administrator does not have to log on to an instance to create the VLANs.
T he administrator can add and delete VLANs for specic instances from the Management Service.
Important: If L2 mode is enabled, the administrator must take care that the VLAN IDs on different NetScaler instances do
not overlap.
To specify the permitted VLAN IDs
1. In the Provision NetScaler Wizard or the Modify NetScaler Wizard, on the Network Settings page, in the Allowed VLANs
text box, specify the VLAN ID(s) allowed on this interface. Use a hyphen to specify a range. For example, 2-4094.
2. Follow the instructions in the wizard.
3. Click Finish, and then click Close.
In this bandwidth allocation method, each VPX is assigned a dedicated bandwidth. T he VPX is allowed to use the
bandwidth up to the limit set. In dedicated mode the minimum and maximum bandwidth allocated are the same. If during a
period of time, the VPX requires more bandwidth than allocated, then in the dedicated mode the VPX cannot increase its
throughput. T his can be a downside if a VPX is serving critical requests.
Also, if an SDX appliance has a number of VPXs and few of them are not utilizing their allocated bandwidth, then in
dedicated mode it is not possible to share their unused bandwidth. To overcome all these challenges, a dedicated
bandwidth with minimum assured rate with the ability to dynamically increase the bandwidth is useful.
Dedicated bandwidth with minimum assured throughput and bandwidth bursting ability
In this bandwidth allocation method, a VPX is allocated a minimum assured bandwidth with the exibility to increase its
bandwidth up to a preset limit. T he extra bandwidth that a VPX can use is called burst capacity.
T he benet of burst capacity is that if some of VPXs are having extra capacity which they are not using, then that can be
allocated to other VPX which are fully utilizing their allocated bandwidth and require more for certain periods of time.
Various service providers are also interested in providing various add-on services to their customers that require dedicated
capacity. At the same time they do not want to over provision bandwidth. Burstable bandwidth helps in such scenarios
where the customers are assured of a specic bandwidth with the option to increase the bandwidth during high demand
periods.
Before you choose burstable throughput, you need to enable dynamic burst throughput allocation. To enable this option,
navigate to Conguration > System and from the System Settings group, select Change System Settings. Click on the
Enable Dynamic Burst T hroughput Allocation check box to enable dynamic throughput.
When you provision a VPX, you can select from bandwidth burst or dynamic throughput. In the SDX UI, click Conguration >
NetScaler > Instances > Add. In the Resource Allocation section of the Provision NetScaler page, choose Burstable option
from the T hroughput Allocation Mode drop down list for burstable throughput. If you want to use xed rate of
throughput, select Fixed. By default, xed mode is set for bandwidth allocation. It is not necessary that all the VPXs work in
the same mode. Each VPX can be congured in different mode.
Note: If you are migrating SDX from a release prior to 10.5.e, then by default all the VPXs are in the fixed allocation mode.
Determining the Maximum Burst Bandwidth f or a VPX instance
T he extent to which each VPX is allowed to burst is computed through an algorithm. When you provision a VPX with
burstable bandwidth, then each such VPX has to be given a priority. T he allocation of burstable bandwidth depends on this
burst priority. T he priority varies from P0 to P4 with P0 being the highest priority and P4 being the lowest.
Let us take a case where there are 2 VPX, namely VPX1 and VPX2. T he minimum bandwidth allocated to VPX1 and VPX2
are 4Gbps and 2Gbps respectively with a burstable bandwidth of 2Gbps and 1Gbps each. T he following table depicts the
parameters:
Priority P0
Priority P1
In the above case, let us assume that the total licensed bandwidth is 8 Gbps. Now, if both the VPX are bursting to their
maximum burstable limit, that is:
1. VPX1 is using its maximum burstable bandwidth, that is 2 Gpbs then it is using a total of 4 + 2 = 6 Gbps
2. VPX2 is using its maximum burstable bandwidth, that is 1 Gpbs then it is using a total of 2 + 1 = 3 Gbps
In this case the maximum bandwidth that is used is more than the licensed capacity of 8 Gbps. So to bring down the usage
to within the licensed capacity, one of the VPX would have to give up its burstable bandwidth. In this case since VPX2 has
lower priority than VPX1, so it gives up its 1 Gbps burstable bandwidth. VPX1 would continue to burst as it has higher priority
than VPX2. In all such scenarios, it is made sure that the minimum guaranteed bandwidth is always honored.
Updated: 2014-10-14
You can check individual VPXs throughput and data consumption statistics in graphs. T hese graphs are accessible from the
Conguration > NetScaler > Instances page. Select a VPX and then click on the Action drop list. From the list select either
T hrougput Statistics or Data Usage Statistics.
T he graphs provide you to check the data consumption and throughput statistics for various periods of time, like:
Last 1 hour
Last 1 day
Last 1 week
Last 1 month, and
You can also select a specic time period in the graph by adjusting the slider at the bottom of the graph. T he graph also
shows the data consumption or throughput data for a specic time by moving your mouse over the lines in the graph.
Note:
T o set up a cluster, you must understand NetScaler clustering. For more information, see Clustering.
For clusters that have NetScaler instances across SDX appliances, Citrix recommends that you use NetScaler instances
from three SDX appliances. T his ensures that the cluster criteria of a minimum of (n/2 +1) nodes is always satisfied.
You cannot create L3 clusters of SDX instances.
T he above figure shows three SDX appliances, SDX1, SDX2, and SDX3, on the same subnet. T he NetScaler instances on
these appliances are used to form two clusters: Cluster1 and Cluster2.
Cluster1 includes two instances on SDX1.
Cluster2 includes one instance on SDX1, two instances on SDX2, and another two instances on SDX3.
Points to remember
All nodes of a cluster must be of the same type. You cannot form a cluster of hardware and virtual appliances, nor a
cluster of VPX NetScaler instances and SDX NetScaler instances.
T he NetScaler instances must be of the same version, which must be version 10.1 or later.
T he NetScaler instances must all have the same feature license.
No configurations can be updated on individual NetScaler instances after they are added to the cluster. All changes
must be performed through the cluster IP address.
T he NetScaler instances must all have the same resources (memory, CPU, interfaces, and so on).
Cluster link aggregation is not supported on a cluster of SDX appliances.
Note: T o get an updated list of NetScaler clusters, each of which has at least one NetScaler instance of the SDX
appliance, use the Rediscover option.
To add a NetScaler instance that exists on one SDX appliance to a cluster congured on another SDX
appliance
1. Log on to the SDX appliance from which you want to add the NetScaler instance.
2. On the Configuration tab, navigate to NetScaler, and then click Clusters.
3. Click Add Node.
4. In the Add Node dialog box, configure the parameters required for adding a cluster node. For a description of a
parameter, hover the mouse cursor over the corresponding field.
Note: Make sure the values of the Cluster IP address and Cluster IP Password parameters are for the cluster to which
you want to add the node.
5. Click Next to view the configuration summary.
6. Click Finish to add the node to the cluster.
If a task that you need to perform is not described below, see the list of tasks at the left.
Warning
Make sure that you modify the provisioned network interfaces or VLANS of an instance using the Management Service instead of
performing the modications directly on the instance.
You can assign mapped IP address (MIP) and subnet IP address (SNIP) to the NetScaler instances after they are provisioned
on the SDX appliance.
A SNIP is used in connection management and server monitoring. It is not mandatory to specify a SNIP when you initially
congure the NetScaler appliance. You can assign SNIP to the NetScaler instance from the Management Service.
A MIP is used for server-side connections. A MIP can be considered a default Subnet IP (SNIP) address, because MIPs are
used when a SNIP is not available or use SNIP (USNIP) mode is disabled. You can create or delete a MIP during runtime
without restarting the NetScaler instance.
T he Management Service lets you perform the following operations on the NetScaler instances, both from the NetScaler
Instances pane in the Conguration tab and in the NetScaler Instances gadget on the Home page.
You can remove any NetScaler instance les, such as XVAs, builds, documentation, SSL keys or SSL certicates, from the
appliance.
At the time of provisioning a NetScaler VPX instance, the Management Service creates some policies, instance
administration (admin) profile, and other configuration on the VPX instance. If the Management Service fails to apply the
admin configuration at this time due to any reason (for example, the Management Service and the NetScaler VPX instance
For any SSL transaction, the server needs a valid certicate and the corresponding private and public key pair. T he certicate
le must be present on the SDX appliance when you install the SSL certicate on the NetScaler instances. You can also
download the SSL Certicate les to a local computer as a backup.
In the SSL Certicates pane, you can view the following details.
Name
T he name of the certificate file.
Last Modif ied
T he date when the certificate file was last modified.
Size
T he size of the certificate file in bytes.
For any SSL transaction, the server needs a valid certicate and the corresponding private and public key pair. T he key le
must be present on the SDX appliance when you install the SSL certicate on the NetScaler instances. You can also
download the SSL key les to a local computer as a backup.
In the SSL Keys pane, you can view the following details.
Name
T he name of the key file.
Last Modif ied
T he date when the key file was last modified.
Size
the size of the key file in bytes.
T he Management Service lets you install SSL certificates on one or more NetScaler instances. Before you begin installing
the SSL certificate, make sure that you have uploaded the SSL certificate and key files to the SDX appliance.
To install SSL certicates on a NetScaler instance
1. In the navigation pane, click NetScaler.
2. In the details pane, under NetScaler Configuration, click Install SSL Certificates.
3. In the Install SSL Certificates dialog box, specify values for the following parameters.
Certif icate File*
Specify the file name of the valid certificate. T he certificate file must be present on the SDX appliance.
Key File*
Specify the file name of the private-key used to create the certificate. T he key file must be present on the SDX
appliance.
Certif icate Name*
Specify the name of the certificate-key pair to be added to the NetScaler. Maximum length: 31
Certif icate Format*
Specify the format of the SSL certificate supported on the NetScaler. A NetScaler appliance supports the PEM and DER
formats for SSL certificates.
Password
Specify the pass-phrase that was used to encrypt the private-key. T his option can be used to load encrypted private-
keys. Max length: 32.
Note: Password protected private key is supported only for the PEM format.
Save Conf iguration*
Specify whether the configuration needs to be saved on the NetScaler. Default value is false.
Instance IP Address*
Specify the IP addresses of the NetScaler instances on which you want to install the SSL certificate.
You can update some parameters, such as the certificate file, key file, and certificate format of an SSL certificate that is
installed on a NetScaler instance. You cannot modify the IP address and certificate name.
If you add a new SSL certificate directly on a NetScaler instance after logging on to that instance, the Management
Service is not aware of this new certificate. T o avoid this, specify a polling interval after which the Management Service will
poll all the NetScaler instances to check for new SSL certificates. You can also perform a poll at any time from the
Management Service if, for example, you want to immediately get a list of all the SSL certificates from all the NetScaler
instances.
To congure a polling interval
1. In the navigation pane, expand NetScaler, and then click SSL Certificates.
2. In the SSL Certificates pane, click Configure Polling Interval.
3. In the Configure Polling Interval dialog box, set the following parameters:
Polling Interval* T he time after which the Management Service polls the NetScaler instances.
Interval Unit* T he unit of time. Possible values: Hours, Minutes. Default: Hours.
*A required parameter
If you have selected Tagged for an interface assigned to an instance, log on to that instance and congure a 802.1q
VLAN to receive packets on that interface.
2. For 1/x and 10/x interfaces that are shared by NetScaler instances on which L2 mode is allowed, make sure that the
following conditions are met:
VLAN filtering is enabled on all the interfaces.
Each interface is on a different 802.1q VLAN.
Only one instance can receive untagged packets on the interface. If that interface is assigned to other instances, you
must select T agged on that interface for those instances.
3. If you allow untagged packets for an instance on a 1/x interface, and L2 mode is allowed for that instance, no other
instance (with L2 mode allowed or disallowed) can receive untagged packets on that interface.
4. If you allow untagged packets for an instance on a 1/x interface, and L2 mode is not allowed for that instance, no
instance with L2 mode allowed can receive untagged packets on that interface.
5. If you have provisioned an instance (for example VPX1) in L2 mode on a 0/x interface, and the same interface is also
assigned to another instance (for example VPX2), select T agged for all other interfaces (1/x and 10/x) that are assigned
to the second instance (VPX2).
Note: If L2 mode is enabled on a NetScaler instance, and both of the management interfaces (0/1 and 0/2) are associated
with that instance, only one of the management interfaces can be associated with another NetScaler instance on which
L2 mode is enabled. You cannot associate both management interfaces with more than one NetScaler instance on which
L2 mode is enabled.
To allow L2 mode on an instance
1. In the Provision NetScaler Wizard or the Modify NetScaler Wizard, on the Network Settings page, select Allow L2 Mode.
Note: You can activate the Allow L2 Mode setting on an instance when you provision the instance, or while the instance
is running.
2. Follow the instructions in the wizard.
3. Click Finish, and then click Close.
In a high availability setup, the primary node owns all of the oating IP addresses, such as the MIP, SNIP, and VIP addresses.
T he primary node responds to Address Resolution Protocol (ARP) requests for these IP addresses with its own MAC
address. As a result, the ARP table of an external device (for example, an upstream router) is updated with the oating IP
address and the primary node's MAC address.
When a failover occurs, the secondary node takes over as the new primary node. It then uses Gratuitous ARP (GARP) to
advertise the oating IP addresses that it acquired from the primary. However, the MAC address that the new primary
advertises is the MAC address of its own interface.
Some devices (notably a few routers) do not accept the GARP messages generated by the NetScaler appliance. Such
devices retain the old IP to MAC mapping advertised by the old primary node, and a site can go down as a result.
You can overcome this problem by conguring a VMAC on both nodes of an HA pair. Both nodes then possess identical
MAC addresses. T herefore, when failover occurs, the MAC address of the secondary node remains unchanged, and the ARP
tables on the external devices do not need to be updated.
T o configure a VMAC, you add a VRID for an interface. T he Management Service internally generates a VMAC. You must
specify the same VRID when you configure active-active mode on the NetScaler instance.
Important:
1. You must add a VRID from the Management Service. T he same VRID must be specified in the NetScaler instance. If you
add a VRID directly in the NetScaler instance, the instance cannot receive a packet that has a VMAC address as the
destination MAC address.
2. You can use the same VRIDs in different instances on a 10G interface if VLAN filtering is enabled on the interface and
the instances associated with that interface belong to different tagged 802.1q VLANs.
3. You cannot use the same VRIDs in different instances on a 1G interface.
4. You can add or delete the VRIDs for an interface assigned to an instance while the Instance is running.
5. In an active-active configuration, you can specify more than one VRID for an interface assigned to an instance.
6. A maximum of 86 VMACs are allowed on a 10G interface, and a maximum of 16 VMACs on a 1G interface. If no more
VMAC filters are available, reduce the number of VRIDs on another instance.
You can add a VRID at the time of provisioning a NetScaler instance, or you can modify an existing NetScaler instance.
1. In the Provision NetScaler Wizard or the Modify NetScaler Wizard, on the Network Settings page, select an interface
and set one or both of the following values:
VRID IPv4 T he IPv4 VRID that identifies the VMAC. Possible values: 1 to 255.
VRID IPv6 T he IPv6 VRID that identifies the VMAC. Possible values: 1 to 255.
Note: Use a comma to separate multiple VRIDs. For example, 12,24.
2. Follow the instructions in the wizard.
3. Click Finish, and then click Close.
To partition a NetScaler instance on an SDX appliance, you need a virtual MAC (VMAC) address for each partition. T hese
VMAC addresses are called partition MAC addresses. T he Management Service enables you to generate partition MAC
addresses by:
Note
After generating the partition MAC addresses, you must restart the NetScaler instance before conguring the admin partitions.
1. On the Conf iguration tab, in the left pane, expand NetScaler, and then click Instances.
2. In the Instances pane, select the NetScaler instance for which you want to generate the partition MAC addresses.
3. In the Action drop-down list, click Partition MACs.
4. In the Partition MACs pane, click Generate.
5. In the Generate Partition MACs dialog box, in the Generation Method section, select Using Base Address.
6. In the Base MAC Address field, enter the base MAC address.
7. In the Increment By field, enter the value by which the base MAC address should be incremented for each subsequent
MAC address.
For example, if you have specified the base MAC address as 00:A1:C9:11:C8:11 and the increment value as 2, the next
MAC address is generated as 00:A1:C9:11:C8:13.
8. In the Count field, enter the number of partition MAC addresses you want to generate.
9. Click Generate.
To generate the partition MAC addresses by specif ying custom MAC addresses:
1. On the Conf iguration tab, in the left pane, expand NetScaler, and then click Instances.
2. In the Instances pane, select the NetScaler instance for which you want to generate the partition MAC addresses.
3. In the Action drop-down list, click Partition MACs.
4. In the Partition MACs pane, click Generate.
5. In the Generate Partition MACs dialog box, in the Generation Method section, select User Specif ied.
6. In the MAC Addresses field, enter a MAC address.
1. On the Conf iguration tab, in the left pane, expand NetScaler, and then click Instances.
2. In the Instances pane, select the NetScaler instance for which you want to generate the partition MAC addresses.
3. In the Action drop-down list, click Partition MACs.
4. In the Partition MACs pane, click Generate.
5. In the Generate Partition MACs dialog box, in the Generation Method section, select Random.
6. In the Count field, enter the number of partition MAC addresses you want to generate.
7. Click Generate.
After you have generated partition MAC addresses in SDX appliance, use the generated partition MAC addresses to
congure admin partitions on the NetScaler instance. For detailed instructions for partitioning the NetScaler instance, see
Partitioning a NetScaler.
T he Management Service user interface displays the list and description of all the NetScaler VPX instances provisioned on
the SDX appliance. Use the NetScaler Instances pane to view details, such as the instance name and IP address, CPU and
memory utilization, number of packets received and transmitted on the instance, the throughput and total memory
assigned to the instance.
Clicking the IP address of the NetScaler VPX instance opens the conguration utility (GUI) of that instance in a new tab or
browser.
1. On the Configuration tab, in the left pane, expand NetScaler Configuration, and then click Instances.
Note: You can also view the properties of a NetScaler VPX instance from the Home tab.
2. In the NetScaler Instance pane, you can view the following details for the NetScaler instance:
Name
T he host name assigned to the NetScaler instance while provisioning.
VM State
T he state of the virtual machine.
NetScaler State
T he state of the NetScaler instance.
IP Address
T he IP address of the NetScaler instance. Clicking the IP address opens the GUI of this instance in a new tab or browser.
Rx (Mbps)
T he packets received on the NetScaler instance.
Tx (Mbps)
T he packets transmitted by the NetScaler instance.
HTTP Req/s
T he total number of HT T P requests received on the NetScaler instance every second.
CPU Usage (%)
T he percentage of CPU utilization on the NetScaler.
Memory Usage (%)
T he percentage of memory utilization on the NetScaler.
3. Click the arrow next to the name of a NetScaler instance to view the properties of that instance, or click Expand All to
view the properties of all the NetScaler instances. You can view the following properties:
Netmask
T he netmask IP address of the NetScaler instance.
Gateway
By using the Management Service you can view the currently running configuration of a NetScaler instance. You can also
view the saved configuration of a NetScaler instance and the time when the configuration was saved.
To view the running and saved conguration of a NetScaler instance
1. On the Configuration tab, in the left pane, expand NetScaler Configuration, and then click Instances.
2. In the NetScaler Instances pane, click the NetScaler instance for which you want to view the running or saved
configuration.
3. T o view the running configuration, click Running Configuration, and to view the saved configuration, click Saved
Configuration.
You can ping a NetScaler instance from the Management Service to check whether the device is reachable.
To ping a NetScaler instance
1. On the Configuration tab, in the left pane, expand NetScaler Configuration, and then click Instances.
2. In the NetScaler Instances pane, click the NetScaler instance you want to ping, and then click Ping. In the Ping message
box, you can view whether the ping is successful.
You can trace the route of a packet from the Management Service to a NetScaler instance by determining the number of
hops used to reach the instance.
To trace the route of a NetScaler instance
1. On the Configuration tab, in the left pane, expand NetScaler Configuration, and then click Instances.
2. In the NetScaler Instances pane, click the NetScaler instance you want to trace, and then click T raceRoute. In the
T raceroute message box, you can view the route to the NetScaler.
You can rediscover a NetScaler instance when you need to view the latest state and conguration of a NetScaler instance.
During rediscovery, the Management Service fetches the conguration. By default, the Management Service schedules
devices for rediscovery once every 30 minutes.
All operations performed by using the Management Service are logged in the appliance database. Use audit logs to view the
operations that a Management Service user has performed, the date and time of each operation, and the success or failure
status of the operation. You can also sort the details by user, operation, audit time, status, and so on by clicking the
appropriate column heading.
Pagination is supported in the Audit Log pane. Select the number of records to display on a page. By default, 25 records are
displayed on a page.
3. T o sort the logs by a particular field, click the heading of the column.
Use task logs to view and track tasks, such as upgrading instances and installing SSL certificates, that are executed by the
Management Service on the NetScaler instances. T he task log lets you view whether a task is in progress or has failed or
has succeeded.
3.
1. In the navigation pane, expand Diagnostics, and then click T ask Log.
2. In the T ask Log pane, double-click the task to view the task device details.
3. In the T ask Device Log pane, to sort the logs by a particular field, click the heading of the column.
1. In the navigation pane, expand Diagnostics, and then click T ask Log.
2. In the T ask Log pane, double-click the task to view the task device details.
3. In the T ask Device Log pane, double-click the task to view the task command details.
4. In the T ask Command Log pane, to sort the logs by a particular field, click the heading of the column.
Viewing Events
Use the Events pane in the Management Service user interface to monitor the events generated by the Management
Service for tasks performed on the Management Service.
To view the events
3. T o sort the events by a particular field, click the heading of the column.
By design, the NetScaler SDX appliance is not subject to the same limitations. In the SDX architecture, each instance runs
as a separate virtual machine (VM) with its own dedicated NetScaler kernel, CPU resources, memory resources, address
space, and bandwidth allocation. Network I/O on the SDX appliance not only maintains aggregate system performance but
also enables complete segregation of each tenant's data-plane and management-plane trafc. T he management plane
includes the 0/x interfaces. T he data plane includes the 1/x and 10/x interfaces. A data plane can also be used as a
management plane.
T he primary use cases for an SDX appliance are related to consolidation, reducing the number of networks required while
maintaining management isolation. Following are the basic consolidation scenarios:
Consolidation when the Management Service and the NetScaler instances are in the same network
Consolidation when the Management Service and the NetScaler instances are in different networks but all the instances
are in the same network
Consolidation across security zones
Consolidation with dedicated interfaces for each instance
Consolidation with sharing of a physical port by more than one instance
Figure 1. Network topology of an SDX appliance with Management Service and NetScaler NSIPs for instances in the same
network
T he following table lists the names and values of the parameters used for provisioning NetScaler Instance 1 in the above
example.
Name vpx8
IP Address 10.1.1.2
Netmask 255.255.255.0
Password Sdx
#SSL Chips 1
CPU Shared
1. On the Configuration tab, in the navigation pane, expand NetScaler Configuration, and then click Instances.
2. In the NetScaler Instances pane, click Add.
3. In the Provision NetScaler Wizard follow the instructions in the wizard to specify the parameter values shown in the
above table.
4. Click Create, and then click Close. T he NetScaler instance you provisioned appears in the NetScaler Instances pane.
Figure 1. Network topology of an SDX appliance with Management Service and NetScaler NSIPs for Instances in different
networks
As the appliance administrator, you have the option to keep the trafc between the Management Service and the NSIP
addresses on the SDX appliance, or to force the trafc off the device if, for example, you want trafc to go through an
external rewall or some other security intermediary and then return to the appliance.
T he following table lists the names and values of the parameters used for provisioning NetScaler Instance 1 in this example.
Name vpx1
IP Address 10.1.2.2
Gateway 10.1.2.1
Password Sdx
#SSL Chips 1
CPU Shared
1. On the Configuration tab, in the navigation pane, expand NetScaler Configuration, and then click Instances.
2. In the NetScaler Instances pane, click Add.
3. In the Provision NetScaler Wizard follow the instructions in the wizard to set the parameters to the values shown in the
above table.
4. Click Create, and then click Close. T he NetScaler instance you provisioned appears in the NetScaler Instances pane.
In some cases, you might need separate management networks for each security zone. In such cases, you have to put the
NSIP addresses of the instances in the DMZ on one network, and put the NSIP addresses of the instances with VIPs in the
internal network on a different management network. Also, in many cases, communication between the Management
Service and the instances might need to be routed through an external device, such as a router. You can congure rewall
policies to control the trafc that is sent to the rewall and to log the trafc.
T he SDX appliance has two management interfaces (0/1 and 0/2) and, depending on the model, up to eight 1G data ports
and eight 10G data ports. You can also use the data ports as management ports (for example, when you need to congure
tagged VLANs, because tagging is not allowed on the management interfaces). If you do so, the trafc from the
Management Service must leave the appliance and then return to the appliance. You can route this trafc or, optionally,
specify an NSVLAN on an interface assigned to the instance. If the instances are congured on a management interface
that is common with the Management Service, the trafc between the Management Service and NetScaler instances does
not have to be routed, unless your setup explicitly requires it.
Figure 1. Network topology of an SDX appliance with NetScaler instances in multiple networks
T he SDX appliance is connected to a switch. Make sure that VLAN IDs 100 and 200 are congured on the switch port to
which port 1/1 on the appliance is connected.
T he following table lists the names and values of the parameters used for provisioning NetScaler instances 5 and 3 in this
example.
#SSL Chips 1 1
1. On the Configuration tab, in the navigation pane, expand NetScaler Configuration, and then click Instances.
2. In the NetScaler Instances pane, click Add.
3. In the Provision NetScaler Wizard follow the instructions in the wizard to set the parameters to the values shown in the
above table.
4. Click Create, and then click Close. T he NetScaler instance you provisioned appears in the NetScaler Instances pane.
Note: VLAN filtering is not a global setting on the appliance. You enable or disable VLAN filtering on an interface, and the
setting applies to all instances associated with that interface. If VLAN filtering is disabled, you can configure up to 4096
VLANs. If VLAN filtering is enabled, you can configure up to 63 tagged VLANs on a 10G interface and up to 32 tagged
VLANs on a 1G interface.
In the following example, the instances are part of multiple networks.
Interface 1/1 is assigned as a management interface to all the instances. Interface 0/1 is assigned to the Management
Service, which is part of the internal 10.1.1.x network.
NetScaler instances 2 and 3 are in the 10.1.200.x network, and instances 4, 5, 6, and 7 are in the 10.1.3.x network.
Instances 2 and 3 each have a dedicated physical interface. Instances 4 and 7 share physical interface 1/7, and instances
5 and 6 share physical interface 10/4.
VLAN filtering is enabled on interface 1/7. T raffic for Instance 4 is tagged for VLAN 4, and traffic for Instance 7 is
tagged for VLAN 7. As a result, traffic for Instance 4 is not visible to Instance 7, and vice versa. A maximum of 32 VLANs
can be configured on interface 1/7.
VLAN filtering is disabled on interface 10/4, so you can configure up to 4096 VLANs on that interface. Configure VLANs
500-599 on Instance 5 and VLANs 600-699 on Instance 6. Instance 5 can see the broadcast and multicast traffic from
VLAN 600-699, but the packets are dropped at the software level. Similarly, Instance 6 can see the broadcast and
multicast traffic from VLAN 500-599, but the packets are dropped at the software level.
Figure 1. Network topology of an SDX appliance with Management Service and NetScaler instances distributed across
networks
T he following table lists the names and values of the parameters used for provisioning NetScaler instances 7 and 4 in this
example.
#SSL Chips 1 1
1. On the Configuration tab, in the navigation pane, expand NetScaler Configuration, and then click Instances.
2. In the NetScaler Instances pane, click Add.
3. In the Provision NetScaler Wizard follow the instructions in the wizard to set the parameters to the values shown in the
above table.
4. Click Create, and then click Close. T he NetScaler instance you provisioned appears in the NetScaler Instances pane.
SECUREMAT RIX GSB provides a highly secure password system that eliminates the need to carry any token devices.
Websense Protector provides monitoring and blocking capabilities, preventing data loss and leaks of sensitive information.
BlueCat DNS/DHCP Server delivers DNS and DHCP for your network. PaloAlto VM-Series on Citrix NetScaler SDX enables
consolidation of advanced security and ADC capabilities on a single platform, for secure, reliable access to applications by
businesses, business units, and service-provider customers. T he combination of VM-Series on Citrix NetScaler SDX also
provides a complete, validated, security and ADC solution for Citrix XenApp and XenDesktop deployments.
You can provision, monitor, manage, and troubleshoot an instance from the Management Service. All the above third-party
instances use the SDXTools daemon to communicate with the Management Service. T he daemon is pre-installed on the
provisioned instance. You can upgrade the daemon when new versions become available.
When you congure third-party virtual machines, then SR-IOV interfaces (1/x and 10/x) that are part of a channel do not
appear in the list of interfaces because channels are not supported on third-party virtual machines.
Note: T he total number of instances that you can provision on an NetScaler SDX appliance depends on the license
installed on the appliance.
Important! You must upgrade your XenServer version to version 6.1.0 before you install any third-party instance.
Utilizing the NetScaler SDX multitenant platform architecture in a software dened network (SDN), SECUREMAT RIX's
strong authentication feature can be easily combined or integrated with other tenants or cloud services delivered through
the NetScaler, such as Web Interface, XenApp, XenDesktop, and many other application services that require
authentication.
Note: SR-IOV interfaces (1/x and 10/x) that are part of a channel do not appear in the list of interfaces because channels
are not supported on a SECUREMAT RIX GSB instance.
SECUREMAT RIX GSB requires a SECUREMAT RIX Authentication server that must be configured outside the SDX appliance.
Select exactly one interface and specify the network settings for only that interface.
Note: SR-IOV interfaces (1/x and 10/x) that are part of a channel do not appear in the list of interfaces because channels
are not supported on a SECUREMAT RIX GSB instance.
You must download an XVA image from the SECUREMAT RIX website and upload it to the SDX appliance before you start
provisioning the instance. For more information about downloading an XVA image, see the SECUREMAT RIX website. Make
sure that you are using Management Service build 118.7 or later on the NetScaler SDX appliance.
On the Conguration tab, navigate to SECUREMAT RIX GSB > Software Images.
After you provision the instance, log on to the instance and perform detailed conguration. For more information, see the
SECUREMAT RIX website.
To modify the values of the parameters of a provisioned SECUREMAT RIX instance, in the SECUREMAT RIX Instances pane,
select the instance that you want to modify, and then click Modify. In the Modify SECUREMAT RIX GSB wizard, modify the
Note: If you modify any of the interface parameters or the name of the instance, the instance stops and restarts to put
the changes into effect.
You can generate a tar archive for submission to technical support. For information about generating a technical support
le, see Generating a Tar Archive for Technical Support.
You can also back up the conguration of a SECUREMAT RIX GSB instance and later use the backup data to restore the
conguration of the instance on the SDX appliance. For information about backing up and restoring an instance, see
Backing Up and Restoring the Conguration Data of the SDX Appliance.
T he SDX appliance collects statistics, such as the version of SDXTools, the states of SSH and CRON daemons, and the
Webserver state, of a SECUREMAT RIX GSB instance.
You can start, stop, restart, force stop, or force restart a SECUREMAT RIX GSB instance from the Management Service.
SDXTools, a daemon running on the SECUREMAT RIX GSB instance, is used for communication between the Management
Service and the instance.
Upgrading SDXTools involves uploading the le to the SDX appliance, and then upgrading SDXTools after selecting an
instance. You can upload an SDXTools le from a client computer to the SDX appliance.
To upload an SDXTools le
1. In the navigation pane, expand Management Service, and then click SDXT ools Files.
2. In the details pane, from the Action list, select Upload.
3. In the Upload SDXT ools Files dialog box, click Browse, navigate to the folder that contains the file, and then double-click
To upgrade SDXTools
On the Conguration tab, expand SECUREMAT RIX GSB.
1. Click Instances.
2. In the details pane, select an instance.
3. From the Action list, select Upgrade SDXT ools.
4. In the Upgrade SDXT ools dialog box, select a file, click OK, and then click Close.
T he process of upgrading the SECUREMAT RIX GSB instance involves uploading the software image of the target build to
the SDX appliance, and then upgrading the instance. Downgrading loads an earlier version of the instance.
To downgrade an instance
1. Click Instances.
2. In the details pane, select an instance.
3. From the Action list, select Downgrade.
4. In the Confirm message box, click Yes.
You can ping a SECUREMAT RIX GSB instance from the Management Service to check whether the device is reachable. You
can trace the route of a packet from the Management Service to an instance to determine the number of hops involved in
reaching the instance.
You can rediscover an instance to view the latest state and conguration of an instance. During rediscovery, the
Management Service fetches the conguration and the version of the SECUREMAT RIX GSB running on the SDX appliance.
By default, the Management Service schedules instances for rediscovery once every 30 minutes.
To rediscover an instance
1. Click Instances.
2. In the details pane, select the instance that you want to rediscover, and from the Action list, click Rediscover.
3. In the Confirm message box, click Yes.
Before you can provision an InterScan Web Security instance, you must download an XVA image from the Trend Micro
website. After you have downloaded the XVA image, upload it to the NetScaler SDX appliance.
Note: SR-IOV interfaces (1/x and 10/x) that are part of a channel do not appear in the list of interfaces because channels
are not supported on a InterScan Web Security instance.
1. From the Configuration tab, navigate to T rendMicro IWSVA > Software Images.
2. In the details pane, under XVA Files tab , click Upload.
3. In the dialog box that appears, click Browse, and then select the XVA file that you want to upload.
4. Click Upload. T he XVA file appears in the XVA Files pane.
After you provision the instance, log on to the instance and perform the detailed conguration.
To modify the values of the parameters of a provisioned instance, in the details pane, select the instance that you want to
modify, and then click Edit. In the Modify TrendMicro IWSVA wizard, set the parameters to values suitable for your
environment.
To use the protector's data loss prevention (DLP) capabilities, you must purchase and install Websense Data Security,
congure Web DLP policies in the Data Security manager, and perform initial setup through the Management Service.
T he Websense Protector requires a Data Security Management Server that must be congured outside the SDX
appliance. Select exactly one management interface and two data interfaces. For the data interfaces, you must select
Allow L2 Mode. Make sure that the Data Security Management Server can be accessed through the management network
of the Websense protector. For the Name Server, type the IP address of the domain name server (DNS ) that will serve this
protector.
Note: SR-IOV interfaces (1/x and 10/x) that are part of a channel do not appear in the list of interfaces because channels
are not supported on a Websense protector instance.
You must download a protector image from the Websense website and upload it to the SDX appliance before you start
provisioning the instance. For more information about downloading a protector image, see the Websense website . Make
sure that you are using Management Service build 118.7 or later on the NetScaler SDX appliance.
After you provision the instance, log on to the instance and perform detailed conguration. For more information, see the
Websense website.
To modify the values of the parameters of a provisioned Websense protector instance, in the Websense Protector
Instances pane, select the instance that you want to modify, and then click Modify. In the Modify Websense Protector
wizard, set the parameters. Do not modify the interfaces that were selected at the time of provisioning a Websense
You can generate a tar archive for submission to technical support. For information about generating a technical support
le, see Generating a Tar Archive for Technical Support.
T he SDX appliance collects statistics, such as the version of SDXTools, the status of the Websense Data Security policy
engine, and the Data Security proxy status, of a Websense protector instance.
You can start, stop, restart, force stop, or force restart a Websense protector instance from the Management Service.
To start, stop, restart, force stop, or force restart a Websense protector instance
1. Click Instances.
2. In the details pane, select the instance on which you want to perform the operation, and then select one of the
following options:
Start
Shut Down
Reboot
Force Shutdown
Force Reboot
3. In the Confirm message box, click Yes.
SDXTools, a daemon running on the third-party instance, is used for communication between the Management Service and
the third-party instance.
Upgrading SDXTools involves uploading the le to the SDX appliance, and then upgrading SDXTools after selecting an
instance. You can upload an SDXTools le from a client computer to the SDX appliance.
To upload an SDXTools le
1. In the navigation pane, expand Management Service, and then click SDXT ools Files.
2. In the details pane, from the Action list, select Upload.
3. In the Upload SDXT ools Files dialog box, click Browse, navigate to the folder that contains the file, and then double-click
the file.
4. Click Upload.
To upgrade SDXTools
T he process of upgrading the Websense protector instance involves uploading the software image of the target build to
the SDX appliance, and then upgrading the instance.
You can ping a Websense protector instance from the Management Service to check whether the device is reachable.
You can trace the route of a packet from the Management Service to an instance to determine the number of hops
involved in reaching the instance.
You can rediscover an instance to view the latest state and conguration of an instance. During rediscovery, the
Management Service fetches the conguration and the version of the Websense protector running on the SDX appliance.
By default, the Management Service schedules instances for rediscovery once every 30 minutes.
To ping an instance
1. Click Instances.
2. In the details pane, select the instance that you want to ping, and from the Action list, click Ping. T he Ping message box
shows whether the ping is successful.
Virtual instances of BlueCat DNS/DHCP Server can be hosted on NetScaler SDX to provide a smarter way to connect
mobile devices, applications, virtual environments and clouds.
To learn more about BlueCat and Citrix, visit the BlueCat website at http://www.bluecatnetworks.com/solutions/citrix/.
To request a free trial version of BlueCat DNS/DHCP Server for Citrix Netscaler SDX, visit
http://pages.bluecatnetworks.com/free-trial.html.
If you are an existing BlueCat customer, you can download software and documentation via the BlueCat support portal at
https://care.bluecatnetworks.com/.
You must download an XVA image from the Bluecat Customer Care, at https://care.bluecatnetworks.com. After you have
downloaded the XVA image, upload it to the SDX appliance before you start provisioning the instance. Make sure that you
are using Management Service build 118.7 or later on the NetScaler SDX appliance.
Management channel across 0/1 and 0/2 interfaces are supported on BlueCat DNS/DHCP VMs. For more information see
Conguring channel from Management Service.
Note: SR-IOV interfaces (1/x and 10/x) that are part of a channel do not appear in the list of interfaces because channels
are not supported on a BlueCat DNS/DHCP instance.
Note: When assigning interfaces for management, high availability and service, make sure you assign the interfaces
based on supported combination of interfaces:
You can select the same interface for all three.
You can select a different interface for all three.
You can select the same interface for management and service, but select a different interface for high availability.
4. Click Finish, and then click Close. T he instance will be created, booted, and configured with the selected IP address.
After you provision the instance, log on to the instance through SSH to complete the conguration. For details on how to
congure the BlueCat DNS/DHCP Server or place it under the control of BlueCat Address Manager, see the appropriate
BlueCat Administration Guide, available at https://care.bluecatnetworks.com.
To modify the values of the parameters of a provisioned BlueCat DNS/DHCP Server instance, from the BlueCat DNS/DHCP
Instances pane, select the instance that you want to modify, and then click Modify. In the Modify BlueCat DNS/DHCP
wizard, modify the parameter settings.
Note: If you modify any of the interface parameters or the name of the instance, the instance stops and restarts to put
the changes into effect.
Monitoring a BlueCat DNS/DHCP Instance
T he SDX appliance collects statistics, such as the version of SDXTools running on the instance, of a BlueCat DNS/DHCP
instance.
You can start, stop, restart, force stop, or force restart a BlueCat DNS/DHCP instance from the Management Service.
To start, stop, restart, force stop, or force restart a BlueCat DNS/DHCP instance
1. Click Instances.
2. In the details pane, select the instance on which you want to perform the operation, and then select one of the
following options:
Start
Shut Down
Reboot
Force Shutdown
Force Reboot
3. In the Confirm message box, click Yes.
SDXTools, a daemon running on the third-party instance, is used for communication between the Management Service and
Upgrading SDXTools involves uploading the le to the SDX appliance, and then upgrading SDXTools after selecting an
instance. You can upload an SDXTools le from a client computer to the SDX appliance.
To upload an SDXTools le
1. In the navigation pane, expand Management Service, and then click SDXT ools Files.
2. In the details pane, from the Action list, select Upload.
3. In the Upload SDXT ools Files dialog box, click Browse, navigate to the folder that contains the file, and then double-click
the file.
4. Click Upload.
To upgrade SDXTools
On the Conguration tab, expand BlueCat DNS/DHCP.
1. Click Instances.
2. In the details pane, select an instance.
3. From the Action list, select Upgrade SDXT ools.
4. In the Upgrade SDXT ools dialog box, select a file, click OK, and then click Close.
You can rediscover an instance to view the latest state and conguration of an instance. During rediscovery, the
Management Service fetches the conguration. By default, the Management Service schedules instances for rediscovery
of all instances once every 30 minutes.
1. Click Instances.
2. In the details pane, select the instance that you want to rediscover, and from the Action list, click Rediscover.
3. In the Confirm message box, click Yes.
T he embedded web agent enables Single Sign-On (SSO) across an enterprise. CA Access Gateway provides access control
for HT T P and HT T PS requests and cookieless SSO. Also, the product stores session information in the in-memory session
store. Proxy rules dene how the CA Access Gateway forwards or redirects requests to resources located on destination
servers within the enterprise.
By providing a single gateway for network resources, CA Access Gateway separates the corporate network and centralizes
access control.
Note: SR-IOV interfaces (1/x and 10/x) that are part of a channel do not appear in the list of interfaces because channels
are not supported on a CA Access Gateway instance. For more information about the features of CA Access Gateway, see
the product documentation on Wiki
Updated: 2014-11-04
Before you can provision a CA Access Gateway instance, you must download an XVA image. After you have downloaded
the XVA image, upload it to the NetScaler SDX appliance. Make sure you are using Management Service version 10.5 build
52.3.e or later on the NetScaler SDX appliance. To provision a CA Access Gateway, rst you need to upload the XVA image
to the SDX appliance and then provision an instance.
1. On the Conf iguration tab, navigate to CA Access Gateway > Sof tware Images.
2. In the details pane, under XVA Files, from the Action drop-down list, click Upload.
3. In the dialog box that appears, click Browse, and then select the XVA file that you want to upload.
4. Click Upload. T he XVA file appears in the XVA Files pane.
After you provision the instance, log on to the instance and perform the detailed conguration.
To modify the values of the parameters of a provisioned instance, in the details pane, select the instance that you want to
modify, and then click Modif y. In the Modify CA Access Gateway wizard, set the parameters to values suitable for your
environment.
Note: If you modify any of the interface parameters or the name of the instance, the instance stops and restarts to put
the change into effect.
Updated: 2014-11-04
T he SDX appliance collects statistics, such as the version of SDXTools running on the instance, of a CA Access Gateway
instance.
Updated: 2014-11-04
You can start, stop, restart, force stop, or force restart a CA Access Gateway instance from the Management Service.
Note: T he total number of instances that you can provision on an SDX appliance depends on the NetScaler SDX hardware
resources available .
Important: You must upgrade your XenServer version to version 6.1.0 and install the xs-netscaler-6.1.0-2.6.32.43 -
0.4.1.xs1.6.10.777.170770-100012 supplemental pack.
Note: SR-IOV interfaces (1/x and 10/x) that are part of a channel do not appear in the list of interfaces because channels
are not supported on a Websense protector instance. For more information about Palo Alto Network VM-Series, see Palo
Alto Network Documentation.
Before you can provision a Palo Alto VM-Series instance, you must download an XVA image from the Palo Alto Networks
website, https://support.paloaltonetworks.com/Updates/SoftwareUpdates/. After you have downloaded the XVA image,
upload it to the NetScaler SDX appliance. Make sure you are using Management Service version 10.1 build 120.130403.e or
later on the NetScaler SDX appliance.
1. On the Conf iguration tab, navigate to PaloAlto VM-Series > Sof tware Images.
2. In the details pane, under XVA Files, from the Action drop-down list, click Upload.
3. In the dialog box that appears, click Browse, and then select the XVA file that you want to upload.
4. Click Upload. T he XVA file appears in the XVA Files pane.
After you provision the instance, log on to the instance and perform the detailed conguration.
To modify the values of the parameters of a provisioned instance, in the details pane, select the instance that you want to
modify, and then click Modif y. In the Modify PaloAlto VM-Series wizard, set the parameters to values suitable for your
environment.
Note: If you modify any of the interface parameters or the name of the instance, the instance stops and restarts to put
the change into effect.
T he SDX appliance collects statistics, such as the version of SDXTools running on the instance, of a Palo Alto VM-Series
instance.
You can start, stop, restart, force stop, or force restart a PaloAlto VM-Series instance from the Management Service.
You can ping a PaloAlto VM-Series instance from the Management Service to check whether the device is reachable. You
can trace the route of a packet from the Management Service to an instance to determine the number of hops involved in
reaching the instance.
You can rediscover an instance to view the latest state and conguration of an instance. During rediscovery, the
Management Service fetches the conguration and the version of the PaloAlto VM-Series running on the SDX appliance.
By default, the Management Service schedules instances for rediscovery once every 30 minutes.
To Ping an instance
1. Click Instances.
2. In the details pane, select the instance that you want to ping, and from the Action list, click Ping. T he Pingmessage box
shows whether the ping is successful.
2. In the details pane, select the instance that you want to ping, and from the Action list, click TraceRoute. T he
Traceroute message box displays the route to the instance.
To rediscover an instance
1. Click Instances.
NIT RO exposes its functionality through Representational State Transfer (REST ) interfaces. T herefore, NIT RO applications
can be developed in any programming language. Additionally, for applications that must be developed in Java or .NET or
Python, the NIT RO protocol is exposed as relevant libraries that are packaged as separate Software Development Kits
(SDKs).
Note: You must have a basic understanding of the NetScaler SDX appliance before using NIT RO.
To use the NIT RO protocol, the client application needs the following:
To use REST interfaces, you must have a system to generate HT T P or HT T PS requests (payload in JSON format) to the
NetScaler SDX appliance. You can use any programming language or tool.
For Java clients, you must have a system where Java Development Kit (JDK) 1.5 or above version is available. T he JDK can
be downloaded from http://www.oracle.com/technetwork/java/javase/downloads/index.html.
For .NET clients, you must have a system where .NET framework 3.5 or above version is available. T he .NET framework
can be downloaded from http://www.microsoft.com/downloads/en/default.aspx.
For Python clients, you must have a system where Python 2.7 or above version and the Requests library (available in
<NIT RO_SDK_HOME>/lib) is installed.
T he folder contains the NIT RO libraries in the lib subfolder. T he libraries must be added to the client application classpath
to access NIT RO functionality. T he <NIT RO_SDK_HOME> folder also provides samples and documentation that can help
you understand the NIT RO SDK.
Note:
T he REST package contains only documentation for using the REST interfaces.
For the Python SDK, the library must be installed on the client path. For installation instructions, read the
<NIT RO_SDK_HOME>/README.txt le.
1. T he client application sends REST request message to the NIT RO web service. When using the SDKs, an API call is
translated into the appropriate REST request message.
2. T he web service processes the REST request message.
3. T he NIT RO web service returns the corresponding REST response message to the client application. When using the
SDKs, the REST response message is translated into the appropriate response for the API call.
To minimize trafc on the network, you retrieve the whole state of a resource from the server, make modications to the
state of the resource locally, and then upload it back to the server in one network transaction.
Note: Local operations on a resource (changing its properties) do not affect its state on the server until the state of the
object is explicitly uploaded.
NIT RO APIs are synchronous in nature. T his means that the client application waits for a response from the NIT RO web
service before executing another NIT RO API.
T he rst step towards using NIT RO is to establish a session with the NetScaler SDX appliance and then authenticate the
session by using the administrator's credentials.
You must create an object of the nitro_service class by specifying the IP address of the appliance and the protocol to
connect to the appliance (HT T P or HT T PS). You then use this object and log on to the appliance by specifying the user
name and the password of the administrator.
Note: You must have a user account on that appliance. T he configuration operations that you can perform are limited by
the administrative role assigned to your account.
T he following sample code connects to a NetScaler SDX appliance with IP address 10.102.31.16 by using HT T PS protocol:
nitroservice.logout();
T he NIT RO protocol can be used to congure resources of the NetScaler SDX appliance.
T he APIs to congure a resource are grouped into packages or namespaces that have the format
com.citrix.sdx.nitro.resource.cong.<resource_type>. Each of these packages or namespaces contain a class
named <resource_type> that provides the APIs to congure the resource.
For example, the NetScaler resource has the com.citrix.sdx.nitro.resource.cong.ns package or namespace.
A resource class provides APIs to perform other operations such as creating a resource, retrieving resource details and
statistics, updating a resource, deleting resources, and performing bulk operations on resources.
To create a new resource (for example, a NetScaler instance) on the NetScaler SDX appliance, do the following:
1. Set the value for the required properties of the resource by using the corresponding property name. T he result is a
resource object that contains the details required for the resource.
Note: T hese values are set locally on the client. T he values are not reflected on the appliance till the object is uploaded.
2. Upload the resource object to the appliance, using the static add() method.
T he following sample code creates a NetScaler instance named "ns_instance" on the NetScaler SDX appliance:
int number_of_interfaces = 2;
network_interface[] interface_array = new network_interface[number_of_interfaces];
//Adding 10/1
interface_array[0] = new network_interface();
interface_array[0].set_port_name(" 10/1" );
//Adding 10/2
interface_array[1] = new network_interface();
interface_array[1].set_port_name(" 10/2" );
newns.set_network_interfaces(interface_array);
To retrieve the properties of a resource on the NetScaler SDX appliance, do the following:
1. Retrieve the configurations from the appliance by using the get() method. T he result is a resource object.
2. Extract the required property from the object by using the corresponding property name.
A NetScaler SDX appliance collects statistics on the usage of its features. You can retrieve these statistics using NIT RO.
T he following sample code updates the name of the NetScaler instance with ID 123456a to 'ns_instance_new':
To delete an existing resource, invoke the static method delete() on the resource class, by passing the ID of the resource to
be removed, as an argument.
You can query or change multiple resources simultaneously and thus minimize network trafc. For example, you can add
multiple NetScaler appliances in the same operation.
Each resource class has methods that take an array of resources for adding, updating, and removing resources. To perform
a bulk operation, specify the details of each operation locally and then send the details at one time to the server.
Note: You must configure the required behavior while establishing a connection with the appliance, by setting the onerror
param in the nitro_service() method.
T he following sample code adds two NetScalers in one operation:
T he error message eld provides a brief explanation and the nature of the failure.
All exceptions in the execution of NIT RO APIs are caught by the com.citrix.sdx.nitro.exception.nitro_exception
class. To get information about the exception, you can use the getErrorCode() method.
For a more detailed description of the error codes, see the API reference available in the <NIT RO_SDK_HOME>/doc folder.
T he rst step towards using NIT RO is to establish a session with the NetScaler SDX appliance and then authenticate the
session by using the administrator's credentials.
You must create an object of the nitro_service class by specifying the IP address of the appliance and the protocol to
connect to the appliance (HT T P or HT T PS). You then use this object and log on to the appliance by specifying the user
name and the password of the administrator.
Note: You must have a user account on that appliance. T he configuration operations that you can perform are limited by
the administrative role assigned to your account.
T he following sample code connects to a NetScaler SDX appliance with IP address 10.102.31.16 by using HT T PS protocol:
nitroservice.logout();
T he NIT RO protocol can be used to congure resources of the NetScaler SDX appliance.
T he APIs to congure a resource are grouped into packages or namespaces that have the format
com.citrix.sdx.nitro.resource.cong.<resource_type>. Each of these packages or namespaces contain a class
named <resource_type> that provides the APIs to congure the resource.
For example, the NetScaler resource has the com.citrix.sdx.nitro.resource.cong.ns package or namespace.
A resource class provides APIs to perform other operations such as creating a resource, retrieving resources and resource
properties, updating a resource, deleting resources, and performing bulk operations on resources.
To create a new resource (for example, a NetScaler instance) on the NetScaler SDX appliance:
1. Set the value for the required properties of the resource by using the corresponding property name. T he result is a
resource object that contains the details required for the resource.
Note: T hese values are set locally on the client. T he values are not reflected on the appliance till the object is uploaded.
2. Upload the resource object to the appliance, using the static add() method.
T he following sample code creates a NetScaler instance named "ns_instance" on the NetScaler SDX appliance:
int number_of_interfaces = 2;
network_interface[] interface_array = new network_interface[number_of_interfaces];
//Adding 10/1
interface_array[0] = new network_interface();
interface_array[0].port_name = " 10/1" ;
//Adding 10/2
interface_array[1] = new network_interface();
interface_array[1].port_name = " 10/2" ;
newns.network_interfaces = interface_array;
To retrieve the properties of a resource on the NetScaler SDX appliance, do the following:
1. Retrieve the configurations from the appliance by using the get() method. T he result is a resource object.
2. Extract the required property from the object by using the corresponding property name.
A NetScaler SDX appliance collects statistics on the usage of its features. You can retrieve these statistics using NIT RO.
T he following sample code updates the name of the NetScaler instance with ID 123456a to 'ns_instance_new':
To delete an existing resource, invoke the static method delete() on the resource class, by passing the ID of the resource to
be removed, as an argument.
You can query or change multiple resources simultaneously and thus minimize network trafc. For example, you can add
multiple NetScaler appliances in the same operation.
Each resource class has methods that take an array of resources for adding, updating, and removing resources. To perform
a bulk operation, specify the details of each operation locally and then send the details at one time to the server.
Note: You must configure the required behavior while establishing a connection with the appliance, by setting the onerror
param in the nitro_service() method.
T he following sample code adds two NetScalers in one operation:
T he error message eld provides a brief explanation and the nature of the failure.
All exceptions in the execution of NIT RO APIs are caught by the com.citrix.sdx.nitro.exception.nitro_exception
class. To get information about the exception, you can use the getErrorCode() method.
For a more detailed description of the error codes, see the API reference available in the <NIT RO_SDK_HOME>/doc folder.
Each resource also has a state on which the following operations can be performed:
Creat e. Clients can create new server-side resources on a "container" resource. You can think of container resources as
folders, and child resources as files or subfolders. T he calling client provides the state for the resource to be created. T he
state can be specified in the request by using XML or JSON format. T he client can also specify the unique URL that will
identify the new object. Alternatively, the server can choose and return a unique URL identifying the created object. T he
HT T P method used for create requests is POST .
Read. Clients can retrieve the state of a resource by specifying its URL with the HT T P GET method. T he response
message contains the resource state, expressed in JSON format.
Updat e. You can update the state of an existing resource by specifying the URL that identifies that object and its new
state in JSON or XML, using the PUT HT T P method.
Delet e. You can destroy a resource that exists on the server-side by using the DELET E HT T P method and the URL
identifying the resource to be removed.
In addition to these four CRUD operations (Create, Read, Update, and Delete), resources can support other operations or
actions. T hese operations use the HT T P POST method, with the request body in JSON specifying the operation to be
performed and parameters for that operation.
NetScaler SDX NIT RO APIs are categorized depending on the scope and purpose of the APIs into system APIs and
conguration APIs.
Updated: 2014-06-11
T he rst step towards using NIT RO is to establish a session with the NetScaler SDX appliance and then authenticate the
session by using the administrator's credentials.
You must specify the username and password in the login object. T he session ID that is created must be specied in the
request header of all further operations in the session.
Note: You must have a user account on that appliance. T he configurations that you can perform are limited by the
administrative role assigned to your account.
To connect to a NetScaler SDX appliance with IP address 10.102.31.16 by using the HT T PS protocol:
URL. https://10.102.31.16/nitro/v2/config/login/
HT T P Met hod. POST
Request .
Header
Content-Type:application/vnd.com.citrix.sdx.login+json
Note: Content types such as 'application/x-www-form-urlencoded' that were supported in earlier versions of NIT RO
can also be used. You must make sure that the payload is the same as used in earlier versions. T he payloads provided in
Note: You must use the session ID in all further NIT RO operations on the appliance.
Note: By default, the connection to the appliance expires after 30 minutes of inactivity. You can modify the timeout period
by specifying a new timeout period (in seconds) in the login object. For example, to modify the timeout period to 60
minutes, the request payload is:
{
" login" :
{
" username" :" nsroot" ,
" password" :" verysecret" ,
" timeout" :3600
}
}
You can also connect to the appliance to perform a single operation, by specifying the username and password in the
request header of the operation. For example, to connect to an appliance while creating a NetScaler instance:
URL. https://10.102.31.16/nitro/v2/config/ns/
HT T P Met hod. POST
Request .
Header
X-NITRO-USER:nsroot
X-NITRO-PASS:verysecret
Content-Type:application/vnd.com.citrix.sdx.ns+json
P ayload
{
" ns" :
{
...
}
}
Response.
Header
HTTP/1.0 201 Created
Updated: 2014-06-11
T he NIT RO protocol can be used to congure resources of the NetScaler SDX appliance.
Each NetScaler SDX resource has an unique URL associated with it, depending on the type of operation to be performed.
URLs for conguration operations have the format http://<IP>/nitro/v2/cong/<resource_type>.
To create a new resource (for example, a NetScaler instance) on the NetScaler SDX appliance, specify the resource name
and other related arguments in the specic resource object. For example, to create a NetScaler instance named vpx1:
URL. https://10.102.31.16/nitro/v2/config/ns/
HT T P Met hod. POST
Request .
Header
Cookie:NITRO_AUTH_TOKEN=tokenvalue
Content-Type:application/vnd.com.citrix.sdx.ns+json
P ayload
{
" ns" :
{
" name" :" vpx1" ,
" ip_address" :" 192.168.100.2" ,
" netmask" :" 255.255.255.0" ,
" gateway" :" 192.168.100.1" ,
" image_name" :" nsvpx-9.3-45_nc.xva" ,
" vm_memory_total" :2048,
" throughput" :1000,
" pps" :1000000,
" license" :" Standard" ,
" profile_name" :" ns_nsroot_profile" ,
" username" :" admin" ,
" password" :" admin" ,
" network_interfaces" :
[
{
" port_name" :" 10/1"
},
{
T o retrieve details of a specific resource on the NetScaler SDX appliance, specify the id of the resource in the URL.
T o retrieve the properties of resources on the basis of some filter, specify the filter conditions in the URL.
T he URL has the form: http://<IP>/nitro/v2/cong/<resource_type>?lter=<property1>:<value>,
<property2>:<value>.
If your request is likely to result in a large number of resources returned from the appliance, you can retrieve these results
in chunks by dividing them into "pages" and retrieving them page by page.
For example, assume that you want to retrieve all NetScaler instances on a NetScaler SDX that has 53 of them. Instead
of retrieving all 53 in one big response, you can congure the results to be divided into pages of 10 NetScaler instances
each (6 pages total), and retrieve them from the server page by page.
You specify the page count with the pagesize query string parameter and use the pageno query string parameter to
specify the page number that you want to retrieve.
You do not have to retrieve all the pages, or retrieve the pages in order. Each request is independent, and you can even
change the pagesize setting between requests.
Note: If you want to have an idea of the number of resources that are likely to be returned by a request, you can use
the count query string parameter to ask for a count of the resources to be returned, rather than the resources
themselves. T o get the number of NetScaler instances available, the URL would be
http://<IP>/nitro/v2/config/<resource_type>?count=yes.
To retrieve the conguration information for the NetScaler instance with ID 123456a:
URL. http://10.102.31.16/nitro/v2/config/ns/123456a
HT T P Met hod. GET
To update an existing NetScaler SDX resource, use the PUT HT T P method. In the HT T P request payload, specify the name
and the other arguments that have to be changed. For example, to change the name of NetScaler instance with ID
123456a to vpx2:
URL. https://10.102.31.16/nitro/v2/config/ns/
HT T P Met hod. PUT
Request P ayload.
Header
Cookie:NITRO_AUTH_TOKEN=tokenvalue
Content-Type:application/vnd.com.citrix.sdx.ns+json
To delete an existing resource, specify the name of the resource to be deleted in the URL. For example, to delete a
NetScaler instance with ID 123456a:
URL. http://10.102.31.16/nitro/v2/config/ns/123456a
HT T P Met hod. DELET E
Request .
Header
Cookie:NITRO_AUTH_TOKEN=tokenvalue
Content-Type:application/vnd.com.citrix.sdx.ns+json
You can query or change multiple resources simultaneously and thus minimize network trafc. For example, you can add
multiple NetScaler appliances in the same operation. You can also add resources of different types in one request.
T o account for the failure of some operations within the bulk operation, NIT RO allows you to configure one of the
following behaviors:
Exit . When the first error is encountered, the execution stops. T he commands that were executed before the error are
committed.
Cont inue. All the commands in the list are executed even if some commands fail.
Note: You must configure the required behavior in the request header using the X-NIT RO-ONERROR parameter.
T o add 2 NetScaler resources in one operation and continue if one command fails:
URL. http://10.102.29.60/nitro/v2/config/ns/
HT T P Met hod. POST
Request P ayload.
Header
Cookie:NITRO_AUTH_TOKEN=tokenvalue
Content-Type:application/vnd.com.citrix.sdx.ns+json
X-NITRO-ONERROR:continue
P ayload
{
" ns" :
[
{
" name" :" ns_instance1" ,
" ip_address" :" 10.70.136.5" ,
" netmask" :" 255.255.255.0" ,
T o add multiple resources (two NetScalers and two MPS users) in one operation and continue if one command fails:
URL. https://10.102.29.60/nitro/v2/config/ns/
HT T P Met hod. POST
Request P ayload.
Header
Cookie:NITRO_AUTH_TOKEN=tokenvalue
Content-Type:application/vnd.com.citrix.sdx.ns+json
X-NITRO-ONERROR:continue
P ayload
{
" ns" :
[
{
" name" :" ns_instance1" ,
" ip_address" :" 10.70.136.5" ,
" netmask" :" 255.255.255.0" ,
" gateway" :" 10.70.136.1"
},
{
" name" :" ns_instance2" ,
" ip_address" :" 10.70.136.8" ,
" netmask" :" 255.255.255.0" ,
" gateway" :" 10.70.136.1"
}
],
" mpsuser" :
[
{
" name" :" admin" ,
" password" :" admin" ,
" permission" :" superuser"
},
{
" name" :" admin" ,
" password" :" admin" ,
" permission" :" superuser"
Updated: 2014-06-11
T he error message eld provides a brief explanation and the nature of the failure.
You can convert the NetScaler MPX 11515/11520/11530/11540/11542 appliances to NetScaler SDX
11515/11520/11530/11540/11542 appliances by upgrading the software through a new Solid State Drive (SSD) and a new
Hard Disk Drive (HDD).
T he Citrix NetScaler models SDX 11515/11520/11530/11540/11542 are 2U appliances. Each model has two 6-core
processors for a total of 12 physical cores (24 cores with hyper-threading), and 48 gigabytes (GB) of memory.
You can convert the NetScaler MPX 8005/8010/8015/8200/8400/8600/8800 appliances to NetScaler SDX
8010/8015/8400/8600 appliances by upgrading the software through a new Solid State Drive (SSD).
T he Citrix NetScaler models SDX 8010/8015/8400/8600 are 1U appliances. Each model has one quad-core processor (8
cores with hyper-threading) and 32 gigabytes (GB) of memory. T he SDX 8010/8015/8400/8600 appliances are available in
two port configurations:
Six 10/100/1000Base-T copper Ethernet ports and six 1G SFP ports (6x10/100/1000Base-T copper Ethernet ports + 6x1G
SFP)
Six 10/100/1000Base-T copper Ethernet ports and two 10G SFP+ ports(6x10/100/1000Base-T copper Ethernet ports +
2x10G SFP+)
Note: Citrix recommends that you configure the Lights Out Management (LOM) Port of the NetScaler appliance before
starting the conversion process. For more information on the LOM port of the NetScaler appliance, see Lights Out
Management Port of the NetScaler Appliance.
T o convert a NetScaler MPX appliance to a NetScaler SDX appliance, you must access the appliance through a console
cable attached to a computer or terminal. Before connecting the console cable, configure the computer or terminal to
support the following configuration:
VT 100 terminal emulation
9600 baud
8 data bits
1 stop bit
Parity and flow control set to NONE
Connect one end of the console cable to the RS232 serial port on the appliance, and the other end to the computer or
terminal.
Note: T o use a cable with an RJ-45 converter, insert the optional converter into the console port and attach the cable to it.
With the cable attached, verify that the MPX appliances components are functioning correctly. You are then ready to
begin the conversion. T he conversion process modies the Basic Input-Output System (BIOS), installs XenServer hypervisor
and a Service Virtual Machine image, and copies the NetScaler VPX image to the Hard Disk Drive.
After the conversion process, you make a few modications to the appliances conguration and apply a new license. You
can then provision the VPX instances through the Management Service on what is now a NetScaler SDX appliance.
T he following gure shows the front panel of the MPX 11515/11520/11530/11540/11542 appliance.
Example
/var/tmp/support/collector_10.10.10.10_P_13May2011_12_01
Copying selected configuration files from nsconfig ....
Note: T he output of the command is available in the /var/tmp/support/collector_<IP_address>_P_<date>.tar.gz file.
Copy this file to another computer for future reference. T he output of the command might be helpful in the event that
you want to contact Citrix T echnical Support.
8. At the NetScaler command line interface, switch to the shell prompt. T ype: shell
9. Run the following command to verify that 2 Cavium cards are available: root @ ns# dmesg | grep cavium
Example
Example
root@ns# df -h
Filesystem Size Used Avail Capacity Mounted on
/dev/md0c 276M 246M 24M 91% /
devfs 1.0K 1.0K 0B 100% /dev
procfs 4.0K 4.0K 0B 100% /proc
/dev/ad4s1a 62G 149M 57G 0% /flash
/dev/ad8s1e 728G 299M 669G 0% /var
root@ns#
12. Run the following command to execute the ns_hw_err.bash script, which checks for latent hardware errors: root @ ns#
/net scaler/ns_hw_err.bash
Example
root@ns# /netscaler/ns_hw_err.bash
NetScaler NS10.1: Build 127.11.nc, Date: Aug 11 2014, 18:24:36
platform: serial 2NSHJ2DR9E
platform: sysid 1400210 - NSMPX-11500 12*CPU+8*IX+4*E1K+2*E1K+2*CVM N3
HDD MODEL: Device Model: ST1000NM0033-9ZM173
13. Import ant : Physically disconnect all ports except the LOM port, including the management port, from the network.
14. At the shell prompt, switch to the NetScaler command line. T ype: exit
15. Run the following command to shut down the appliance: shut down -p now
Example
1. Locate the solid-state drive on the back panel of the appliance, as shown in the following figure:
When the conversion is successful, the LCD indicates Citrix NSSDX - 11515, as shown in the following gure.
3. Select the System node and, under Set Up Appliance, click Network Configuration to modify the IP address of the
Management Service.
4. In the Configure Network Configuration dialog box, specify the following details:
Interface* T he interface through which clients connect to the Management Service. Possible values: 0/1, 0/2.
Default: 0/1.
XenServer IP Address* T he IP address of XenServer hypervisor.
Management Service IP Address* T he IP address of the Management Service.
Netmask* T he subnet mask for the subnet in which the SDX appliance is located.
Gateway* T he default gateway for the network.
DNS Server T he IP address of the DNS server.
*A mandatory parameter
5. Click OK.
6. Connect the NetScaler SDX appliance to a switch to access it through the network. Browse to the IP address used
above and log on with the default credentials.
7. Apply the new licenses. For instructions, see NetScaler SDX Licensing Overview.
8. Navigate to Configuration > System and, in the System Administration group, click Reboot Appliance. Click Yes to
Before connecting the console cable, configure the computer or terminal to support the following configuration:
1. VT 100 terminal emulation
2. 9600 baud
3. 8 data bits
4. 1 stop bit
5. Parity and flow control set to NONE
1. Connect one end of the console cable to the RS232 serial port on the appliance and the other end to the computer or
terminal.
Note: T o use a cable with an RJ45 converter, insert the optional converter into the console port and attach the cable to
it.
2. On the NetScaler MPX appliance, verify that the solid state drive, power supplies, CPU, SSL cores, and interfaces are
operational.
3. Access the console port and enter the administrator credentials.
4. Run the following command from the NetScaler command line interface to display the serial number and confirm the
SYSID of the appliance: > show hardware
5. Run the following command to display the status of the active interfaces: > show interface
6. In the show interface commands output, verify that all of the interfaces are enabled and the status of every interface
is shown as UP/UP.
Note: If you have only a limited number of SFP+ transceivers, verify the interfaces in stages. After checking the first set
of interfaces, unplug the SFP+ transceivers and plug them in to the next set of ports. T he SFP+ transceivers are not hot-
swappable. T herefore, restart the MPX appliance after you connect the transceivers.
7. Run the following commands for each of the interfaces:
> enable interface 1/x
8. For any interface that you do not want to use after conversion, run the following commands:
> disable interface 1/x
9. Run the following command to verify that the status of the power supplies is normal: > stat system detail
10. Run the following command: > show techsupport
Note: T he output of the command is available in the /var/tmp/support/collector_<IP_address>_P_<date>.tar.gz file.
Copy this file to another computer for future reference. It might be helpful if you want to contact a Citrix technical
support engineer.
11. At the NetScaler command line interface, switch to the shell prompt. T ype: shell
12. Run the following command to verify that 4 Cavium cores are available: root @ ns# dmesg | grep cavium
13. Run the following command to verify that 132 MB of RAM is reserved for shared memory: root @ ns# dmesg | grep
memory
14. Run the following command to verify that the appliance has 4 CPU cores: root @ ns# dmesg | grep cpu
15. Run the following command to verify that the /var drive is mounted as /dev/ad4s1e: root @ ns# df h
16. Enter the following command to run the ns_hw_err.bash script. T his script checks for latent hardware errors. root @ ns#
/net scaler/ns_hw_err.bash
17. At the shell prompt, switch to the NetScaler command line interface. T ype: exit
18. Run the following command to shut down the appliance: shutdown -p now
19. Locate the solid-state drive on the back panel of the appliance, as shown in the following figure:
20. Verify that the replacement solid-state drive is the one required for your NetScaler model. T he Citrix label is on the top
of the solid-state drive, which is pre-populated with a new version of BIOS and a recent build of the required Service VM
software.
21. Remove the currently installed SSD drive by pushing the safety latch of the drive cover to the right and removing the
drive handle and the existing drive.
22. Open the drive handle on the new drive completely to the left, and insert the drive into the slot. T he following figure
shows the drive partially inserted. Push the drive all the way into the slot.
Note: Citrix recommends that you congure the Lights Out Management (LOM) Port of the NetScaler appliance before
starting the conversion process. For more information on the LOM port of the NetScaler appliance, see Lights Out
Management Port of the NetScaler Appliance.
To convert a NetScaler MPX appliance to a NetScaler SDX appliance, you must access the appliance through a console
cable attached to a computer or terminal. Before connecting the console cable, congure the computer or terminal to
support the following conguration:
Connect one end of the console cable to the RS232 serial port on the appliance, and the other end to the computer or
terminal.
Note: To use a cable with an RJ-45 converter, insert the optional converter into the console port and attach the cable to it.
Citrix recommends you to connect a VGA monitor to the appliance to monitor the conversion process, because the LOM
connection is be lost during the conversion process.
With the cable attached, verify that the MPX appliances components are functioning correctly. You are then ready to
begin the conversion. T he conversion process modies the Basic Input-Output System (BIOS), installs XenServer hypervisor
and a Service Virtual Machine image, and copies the NetScaler VPX image to the Solid State Drive.
T he conversion process also sets up a Redundant Array of Independent Disks (RAID) controller for local storage (SSD slot #
1 and SSD slot # 2) and Netscaler VPX storage (SSD slot # 3 and SSD slot # 4).
After the conversion process, you make a few modications to the appliances conguration and apply a new license. You
can then provision the VPX instances through the Management Service on what is now a NetScaler SDX appliance.
Important: Note that mixing and matching of old and new SSDs is not supported. SSDs in slot #1 and slot # 2, which
constitute the rst RAID pair (local storage), must be of same size and type. Similarly, SSDs in slot # 3 and slot # 4, which
constitute the second RAID pair (VPX storage), must be of same size and type. Do not use any other drives that are not
part of the provided conversion kit.
8. Disconnect all network cables from the data ports and the management ports.
9. Start the NetScaler appliance. For instructions, see Switching on the Appliance in Installing the Hardware.
T he conversion process can run for approximately 30 minutes, during which you must not power cycle the appliance. T he
entire conversion process might not be visible on the console and might appear to be unresponsive.
T he conversion process updates the BIOS, installs the XenServer hypervisor and the Management Service Operating
system, and copies the NetScaler VPX image to the SSD for instance provisioning, and forms the Raid1 pair.
Note: T he serial number of the appliance remains the same.
10. Keep the console cable attached during the conversion process. Allow the process to complete, at which point the
netscaler-sdx login: prompt appears.
11. During the conversion process the LOM port connection may be lost as it resets the IP address to the default value of
192.168.1.3. T he conversion status output is available on the VGA monitor.
System
NetScaler
XenServer
show | set
id
primary_server_t ype
Type of primary server. Support Types 1. LOCAL 2.RADIUS 3.LDAP 4.TACACS 5.KEYSTONE
primary_server_name
show admindomainInfo
show | add
show backup
backup_le_name
Backup le name
show | delete
le_name
File Name
le_name
File Name
show | set
Use this operation to get backup policy to view the number of previous backups to retain
policy_name
Policy Name
policy_name
Policy Name
id
show | set
show hostname
host name
Hostname
id
Id is IP block name
id
Id is IP block name
id
end_ip_num
end_ip_num
region_code
region_code
descript ion
st art _ip_num
start_ip_num
name
name
longit ude
longitude
lat it ude
latitude
count ry_code
country_code
cit y
city
region
region
st art _ip
start_ip
end_ip
end_ip
count ry
country
end_ip_num
end_ip_num
region_code
region_code
descript ion
st art _ip_num
start_ip_num
name
name
longit ude
longitude
lat it ude
latitude
count ry_code
country_code
cit y
city
region
region
st art _ip
start_ip
end_ip
count ry
country
show ldapserver
Synopsys
Parameters
id
delete ldapserver
Synopsys
Parameters
id
set ldapserver
Synopsys
Parameters
id
name
ip_address
port
validate_ldap_server_certs
ldap_host_name
sec_type
type
subattribute_name
change_password
f ollow_ref errals
max_nesting_level
group_search_lter
String to be combined with the default LDAP group search string to form the search value
group_attr_name
max_ldap_ref errals
group_search_attribute
LDAP group search attribute. Used to determine to which groups a group belongs
group_search_subattribute
LDAP group search subattribute. Used to determine to which groups a group belongs.
auth_timeout
T he maximum number of seconds the system will wait for a response from the LDAP server
nested_group_extraction
group_name_identier
def ault_authentication_group
bind_passwd
bind_dn
search_lter
T he String to be combined with the default LDAP user search string to form the value
login_name
T he name attribute used by the system to query the external LDAP server
base_dn
add ldapserver
Synopsys
Parameters
type
name
ip_address
port
validate_ldap_server_certs
ldap_host_name
sec_type
subattribute_name
change_password
f ollow_ref errals
max_nesting_level
group_search_lter
String to be combined with the default LDAP group search string to form the search value
group_attr_name
max_ldap_ref errals
group_search_attribute
LDAP group search attribute. Used to determine to which groups a group belongs
group_search_subattribute
LDAP group search subattribute. Used to determine to which groups a group belongs.
auth_timeout
T he maximum number of seconds the system will wait for a response from the LDAP server
nested_group_extraction
group_name_identier
def ault_authentication_group
bind_passwd
bind_dn
search_lter
T he String to be combined with the default LDAP user search string to form the value
login_name
T he name attribute used by the system to query the external LDAP server
base_dn
show | do custom
show license
Synopsys
show license
do license custom
Synopsys
do license custom
show | delete
show licensele
Synopsys
Parameters
le_name
File Name
delete licensele
Synopsys
Parameters
le_name
File Name
show mailprole
Synopsys
Parameters
id
delete mailprole
Synopsys
Parameters
id
set mailprole
Synopsys
Parameters
id
to_list
server_name
cc_list
prole_name
bcc_list
sender_mail_address
add mailprole
Synopsys
Parameters
to_list
server_name
prole_name
cc_list
bcc_list
sender_mail_address
show manageddevice
Synopsys
Parameters
id
show managementservicestatistics
Synopsys
Parameters
id
show | set
show networkcong
Synopsys
show networkcong
set networkcong
Synopsys
Parameters
gateway
Gateway
xen_ip_address
XenServer IP Address
network_interf ace
svm_ip_address
netmask
dns
DNS Server
init_status
act_id
Activity Id
show networkpool
Synopsys
Parameters
id
show | set
show ntpparam
Synopsys
show ntpparam
set ntpparam
Synopsys
Parameters
trusted_key_list
automax_logsec
authentication
Authentication Enabled
revoke_logsec
show ntpserver
Synopsys
Parameters
server
delete ntpserver
Synopsys
Parameters
server
set ntpserver
Synopsys
Parameters
minpoll
NT P Server Preferred
server
autokey
key_id
maxpoll
client
add ntpserver
Synopsys
Parameters
server
minpoll
pref erred_server
NT P Server Preferred
autokey
key_id
maxpoll
client
show | set
show ntpsync
Synopsys
show ntpsync
set ntpsync
Synopsys
Parameters
ntpd_status
ntpd status
show | set
show passwordpolicy
Synopsys
Parameters
id
set passwordpolicy
Synopsys
Parameters
enable_password_complexity
minimum_password_length
show | set
show prunepolicy
Use this operation to get the prune policy to view number of days data to retain
Synopsys
Parameters
policy_name
Policy Name
set prunepolicy
Synopsys
Parameters
data_to_keep_in_days
policy_name
Policy Name
show | set
show snmpmib
Synopsys
Parameters
id
set snmpmib
Synopsys
Parameters
location
name
contact
custom_id
show radiusserver
Synopsys
Parameters
id
delete radiusserver
Synopsys
Parameters
id
set radiusserver
Synopsys
id
ip_address
name
port
ip_vendor_id
T he vendor ID of the attribute in the RADIUS response which denotes the intranet IP
ip_attribute_type
nas_id
NAS ID
auth_timeout
T he maximum number of seconds the system will wait for a response from the Radius server
pwd_attribute_type
accounting
group_vendor_id
group_attribute_type
Vendor ID of the password in the RADIUS response. Used to extract the user password
def ault_authentication_group
T his is the default group that is chosen when the authentication succeeds in addition to extracted groups
group_separator
Group separator string that delimits group names within a RADIUS attribute for RADIUS group extraction
pass_encoding
radius_key
enable_nas_ip
groups_prex
Prex string that precedes group names within a RADIUS attribute for RADIUS group extraction
add radiusserver
Synopsys
Parameters
ip_address
name
radius_key
port
ip_vendor_id
T he vendor ID of the attribute in the RADIUS response which denotes the intranet IP
ip_attribute_type
nas_id
NAS ID
auth_timeout
T he maximum number of seconds the system will wait for a response from the Radius server
pwd_attribute_type
accounting
group_vendor_id
group_attribute_type
pwd_vendor_id
Vendor ID of the password in the RADIUS response. Used to extract the user password
def ault_authentication_group
T his is the default group that is chosen when the authentication succeeds in addition to extracted groups
group_separator
Group separator string that delimits group names within a RADIUS attribute for RADIUS group extraction
pass_encoding
groups_prex
Prex string that precedes group names within a RADIUS attribute for RADIUS group extraction
show rediscover
Use this operation to start inventory of a given device. All devices if device IP Address is not specied.
Synopsys
Parameters
device_ipaddress
Device IP Address
show | delete
show singlebundleimage
Synopsys
Parameters
le_name
File Name
delete singlebundleimage
Synopsys
Parameters
le_name
File Name
show singlebundleinf o
Synopsys
show singlebundleinfo
do singlebundleupgrade custom
Synopsys
Parameters
le_name
File Name
show smsprole
Synopsys
Parameters
id
delete smsprole
Synopsys
Parameters
id
set smsprole
Synopsys
Parameters
id
to_list
To list.
server_name
prole_name
add smsprole
Synopsys
Parameters
to_list
To list.
server_name
prole_name
show smsserver
Synopsys
Parameters
id
delete smsserver
Synopsys
Parameters
id
set smsserver
Synopsys
id
is_ssl
optional2_key
to_separator
to_key
username_key
message_word_separator
optional_key
type
base_url
message_key
optional_val
server_name
password_val
username_val
password_key
optional3_key
optional3_val
add smsserver
Synopsys
Parameters
to_key
username_key
type
message_key
server_name
password_val
username_val
password_key
is_ssl
optional2_key
to_separator
message_word_separator
optional_key
optional2_val1
optional3_key
optional3_val
show smtpserver
Synopsys
Parameters
id
delete smtpserver
Synopsys
Parameters
id
set smtpserver
Synopsys
Parameters
id
is_ssl
port
server_name
username
is_auth
password
add smtpserver
Synopsys
Parameters
server_name
is_ssl
port
username
is_auth
password
show | set
show snmpalarm
Synopsys
Parameters
name
Alarm Name
set snmpalarm
Synopsys
Parameters
name
Alarm Name
enable
Enable Alarm
severity
show | set
show snmpinf o
Synopsys
show snmpinfo
set snmpinf o
Synopsys
Parameters
engine_id
SNMP EngineID
show snmpmanager
Synopsys
Parameters
snmp_manager
Manager IPAddress
delete snmpmanager
Synopsys
Parameters
snmp_manager
Manager IPAddress
set snmpmanager
Synopsys
Parameters
snmp_manager
Manager IPAddress
community
Community Name
add snmpmanager
Synopsys
Parameters
snmp_manager
Manager IPAddress
community
Community Name
show snmptrap
Synopsys
Parameters
dest_server
delete snmptrap
Synopsys
Parameters
dest_server
set snmptrap
Synopsys
Parameters
dest_server
user_name
community
Community Name
dest_port
Destination Port
version
SNMP version
add snmptrap
Synopsys
Parameters
dest_server
user_name
community
Community Name
dest_port
Destination Port
version
SNMP version
show snmpuser
Synopsys
Parameters
name
delete snmpuser
Synopsys
Parameters
name
set snmpuser
Synopsys
Parameters
security_level
name
view_name
auth_protocol
privacy_protocol
auth_password
privacy_password
add snmpuser
Synopsys
Parameters
security_level
name
view_name
auth_protocol
privacy_protocol
auth_password
privacy_password
show snmpview
Synopsys
Parameters
name
delete snmpview
Synopsys
Parameters
name
set snmpview
Synopsys
Parameters
name
subtree
type
add snmpview
Synopsys
Parameters
name
subtree
type
show | delete
show sslcertle
Synopsys
Parameters
le_name
File Name
delete sslcertle
Synopsys
Parameters
le_name
File Name
show | add
show sslcerticate
Synopsys
show sslcerticate
add sslcerticate
Synopsys
Parameters
ssl_certicate
Certicate
status
subject
Subject
ssl_key
Key
valid_f rom
Valid From
days_to_expiry
public_key_algorithm
password
version
Version
serial_number
Serial Number
signature_algorithm
Signature Algorithm
issuer
Issuer
valid_to
Valid To
show | delete
show sslkeyle
Synopsys
Parameters
le_name
File Name
delete sslkeyle
Synopsys
Parameters
le_name
File Name
show | set
show sslsettings
Synopsys
show sslsettings
set sslsettings
Synopsys
set sslsettings [sslv3=(false | true)] [sslreneg=(false | true)] [tlsv1=(false | true)] [tlsv1_2=(false | true)] [tlsv1_1=(false |
true)]
Parameters
sslv3
Enable SSLv3
sslreneg
tlsv1
Enable T LSv1
tlsv1_2
Enable T LSv1.2
tlsv1_1
Enable T LSv1.1
show | set
show sslv3Setting
Synopsys
show sslv3Setting
set sslv3Setting
Synopsys
Parameters
enable
show | set
show syslogparameters
Synopsys
Parameters
id
set syslogparameters
Synopsys
Parameters
timezone
date_f ormat
show syslogserver
Synopsys
Parameters
name
delete syslogserver
Synopsys
Parameters
name
set syslogserver
Synopsys
Parameters
log_level_all
log_level_none
log_level_warning
port
log_level_critical
log_level_inf o
name
add syslogserver
Synopsys
Parameters
port
ip_address
name
log_level_all
log_level_inf o
log_level_none
log_levels
Set of all log levels at which messages are sent to this syslog server
log_level_warning
log_level_critical
log_level_error
show | do factory_default
show systembackuprestore
Synopsys
Parameters
le_name
File Name
Synopsys
Parameters
reset_type
Reset Type [0: Reset (Without Network Conguration), 1: Reset (With Network Conguration), 2: Appliance Reset,
3: Appliance Restore, 4: Instance Restore, 5: Backup ]
show tenant
Synopsys
Parameters
id
delete tenant
Synopsys
Parameters
id
set tenant
Synopsys
Parameters
id
user_name
system_resource
auth_servers
name
company_inf o
password
Password
network_pools
parent_id
add tenant
Synopsys
Parameters
user_name
Password
parent_id
system_resource
auth_servers
name
company_inf o
network_pools
show systemgroup
Synopsys
Parameters
id
delete systemgroup
Synopsys
Parameters
id
set systemgroup
Synopsys
Parameters
id
name
Group Name
session_timeout
tenant_id
Id of the tenant
session_timeout_unit
enable_session_timeout
permission
users
add systemgroup
Synopsys
Parameters
name
Group Name
permission
tenant_id
Id of the tenant
session_timeout_unit
enable_session_timeout
users
show | delete
show systemimage
Synopsys
Parameters
le_name
File Name
delete systemimage
Synopsys
Parameters
le_name
File Name
show | delete
show systemsession
Synopsys
Parameters
id
delete systemsession
Synopsys
Parameters
id
show | set
id
is_met ering_enabled
secure_access_only
session_t imeout
enable_session_t imeout
svm_ns_comm
act _id
Activity Id
show | do reboot
show systemstatus
do systemstatus reboot
image_name
image_name
id
id
id
name
User Name
session_t imeout
enable_session_t imeout
permission
password
Password
encrypt ed
groups
name
password
Password
session_t imeout
enable_session_t imeout
permission
encrypt ed
groups
id
id
id
ip_address
name
port
t acacs_key
T he maximum number of seconds the system will wait for a response from the TACACS server
account ing
ip_address
t acacs_key
port
T he maximum number of seconds the system will wait for a response from the TACACS server
account ing
List of VPX for which the techsupport is required (Applicable for only : ManagementServiceIncludingInstances and
ApplianceIncludingInstances)
le_name
le_name
List of VPX for which the techsupport is required (Applicable for only : ManagementServiceIncludingInstances and
ApplianceIncludingInstances)
le_name
le_name
le_name
show | set
show timezone
t imezone
T imezone
show | set
id
invalid_logins
enable_user_lockout
vlan_id
VLAN ID
show vlansummary
id
ns - NetScaler
nsdocimage - NetScaler Documentation File
nsimage - NetScaler Build File
nssslcertfile - NS SSL certificate File
nssslcertkey - SSL certificate on NetScaler
nssslcertkeypolicy - NetScaler SSL Cert-Key Polling Policy
nssslkeyfile - NS SSL key File
nsupgrade - Upgrade NetScaler
do ns stop [id=<string>]
id
id
name
do ns start [id=<string>]
id
do ns reboot [id=<string>]
id
delete ns id=<string>
id
id
name
ip_address
net mask
gat eway
license
Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum)
admin_prole_name
descript ion
vm_memory_t ot al
num_of _ssl_chips
t hroughput
pps
number_of _cores
reboot _vm_on_cpu_change
cmd_policy
l2_enabled
if _0_1
if _0_2
la_mgmt
vlan_id_0_1
vlan_id_0_2
Network Interfaces
nsvlan_id
VLAN Id
vlan_t ype
nsvlan_t agged
NSVLAN Tagged
VLAN Interfaces
do ns force_reboot [id=<string>]
id
ip_address
gat eway
l2_enabled
VLAN Interfaces
pps
t hroughput
nsvlan_t agged
NSVLAN Tagged
license
Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum)
username
cmd_policy
name
number_of _cores
vlan_id_0_1
if _0_1
net mask
vlan_id_0_2
descript ion
if _0_2
Network Interfaces
vlan_t ype
xva_le_name
Image Name, T his parameter is used while provisioning VM Instance with XVA image, template_name is given
priority if provided along with image_name
password
vm_memory_t ot al
nsvlan_id
VLAN Id
do ns force_stop [id=<string>]
id
show | delete
le_name
File Name
le_name
File Name
show | delete
le_name
File Name
le_name
File Name
show | delete
le_name
File Name
le_name
File Name
id
Id is system generated key for all ssl cert-keys entries. For download operation "id" must be provided in the format
<ns_ip_address>_<certkeypair_name>.tgz
id
Id is system generated key for all ssl cert-keys entries. For download operation "id" must be provided in the format
<ns_ip_address>_<certkeypair_name>.tgz
Id is system generated key for all ssl cert-keys entries. For download operation "id" must be provided in the format
<ns_ip_address>_<certkeypair_name>.tgz
ssl_cert icat e
Certicate
ssl_key
Key
cert _f ormat
Certicate Format
password
save_cong
no_domain_check
Specify this option to override the check for matching domain names during certicate update operation
ssl_cert icat e
Certicate
cert keypair_name
ssl_key
Key
cert _f ormat
Certicate Format
password
save_cong
id
Id is system generated key for all ssl cert-keys entries. For download operation "id" must be provided in the format
<ns_ip_address>_<certkeypair_name>.tgz
Use this operation to poll all SSL certicates from all NetScalers and update the database
do nssslcertkeypolicy do_poll
Use this operation to get the polling frequency of the NetScaler SSL certicates
show nssslcertkeypolicy
Use this operation to set the polling frequency of the NetScaler SSL certicates
polling_int erval
int erval_unit
show | delete
le_name
File Name
le_name
File Name
image_name
image_name
doc_le
ns_ip_address_arr
List of NS IP Address
appliance - Xen
channel - Channels on the system
channelinfo - Provides platfor specific channel information
cleaninstall - Xen Upgrade
cpucoreusage - Host CPU Cores
hostinterface - XenServer Interface
raidLogicalDrive - Raid Logical Drive
raidPhysicalDrive - Raid Physical Drive
systemhealth - Health Summary
systemhealthHardware - Hardware Resource
systemhealthSoftware - Software Resource
systemhealthStorageRepository - Storage Repository
systemhealthdisk - Disk IO Statistics
systemhealthfanspeed - Xen Health Monitor (IPMI Sensor) - Fan Speed
systemhealthpowersupply - Xen Health Monitor (IPMI Sensor) - Miscellaneous
systemhealthtemperature - Xen Health Monitor (IPMI Sensor) - T emperature
systemhealthvoltage - Xen Health Monitor (IPMI Sensor) - Voltage
xenhotfix - Xen Hotfix
xennsvpximage - NetScaler XVA File
xensupplementalpack - XenServer Supplemental Pack
xenupgrade - Xen Upgrade
do appliance stop
Synopsys
Parameters
id
show appliance
Synopsys
Parameters
id
do appliance reboot
Synopsys
Parameters
id
show channel
Synopsys
show channel
delete channel
Synopsys
Parameters
channel_id
mtu
static_channel_state
channel_alias
state
channel_tag_all_vlans
channel_type
lacp_channel_time
channel_bandwidth_high
channel_ha_monitoring
HA-monitoring control for the channel. Possible values: true and false
channel_throughput
channel_bandwidth_normal
channel_interf ace_list
Comma separated list of interfaces that are part of this channel if this interface represents a channel (10/1, 10/4)
set channel
Synopsys
Parameters
channel_id
mtu
static_channel_state
channel_alias
state
channel_tag_all_vlans
If true then all the member interfaces of this channel are tagged. Possible values: true and false
channel_type
lacp_channel_time
channel_bandwidth_high
channel_ha_monitoring
HA-monitoring control for the channel. Possible values: true and false
channel_throughput
channel_bandwidth_normal
channel_interf ace_list
Comma separated list of interfaces that are part of this channel if this interface represents a channel (10/1, 10/4)
add channel
Synopsys
static_channel_state
channel_id
channel_type
channel_interf ace_list
Comma separated list of interfaces that are part of this channel if this interface represents a channel (10/1, 10/4)
mtu
channel_alias
state
channel_tag_all_vlans
If true then all the member interfaces of this channel are tagged. Possible values: true and false
lacp_channel_time
channel_bandwidth_high
channel_ha_monitoring
HA-monitoring control for the channel. Possible values: true and false
channel_throughput
channel_bandwidth_normal
show channelinf o
Synopsys
show channelinfo
show | add
show cleaninstall
Synopsys
show cleaninstall
add cleaninstall
Synopsys
Parameters
image_name
image_name
is_supported
Is Clean-Install supported
show cpucoreusage
Synopsys
show cpucoreusage
Synopsys
Parameters
id
Synopsys
Parameters
mapped_port
mtu
port
apply_mac_address
base_mac_address
Mac Address
add_mac_address
interf ace_type
ow_control_tx
T X Pause
adv_auto_neg
speed
Actual speed
cpu_socket
ow_control_rx
RX Pause
state
ow_control_auto_neg
act_id
Activity Id
device_name
Device Name
port_type
Port Type
Duplex
Synopsys
Parameters
id
show raidLogicalDrive
Synopsys
Parameters
id
delete raidLogicalDrive
Synopsys
Parameters
id
add raidLogicalDrive
Synopsys
Parameters
name
Adapter ID
state
State
drives
Drives
targetid
Target ID
virtualdrive
Virtual Drive
size
physical_disk_slot_1
physical_disk_slot_2
do raidPhysicalDrive make_good_pd
Synopsys
Parameters
slot
Slot Number
show raidPhysicalDrive
Synopsys
Parameters
slot
Slot Number
do raidPhysicalDrive remove_pd
Synopsys
Parameters
slot
Slot Number
Synopsys
Parameters
slot
Slot Number
do raidPhysicalDrive locate_pd_stop
Synopsys
Parameters
slot
Slot Number
do raidPhysicalDrive replace_missing
Synopsys
Parameters
slot
Slot Number
show systemhealth
Synopsys
Parameters
id
show systemhealthHardware
Synopsys
show systemhealthHardware
Synopsys
show systemhealthSoftware
show systemhealthStorageRepository
Synopsys
Parameters
bay_number
Bay number
show systemhealthdisk
Synopsys
Parameters
name
Use this operation to get the IPMI sensor data (for all fan-speed sensors)
Synopsys
show systemhealthfanspeed
show systemhealthpowersupply
Use this operation to get the IPMI Sensor data (for all miscellaneous sensors)
Synopsys
show systemhealthpowersupply
show systemhealthtemperature
Use this operation to get the IPMI sensor data (for all temperature sensors)
Synopsys
show systemhealthtemperature
show systemhealthvoltage
Use this operation to get the IPMI sensor data (for all voltage sensors)
Synopsys
show systemhealthvoltage
show xenhotx
Synopsys
Parameters
le_name
File Name
delete xenhotx
Synopsys
Parameters
le_name
File Name
do xenhotx custom
Synopsys
Parameters
le_name
File Name
show | delete
show xennsvpximage
Synopsys
Parameters
le_name
File Name
delete xennsvpximage
Synopsys
Parameters
le_name
File Name
show xensupplementalpack
Synopsys
Parameters
le_name
File Name
delete xensupplementalpack
Synopsys
Parameters
le_name
File Name
do xensupplementalpack custom
Synopsys
Parameters
le_name
File Name
do xenupgrade custom
Synopsys
Parameters
image_name
image_name