Citrix NetScaler SDX 8015 Manual

Hide thumbs Also See for NetScaler SDX 8015:

Advertisement

Introduction
Sep 0 1, 20 16
T he Citrix NetScaler SDX appliance is a multitenant platform on which you can provision and manage multiple virtual
NetScaler machines (instances). T he SDX appliance addresses cloud computing and multitenancy requirements by allowing a
single administrator to configure and manage the appliance and delegate the administration of each hosted instance to
tenants. T he SDX appliance enables the appliance administrator to provide each tenant the following benefits:
One complete instance. Each instance has the following privileges:
Dedicated CPU and memory resources
A separate space for entities
T he independence to run the release and build of their choice
Lifecycle independence
A completely isolated network. T raffic meant for a particular instance is sent only to that instance.
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 configure, manage, and monitor the
appliance, the Management Service, and the instances. A Citrix self-signed certificate is prepackaged for HT T PS support.
Citrix recommends that you use the HT T PS mode to access the Management Service user interface.
https://docs.citrix.com
© 1999-2017 Citrix Systems, Inc. All rights reserved.
p.4

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the NetScaler SDX 8015 and is the answer not in the manual?

Questions and answers

Summary of Contents for Citrix NetScaler SDX 8015

  • Page 1 Sep 0 1, 20 16 T he Citrix NetScaler SDX appliance is a multitenant platform on which you can provision and manage multiple virtual NetScaler machines (instances). T he SDX appliance addresses cloud computing and multitenancy requirements by allowing a single administrator to configure and manage the appliance and delegate the administration of each hosted instance to...
  • Page 2: Release Notes

    Dec 31, 20 13 Release notes describe the enhancements, changes, bug fixes, and known issues for a particular release or build of Citrix NetScaler software. T he NetScaler SDX release notes are covered as a part of NetScaler release notes.
  • Page 3 NetScaler SDX Hardware and Component Compatibility Matrix Apr 11, 20 17 See the updated NetScaler SDX hardware-software compatibility matrix. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved.
  • Page 4: Hardware Installation

    Lights Out Management port, so that you have management access to the appliance even if your network goes down. T he Citrix NetScaler SDX appliance is a multi-tenant platform on which you can provision and manage multiple virtual instances of a NetScaler appliance.
  • Page 5 On the appliance’s back panel, power status LEDs indicate the status of each power supply. T he following table describes the indicators of the power status LED. LED Color LED Color LED Indicat es LED Indicat es No power Green Appliance is receiving power https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved.
  • Page 6 No connection, or a traffic rate of 10 megabits per second (Mbps). Green T raffic rate of 100 Mbps. Yellow T raffic rate of 1 gigabit per second. Right Link/ No link. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved.
  • Page 7 Flashing GREEN Power supply is in standby mode. GREEN Power supply is functional. Power supply failure. No power to any power supply. Flashing RED No power to this power supply. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.10...
  • Page 8: Rs232 Serial Port

    Management Ports Management ports are standard copper Ethernet ports (RJ45), which are used for direct access to the appliance for system administration functions. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.11...
  • Page 9 NetScaler 1G (nominal) MMF, 22040/22060/22080/22100/22120, EW3C0000234, SFP Ethernet 2000MHz- SDX 24100/24150 EW3D0000234, SX (300m) - 4 4 km (OM3) EW3E0000234, P ack P ack 50/125um 550 m EW3F0000234, MMF, EW3P0000142, https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.12...
  • Page 10 EW3F0000710, (300m) - 24100/24150 MMF, EW3P0000557, Single Single 500MHz- EW3X0000710, km (OM2) EW3Z0000585 50/125um 550 m MMF, 400MHz- 62.5/125um 275 m MMF, 200MHz- km (OM1) 62.5/125um 220 m MMF, 160MHz- https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.13...
  • Page 11 SDX 8015/8400/8600, SDX EW3B0000710, NetScaler (nominal) MMF, 11500/13500/14500/16500/18500/20500, EW3C0000710, 10G SFP+ 2000MHz- SDX 11515/11520/11530/11540/11542, EW3D0000710, Ethernet km (OM3) EW3E0000710, Short Range 14020/14030/14040/14060/14080/14100, 50/125um 82 m EW3F0000710, (300m) - SDX 17500/19500/21500, SDX https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.14...
  • Page 12 NetScaler (nominal) 11500/13500/14500/16500/18500/20500, EW3C0000711, 10G SFP+ SDX 11515/11520/11530/11540/11542, EW3D0000711, Ethernet EW3E0000711, Long Range 14020/14030/14040/14060/14080/141, EW3F0000711, (10km) - 00SDX 17500/19500/21500, SDX EW3P0000558, Single Single 17550/19550/20550/21550, SDX EW3X0000711, 22040/22060/22080/22100/22120, SDX EW3Z0000586 24100/24150 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.15...
  • Page 13: Field Replaceable Units

    Jan 28 , 20 11 Citrix NetScaler field replaceable units (FRU) are NetScaler components that can be quickly and easily removed from the appliance and replaced by the user or a technician at the user's site. T he FRUs in a NetScaler appliance can include DC or AC power supplies, and solid-state or hard-disk drives, and a direct attach cable (DAC).
  • Page 14: Replacing A Dc Power Supply

    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.
  • Page 15 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.18...
  • Page 16 Important: When you insert the drive, make sure that the Citrix product label is at the right. Figure 6. Inserting the Replacement Solid-State Drive After you replace one of the SSDs, the configuration on the other SSD in the mirrored SSD is copied to the replacement...
  • Page 17: Replacing A Hard Disk Drive

    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.
  • Page 18: Installing A Direct Attach Cable

    (SFP+ transceivers and fiber 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.
  • Page 19 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.22...
  • Page 20: Hardware Platforms

    T he various NetScaler hardware platforms offer a wide range of features, communication ports, and processing capacities. All platforms have multicore processors. T he Citrix NetScaler SDX appliance is a multi-tenant platform on which you can provision and manage multiple virtual instances of NetScaler.
  • Page 21 Aug 0 1, 20 17 T he Citrix NetScaler models SDX 8015, SDX 8400, and SDX 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 8015/8400/8600 appliances are...
  • Page 22 SFP+ ports numbered 10/1 and 10/2 on the bottom row from left to right. T he following figure shows the back panel of the SDX 8015/8400/8600 appliance. Figure 3. Citrix NetScaler SDX 8015/8400/8600 appliance, back panel T he following components are visible on the back panel of the SDX 8015/8400/8600 appliance: 300 GB removable solid-state drive, which is used to store the NetScaler software and the user data.
  • Page 23 SDX 16500, SDX 18500, and SDX 20500 Oct 25, 20 13 T he Citrix NetScaler models SDX 11500/13500/14500/16500/18500/20500 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.
  • Page 24 Dual power supplies, each rated at 650 watts, 110-220 volts. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.27...
  • Page 25 SDX 11540, and SDX 11542 Mar 14 , 20 14 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.
  • Page 26 Dual power supplies, each rated at 650 watts, 110-220 volts. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.29...
  • Page 27 21500 Oct 25, 20 13 T he Citrix NetScaler models SDX 17500/19500/21500 are 2U appliances. Each model has two 6-core processors and 48 gigabytes (GB) of memory. T he following figure shows the front panel of the SDX 17500/19500/21500 appliance.
  • Page 28 Dual power supplies, each rated at 650 watts, 110-220 volts. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.31...
  • Page 29 Oct 25, 20 13 T he Citrix NetScaler models SDX 17550, SDX 19550, SDX 20550, and SDX 21550 are 2U appliances. Each model has two 6- core processors for a total of 12 physical cores (24 cores with hyper-threading), and 96 gigabytes (GB) of memory.
  • Page 30 Dual power supplies, each rated at 850 watts, 110-220 volts. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.33...
  • Page 31 SDX 22100, and SDX 22120 Oct 25, 20 13 T he Citrix NetScaler SDX 22040/22060/22080/22100/22120 are 2U appliances. Each model has two 8-core processors (32 cores with hyper-threading) and 256 gigabytes (GB) of memory. T he SDX 22040/22060/22080/22100/22120 appliances are...
  • Page 32 SDX 22040/22060/22080/22100/22120 (24x10G SFP+). T wenty-four 10G SFP+ ports. T he following figure shows the back panel of the SDX 22040/22060/22080/22100/22120 appliances. Figure 3. Citrix NetScaler SDX 22040/22060/22080/22100/22120, back panel T he following components are visible on the back panel of the SDX 22040/22060/22080/22100/22120 appliance: Non-maskable interrupt (NMI) Button, used at the request of T echnical Support to initiate a core dump.
  • Page 33 Oct 25, 20 13 T he Citrix NetScaler SDX 24100/24150 are 2U appliances. Each model has two 8-core processors (32 cores with hyper- threading) and 256 gigabytes (GB) of memory. T he SDX 24100/24150 appliances are available in the twelve 1G SFP ports and twenty-four 10G SFP+ ports (12x1G SFP + 24x10G SFP+) configuration.
  • Page 34 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.37...
  • Page 35 SDX 14060, SDX 14080 and SDX 14100 Dec 22, 20 16 The Citrix NetScaler SDX 14020/14030/14040/14060/14080/14100 are 2U appliances. Each model has two 6-core processors and 64 gigabytes (GB) of memory and sixteen 10G SFP+ ports (16x10G SFP+). Note: For information about NetScaler SDX hardware and component compatibility matrix, see https://docs.citrix.com/en-us/sdx/11/sdx-ag-supported-versions-...
  • Page 36 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.39...
  • Page 37 Mar 24 , 20 16 T he Citrix NetScaler SDX 14020 40G, SDX 14040 40G, SDX 14060 40G, SDX 14080 40G, and SDX 14100 40G are 2U appliances. Each model has two 6-core processors and 64 gigabytes (GB) of memory. T he SDX 14020 40G, 14040 40G, SDX 14060 40G, SDX 14080 40G, and SDX 14100 40G appliances are available in the four 40G QSFP+ ports and sixteen 10G SFP+ ports (4x40G QSFP+ + 16x10G SFP+) configuration.
  • Page 38 Figure 2. Citrix NetScaler SDX 14020 40G, SDX 14040 40G, SDX 14060 40G, SDX 14080 40G, back panel T he following components are visible on the back panel of the SDX 14020 40G, SDX 14040 40G, SDX 14060 40G, SDX 14080 40G appliance: T wo 240 GB removable solid-state drives (SSDs).
  • Page 39 Mar 24 , 20 16 T he Citrix NetScaler SDX 25100-40G, SDX 25160-40G are 2U appliances. Each model has two 10-core processors, 256 gigabytes (GB) of memory, four 40G QSFP+ ports, and sixteen 10G SFP+ ports (4x40G QSFP+ + 16x10G SFP+).
  • Page 40 Buttonis also available remotely over the network in the LOM GUI, in the Remote Controlmenu. 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.43...
  • Page 41 Citrix NetScaler SDX 25100A, SDX 25160A Jan 11, 20 17 T he Citrix NetScaler SDX 25100A and SDX 25160A are 2U appliances. Each model has two 10-core processors, 256 GB of memory, eight 40GE QSFP+ ports (8x40GE QSFP+). T he following figure shows the front panel of the SDX 25100A and SDX 25160A appliance.
  • Page 42 Buttonis also available remotely over the network in the LOM GUI, in the Remote Controlmenu. 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.45...
  • Page 43 14080-40S, SDX 14100-40S May 0 2, 20 17 T he Citrix NetScaler SDX 14040-40S/14060-40S/14080-40S/14100-40S are 2U appliances. Each model has two 6-core processors and 64 gigabytes (GB) of memory and four 40GE QSFP+ ports and eight 10GE SFP+(4x 40GE QSFP+; 8x 10GE SFP+).
  • Page 44 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.47...
  • Page 45 Citrix NetScaler SDX 14030 FIPS, 14060 FIPS, 14080 FIPS Jul 0 7, 20 17 Configuring an SDX 14000 FIPS Appliance for more information. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.48...
  • Page 46 Ports - 10G 2x10G SFP+ 4x10G SFP+ ports 8x1G SFP + 4 x10G SFP+ model: 6x10/100/1000Base-T 4x10G SFP+ ports copper Ethernet model: 2x10G SFP+ Ports Number of Power Supplies Maximum NetScaler https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.49...
  • Page 47 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 Compliance RoHS, WEEE RoHS, SVHC, WEEE RoHS, SVHC, WEEE https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.50...
  • Page 48 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 24 x10G SFP+ model: 100-240VAC 50/60 hz https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.51...
  • Page 49 0– 40° C 0– 40° C Temperature (degree 32– 104° F 32– 104° F Celsius) Humidity range (non- 5%-95% 5%-95% 20%– 80% 20%– 80% condensing) Safety Certifications T UV T UV https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.52...
  • Page 50: Specifications

    528 W power 528 W 528 W consumption Maximum DC 594 W power 594 W 594 W consumption Airflow (front to 110 CFM Typical 110 CFM Typical 110 CFM Typical https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.53...
  • Page 51 Arabia (CITC), South (ICASA), MoC) Africa (ICASA), Russia (EAC, CU-T R), Russia (EAC, CU-T R), Taiwan (BSMI), Taiwan (BSMI), Brazil (Inmetro & Anatel), Brazil (Inmetro & Israel (MoE, Anatel), Israel (MoE, https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.54...
  • Page 52 16.5 – 8.25 A Maximum AC power consumption 822 W 528 W Maximum DC power consumption 594 W 594 W Airflow (front to rear) Heat dissipation Package weight (lbs.) System weight (lbs.) Height https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.55...
  • Page 53 EIA 310-D for 19-inch racks Depth 71.2 cm; 28 in 71.2 cm; 28 in Operating temperature 0-40°C; 32-104°F 0-40°C; 32-104°F Humidity range (non-condensing) 5%-95% 5%-95% Safety certifications EMC & susceptibility Environmental compliance RoHS RoHS https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.56...
  • Page 54: Preparing For Installation

    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.
  • Page 55 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. Note: You can order the following rail kits separately.
  • Page 56 T herefore, consider the lowest and highest operating temperatures of the equipment when making a decision about where to install the appliance in the rack. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.59...
  • Page 57: Rack Precautions

    T he handles on the left and right of the front panel of the appliance should be used only for extending the appliance out of the rack. Do not use these handles for mounting the appliance on the rack. Use the rack-rail hardware, described later, instead. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.60...
  • Page 58: Installing The Hardware

    An assembly consists of an inner rail and a rack rail. T he supplied rail kit is 28 inches long (38 inches extended). Contact your Citrix sales representative to order a 23-inch (33 inches extended) rail kit.
  • Page 59 1U or 2U appliance. T he three holes are not evenly spaced. Figure 2. Installing Retainers into the Front Rack Posts Figure 3. Installing Retainers into the Rear Rack Posts https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.62...
  • Page 60 2. Slide the appliance into the rack rails, keeping the pressure even on both sides. 3. Verify that the appliance is locked in place by pulling it all the way out from the rack. Figure 5. Rack Mounting the Appliance https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.63...
  • Page 61 SDX 24100/24150 Important 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.
  • Page 62 Installing and Removing 40G QSFP+ Ports and 10G SFP+ Transceivers A 10-Gigabit SFP+ is a compact optical transceiver that can operate at speeds of up to 10 gigabits per second. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.65...
  • Page 63 SDX 25160A-40G/25100A-40G Important NetScaler appliances do not support support 40G QSFP+/10G SFP+ transceivers provided by vendors other than Citrix Systems. Attempting to install third-party support 40G QSFP+/10G SFP+ transceivers on your NetScaler appliance voids the warranty. Insert the support 40G QSFP+/10G SFP+ transceivers into the support 40G QSFP+/10G SFP+ ports on the front panel of the appliance.
  • Page 64: Connecting The Ethernet Cables

    2. Insert the RJ-45 connector on the other end into the target device, such as a router or switch 3. Verify that the LED glows amber when the connection is established. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.67...
  • Page 65: Connecting The Console Cable

    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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.68...
  • Page 66: Switching On The Appliance

    2. Press the ON/OFF toggle power switch on the back panel of the appliance. Warning 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.69...
  • Page 67: Initial Configuration

    Service user interface from any computer that is on the same network as the new SDX appliance. If you do not have a computer on the same network, use the serial console to perform the initial configuration of the SDX appliance. Citrix recommends that, as soon as you complete the initial configuration, you change the root-user password.
  • Page 68 Changing the Password of the Def ault User Account 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.
  • Page 69 2. In the Users pane, click the default user account, and then click Modify. 3. In the Modify System User dialog box, in Password and Confirm Password, enter the password of your choice. 4. Click OK. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.72...
  • Page 70: Initial Setup Wizard

    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 .
  • Page 71 To access the console of Management Service or XenServer, navigate to Configuration > 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.
  • Page 72 You can view and hide the details of a particular NetScaler instance by clicking the name of the instance in the Name column. You can also click Expand All to expand all the instance nodes and Collapse All to collapse all the instance nodes. Add and remove gadgets https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.75...
  • Page 73 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.76...
  • Page 74 XenServer, then the NetScaler instances (if necessary). Citrix recommends using the latest version of XenServer supported on the corresponding version of the Management Service. Also, make sure you apply the latest versions of the Supplemental Packs and Hotfixes. See the...
  • Page 75 NetScaler instance. version and check the XenServer 2. Check the See the Supported and Management Service version Versions requirements for that table. enhancement. 3. Upgrade the NetScaler instance. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.78...
  • Page 76 3. In the Upgrade Management Service dialog box, in Software Image, select the software image file to which you want to upgrade the Management Service. 4. In Documentation File, select the documentation file you want to use during upgrade. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.79...
  • Page 77 5. Click OK. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.80...
  • Page 78: Upgrading The Software

    1. In the navigation pane, click System. 2. In the details pane, click Upgrade XenServer. 3. In the Upgrade XenServer dialog box, select the Image file from the list. 4. Click OK, and then click Close. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.81...
  • Page 79 You can upload the XenServer hotfix files from a client computer to the SDX appliance. You can also download the hotfix files to a local computer as a backup. Important: Citrix recommends that you make a backup before applying a XenServer hotfix. Apply only the hotfix that is available in the NetScaler download page.
  • Page 80 2. In the message box, from the Save list, select Save as. 3. In the Save As message box, browse to the location where you want to save the file, and then click Save. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.83...
  • Page 81 You can use the Management Service to upgrade one or more of the NetScaler VPX instances running on the appliance. Before upgrading an instance, make sure that you have uploaded the correct build to the SDX appliance. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.84...
  • Page 82 4. From the Instance IP Address drop-down list, select the IP addresses of the instances that you want to upgrade. 5. Click OK, and then click Close. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.85...
  • Page 83 Changing the Password of the Default User Account 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.
  • Page 84: Configuring Clock Synchronization

    Automax Interval— T he interval between regeneration of the session key list used with the Autokey protocol, as a power of 2, in seconds. Default value: 12 (2^12=1.1 hours). 4. Click OK, and then click Close. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.87...
  • Page 85 Supplemental Pack Version of the supplemental pack installed on the SDX appliance. License Inf ormation Platf orm Model number of the hardware platform, based on the installed license. Maximum Instances https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.88...
  • Page 86 You can view a graph of CPU and memory usage of the appliance. T he graph is plotted in real time and updated at regular intervals. To view the CPU and memory usage of the SDX appliance, on the NetScaler GUI click Dashboard and check Management Service Statistics. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.89...
  • Page 87 Management Service node, SSL Certificate Files, to upload and manage the SSL certificates and corresponding public and private key pairs that can be installed on NetScaler instances. To access the SSL certificates and keys for NetScaler instances, navigate to Configuration > NetScaler > SSL Certificate Files. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.90...
  • Page 88: Modif Ying System Settings

    You can shut down the NetScaler SDX appliance from the Management Service. To shut down the appliance, click Configuration > System, and in the System Administration group, click Shut Down Appliance. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.91...
  • Page 89 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.92...
  • Page 90 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.93...
  • Page 91: Logical Drives

    T he virtual drive is not available to the RAID controller. You can also view the details the physical drives associated with the logical drive by selecting the logical drive and clicking Show Physical Drive. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.94...
  • Page 92: Physical Drives

    Utilized— Amount of storage-repository space in use. Adding One Addtional Logical Drive to the SDX 22000 Appliance To add an addtional logical drive to the SDX 22000 platform: 1. Log on to the Management Service. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.95...
  • Page 93 5. Physically remove the defective drive from the slot. 6. Insert the new Citrix verified SSD in the slot from where you removed the defective SSD. 7. In the Management Service, nagivate to Conf iguration > System > RAID. T he new SSD is listed in the Physical Drives section.
  • Page 94 T he logical drive is active, but does not have any pending write operations. Recovering All data on the logical drive is being written from the running array to fill up a new disk with all the relevant data. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.97...
  • Page 95 - Physical drive in good condition in sync with no pending writes spare, rebuilding - A new physical drive is being filled up with relevant data f aulty - Physical drive in a faulty state Logical Drive - Associated logical drive. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.98...
  • Page 96 4. Physically remove the defective drive from the slot. 5. Insert the new Citrix certified SSD in the slot from where you removed the defective SSD. 6. On the Physical Drives tab, click the refresh icon to refresh the list of physical drives. T he state of the drive should now appear as Present.
  • Page 97 SSDs, delete the logical drive, replace both the failed SSDs with new Citrix certified SSDs, and create the logical drive again. To replace two f ailed SSDs 1. In the Management Service, on the Dashboard tab, in the right-side panel, under Storage Repositories, click Details to identify the storage repository associated with the failed SSDs.
  • Page 98 If you downloaded your license file to your local computer by accessing the licensing portal, you must upload the license to the appliance. To upload license, click System > Licenses. Select from options under the Update Licenses section to upload a license. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.101...
  • Page 99: Managing Interfaces

    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) https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.102...
  • Page 100 Table 1. Example of Base MAC Addresses Generated f rom a Global Base MAC Address Physical Interf ace Base MAC Address 00:00:00:00:00:00 00:00:00:00:00:08 00:00:00:00:00:10 00:00:00:00:00:18 00:00:00:00:00:20 00:00:00:00:00:28 00:00:00:00:00:30 00:00:00:00:00:38 00:00:00:00:00:40 00:00:00:00:00:48 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.103...
  • Page 101 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 Configure Interface window. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.104...
  • Page 102 All other network devices, including CL1, S1, S2, in this setup example are also configured for supporting jumbo frames. T he following table lists the settings used in the example. Entity Name Details https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.105...
  • Page 103 MT U (9000) of interface 10/1. 4. NS1 reassembles these IP fragments to form the 27000-byte SIP request. NS1 processes this request. 5. LBVS-1's load balancing algorithm selects server S1. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.106...
  • Page 104 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> https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.107...
  • Page 105 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.108...
  • Page 106 Services on NS1 representing servers SVC-S1 IP address: 198.51.100.19 Protocol: HT T P Port: 80 MSS: 8960 SVC- IP address: 198.51.100.20 Protocol: HT T P Port: 80 MSS: 8960 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.109...
  • Page 107 Set the following MT U values: For 10/1 interface as 1500 For 10/2 interface as 9000 Log on to NetScaler instance and use the NetScaler command line interface to complete the remaining configuration https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.110...
  • Page 108 <name> Bind the custom T CP profile to the desired set service <Name> - set service SVC-S1 -tcpProfileName services. tcpProfileName <string> NS1- SERVERS-JUMBO show service <name> set service SVC-S2 -tcpProfileName https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.111...
  • Page 109 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.112...
  • Page 110 192.0.2.20 IP address of servers 198.51.100.19 198.51.100.20 198.51.101.19 198.51.101.20 SNIP addresses on NS1 198.51.100.18 198.51.101.18 MT U specified for interfaces and VLANs on 10/1 9216 10/2 9216 VLAN 10 9000 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.113...
  • Page 111 IP address = 203.0.113.15 Protocol: HT T P Port:80 Bound services: SVC-S1, SVC-S2 T CP profile: ALL-JUMBO (MSS: 8960) LBVS-2 IP address = 203.0.114.15 Protocol: HT T P Port:80 Bound services: SVC-S3, SVC-S4 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.114...
  • Page 112 On the NetScaler SDX Management Service, navigate to Configuration > System > Interfaces page. Select the required interface and click Edit. Set the MT U value and click OK. Example: Set the following MT U values: For 10/1 interface as 9216 For 10/2 interface as 9216 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.115...
  • Page 113 198.51.101.19 http 80 add service SVC-S4 198.51.101.20 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.116...
  • Page 114 <string> tcpProfileName ALL-JUMBO show service <name> set service SVC-S1 - tcpProfileName ALL-JUMBO set service SVC-S2 - tcpProfileName ALL-JUMBO Save the configuration save ns config show ns config https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.117...
  • Page 115 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.118...
  • Page 116: Downloading Mib Files

    SNMPv2. However, SNMPv3 enhances the basic architecture to incorporate administration and security capabilities, such as authentication, access control, data integrity check, data origin verification, message timeliness check, and data confidentiality. T he Citrix NetScaler SDX appliance supports the following entities that enable you to implement the security features of SNMPv3: https://docs.citrix.com ©...
  • Page 117 A, in an SNMPv3 view and you want to exclude a specific subtree of A, such as B, from the SNMPv3 view. Configuring an SNMP User https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.120...
  • Page 118: To Configure A User

    Warning severity level. You can also configure an SNMP alarm to log the corresponding trap messages generated whenever the condition on that alarm is met. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.121...
  • Page 119 To modify a predefined SNMP alarm, click System > SNMP > Alarms. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.122...
  • Page 120 1. Navigate to System > Notifications > Syslog Servers. 2. In the details pane, click Syslog Parameters. 3. In the Configure Syslog Parameterspage, specify the date and time format. 4. Click OK, and then click Close. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.123...
  • Page 121 3. In the Create Email Distribution Listpage, specify values for the mail profile parameters. For a description of a parameter, hover the mouse over the corresponding field. 4. Click Create, and then click Close. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.124...
  • Page 122 3. In the Create SMS Distribution List page, specify values for the mail profile parameters. For a description of a parameter, hover the mouse over the corresponding field. 4. Click Create, and then click Close. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.125...
  • Page 123 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.126...
  • Page 124 T o view the status of virtual servers 1. On the Configuration tab, in the navigation pane, click NetScaler > Entities > Service. 2. In the details pane, under Services, view the following statistics: https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.127...
  • Page 125 State— Effective state of the service group, which is based on the state of the member of the service group. For example, UP, DOWN, or OUT OF SERVICE. Last State Change— Elapsed time (in days, hours, minutes, and seconds) since the last change in the state of the https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.128...
  • Page 126: Configuring The 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.129...
  • Page 127 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.130...
  • Page 128 T his report is a bar chart that displays the top 10 NetScaler instances according to the number of entity state changes for the selected time scale. T he entity state changes reflect entity up, entity down, or out of service events. Top 10 NetScaler Instances by Threshold Violation Events https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.131...
  • Page 129 You can click on the chart to drill down and view the user based configuration changes for a particular instance. You can further view the authorization and execution status details by clicking on this chart. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.132...
  • Page 130 filter criteria in the rule, the action associated with the rule is executed. T he conditions for which you can create filters are: severity, devices, failure objects, and category. You can assign the following actions to the events: https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.133...
  • Page 131 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.134...
  • Page 132 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.135...
  • Page 133 Call Home feature on NetScaler instances from the Management Service user interface. 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.
  • Page 134 T o poll the Call Home feature from all NetScaler instances and view the current status, navigate to Configuration > NetScaler > Call Home, and click Poll Now button. On the confirmation page, click Yes. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.137...
  • Page 135: System Health Monitoring

    For disks (Disk), the following details are displayed: Name Name of the physical disk. Size Size of the disk, in gigabytes (GB). Utilized Amount of data on the disk, in gigabytes (GB). https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.138...
  • Page 136 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. Temperature information includes the following details: Name https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.139...
  • Page 137 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.140...
  • Page 138 Number of errors in transmitting data since the appliance was last started. Rx Errors Number of errors in receiving data since the appliance was last started. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.141...
  • Page 139 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.142...
  • Page 140 Remove. T he Storage Repository tab displays the following information about each storage repository: Name— Name of the storage repository drive. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.143...
  • Page 141 5. Physically remove the defective drive from the slot. 6. Insert the new Citrix verified SSD in the slot from where you removed the defective SSD. 7. In the Management Service, nagivate to Conf iguration > System > RAID. T he new SSD is listed in the Physical Drives section.
  • Page 142 Failed T he logical drive has failed. Active T he logical drive is fully active, disk I/O and/or resync can be happening. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.145...
  • Page 143 Slot - Physical slot associated with the physical drive. State - Indicates if a physical drive is present on the appliance. Present - Physical drive is present on the appliance. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.146...
  • Page 144 4. Physically remove the defective drive from the slot. 5. Insert the new Citrix certified SSD in the slot from where you removed the defective SSD. 6. On the Physical Drives tab, click the refresh icon to refresh the list of physical drives. T he state of the drive should now appear as Present.
  • Page 145 If both the SSDs that form a RAID1 pair fail, you must first delete the NetScaler VPX instances hosted on the storage repository associated with the failed SSDs, delete the logical drive, replace both the failed SSDs with new Citrix certified SSDs, and create the logical drive again.
  • Page 146: Configuring Policies

    T he backup policy runs at 00:30 A.M. every day and creates a backup of logs and configuration files. By default, the policy retains three backups, but you can specify the number of backups you want to keep. To specify the number of days for which logged data is pruned https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.149...
  • Page 147 Generating a Tar Archive f or Technical Support 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 file to your local system and send it to Citrix technical support.
  • Page 148 Log on by using the administrator credentials. You can access detailed information about command usage and syntax from the man pages. Note: CLI is not supported over console access. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.151...
  • Page 149 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.152...
  • Page 150: Configuring User Accounts

    1. On the Configuration tab, in the navigation pane, expand System, expand Administration, and then click Users. 2. In the Users pane, select the user account, and then click Delete. 3. In the Confirm message box, click OK. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.153...
  • Page 151 1. On the Conf iguration tab, click System. 2. In the System Settings group, click Change System Settings. 3. In the Conf igure System Settings dialog box, clear the Allow Basic Authentication check box. 4. Click OK. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.154...
  • Page 152 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.155...
  • Page 153 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.156...
  • Page 154 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.157...
  • Page 155 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.158...
  • Page 156 Alias Name— Alias name for the LA channel. Used only to enhance readability. T o perform any operations, you have to specify the LA channel ID. 6. Click Create, and then click Close. To configure LACP by logging on to the instance, see Configuring LACP on a NetScaler VPX Instance. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.159...
  • Page 157 To restore the configuration data on an SDX appliance, the Management Service selects the latest NetScaler .XVA image to provision the NetScaler instances. Citrix recommends that you store only the version of the NetScaler .XVA image that you require to reprovision the NetScaler instances. If you store multiple .XVA images, the Management Service might provision a NetScaler instance by using an image that is different from the one that you require.
  • Page 158 Restore Appliance— Restores the XenServer, Management Service, and all the NetScaler instances. Note: Perform a Factory Reset before selecting this option. Select the check box next to the instance(s) to restore the NetScaler instance(s). 4. Click OK. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.161...
  • Page 159 NetScaler instances provisioned on the appliance. Citrix recommends that you store the files 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 configuration tasks.
  • Page 160 Password*— T he password used to log on to the NetScaler instance. Maximum length: 31 characters. Confirm Password*— T he password used to log on to the NetScaler instance. * A required parameter https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.163...
  • Page 161 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.
  • Page 162 Note: For a high availability setup (active-active or active-standby), Citrix recommends that you configure 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.
  • Page 163 T he IPv6 VRID that identifies the VMAC. Possible values: 1 to 255. For more information, see Configuring VMACs on an Interface. MAC Address Mode Assign a MAC address. Select from one of the following options: Default— XenServer assigns a MAC address. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.166...
  • Page 164 VLAN ID, so that one company does not see the other company's traffic. If an instance administrator, while provisioning or modifying a VPX instance, tries to assign an interface to an 802.1Q VLAN, a https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.167...
  • Page 165 IPv6 dynamic routing protocols from the VT YSH command line. 5. Select the interfaces that should be part of the VLAN. 6. Click Create, and then click Close. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.168...
  • Page 166 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 Configuration > https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.169...
  • Page 167 You can check individual VPX’s throughput and data consumption statistics in graphs. T hese graphs are accessible from the Configuration > NetScaler > Instances page. Select a VPX and then click on the Action drop list. From the list select either https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.170...
  • Page 168 T he following illustration shows a sample graph of throughput data for 1 week: https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.171...
  • Page 169 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.
  • Page 170 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.173...
  • Page 171: Saving The Configuration

    2. In the details pane, under NetScaler Configuration, click Save Configuration. 3. In the Save Configuration dialog box, in Instance IP Address, select the IP addresses of the NetScaler instances whose configuration you want to save. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.174...
  • Page 172 To apply the admin configuration on a NetScaler instance 1. On the Configuration tab, in the navigation pane, click NetScaler. 2. In the details pane, under NetScaler Configuration, click Apply Admin Configuration. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.175...
  • Page 173 3. In the Apply Admin Configuration dialog box, in Instance IP Address, select the IP address of the NetScaler VPX instance on which you want to apply the admin configuration. 4. Click OK. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.176...
  • Page 174 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.177...
  • Page 175 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.178...
  • Page 176 2. In the SSL Certificates pane, click Poll Now. 3. In the Confirm dialog box, click Yes. T he SSL Certificates pane is refreshed and new certificates, if any, appear in the list. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.179...
  • Page 177 T agged. Note: Citrix recommends that you select Tagged for all interfaces assigned to instances in L2 mode. Note that if you select tagged, you cannot receive untagged packets on that interface. If you have selected Tagged for an interface assigned to an instance, log on to that instance and configure a 802.1q VLAN to receive packets on that interface.
  • Page 178 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.181...
  • Page 179 4. In the Add T emplate dialog box, add a name and description for the template. 5. In the Command text box, paste the list of commands that you copied from the configuration file 6. Click Create, and then click Close. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.182...
  • Page 180 T he netmask IP address of the NetScaler instance. Gateway T he IP address of the default gateway, the router that forwards traffic outside of the subnet in which the instance is https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.183...
  • Page 181 3. T o view the running configuration, click Running Configuration, and to view the saved configuration, click Saved Configuration. 4. In the NetScaler Running Config window or the NetScaler Saved Config window, you can view the running or saved https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.184...
  • Page 182 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 rediscover, and then click Rediscover. 3. In the Confirm message box, click Yes. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.185...
  • Page 183: Operation

    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. Pagination is supported in the Task Log pane. Select the number of records to display on a page. By default, 25 records are displayed on a page. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.186...
  • Page 184 To view the events 1. On the Monitoring tab, in the left pane, expand Monitoring, and then click Events. 2. In the Events pane, you can view the following details. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.187...
  • Page 185 T he category of event, such as PolicyFailed and DeviceConfigChange. Message T he message describing the event. 3. T o sort the events by a particular field, click the heading of the column. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.188...
  • Page 186 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.189...
  • Page 187 T he following table lists the names and values of the parameters used for provisioning NetScaler Instance 1 in the above example. Parameter Name Values f or Instance 1 Name vpx8 IP Address 10.1.1.2 Netmask 255.255.255.0 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.190...
  • Page 188 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.191...
  • Page 189 T he following table lists the names and values of the parameters used for provisioning NetScaler Instance 1 in this example. Parameter Name Values f or Instance 1 Name vpx1 IP Address 10.1.2.2 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.192...
  • Page 190 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.193...
  • Page 191 Management Service, the traffic between the Management Service and NetScaler instances does not have to be routed, unless your setup explicitly requires it. Note: T agging is supported in XenServer version 6.0. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.194...
  • Page 192 Values f or Instance 5 Values f or Instance 3 Name vpx5 vpx3 IP Address 10.1.3.2 10.1.200.2 Netmask 255.255.255.0 255.255.255.240 Gateway 10.1.3.1 10.1.200.1 XVA File NS-VPX-XEN-10.0-51.308.a_nc.xva NS-VPX-XEN-10.0-51.308.a_nc.xva Feature License Platinum Platinum https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.195...
  • Page 193 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.196...
  • Page 194 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.197...
  • Page 195 Shell/Sftp/Scp Access True True Total Memory (MB) 2048 2048 #SSL Chips T hroughput (Mbps) 1000 1000 Packets per second 1000000 1000000 Shared Shared Interface 1/1 and 1/7 1/1 and 1/7 NSVLAN https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.198...
  • Page 196 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.199...
  • Page 197 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.
  • Page 198 Modify. In the Modify SECUREMAT RIX GSB wizard, modify the parameters. Note: If you modify any of the interface parameters or the name of the instance, the instance stops and restarts to put https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.201...
  • Page 199 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.202...
  • Page 200 Management Service fetches the configuration 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. On the Configuration tab, expand SECUREMAT RIX GSB. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.203...
  • Page 201 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.204...
  • Page 202 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.205...
  • Page 203 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.206...
  • Page 204 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.207...
  • Page 205 2. In the details pane, select the instance for which you want to trace the route, and from the Action list, click T raceRoute. T he T raceroute message box displays the route to the instance. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.208...
  • Page 206 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.209...
  • Page 207 Jan 31, 20 11 BlueCat DNS/DHCP Server™ is a software solution that can be hosted on the Citrix NetScaler SDX platform to deliver reliable, scalable and secure DNS and DHCP core network services without requiring additional management costs or data center space.
  • Page 208 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.211...
  • Page 209 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.212...
  • Page 210 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. Monitoring a CA Access Gateway Instance https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.213...
  • Page 211 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.214...
  • Page 212 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.
  • Page 213 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.216...
  • Page 214 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.217...
  • Page 215 NITRO API Jun 0 3, 20 14 T he Citrix NetScaler SDX NIT RO protocol allows you to configure and monitor the NetScaler SDX appliance programmatically. NIT RO exposes its functionality through Representational State Transfer (REST ) interfaces. T herefore, NIT RO applications can be developed in any programming language.
  • Page 216 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 file. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.219...
  • Page 217 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.220...
  • Page 218 T he NIT RO protocol can be used to configure resources of the NetScaler SDX appliance. T he APIs to configure a resource are grouped into packages or namespaces that have the format com.citrix.sdx.nitro.resource.config.<resource_type>. Each of these packages or namespaces contain a class named <resource_type> that provides the APIs to configure the resource.
  • Page 219 //Extract the properties of the resource from the object System.out.println(returned_ns[i].get_ip_address()); System.out.println(returned_ns[i].get_netmask()); Retrieving Resource Statistics A NetScaler SDX appliance collects statistics on the usage of its features. You can retrieve these statistics using NIT RO. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.222...
  • Page 220 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. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.223...
  • Page 221: Exception Handling

    T he error message field 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.
  • Page 222 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 this documentation are only applicable if the content type is of the form 'application/vnd.com.citrix.sdx.login+json'. Payload "login":...
  • Page 223: Configuration Apis

    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 specific resource object. For example, to create a NetScaler instance named vpx1: URL. https://10.102.31.16/nitro/v2/config/ns/ HTTP Method. POST Request. Header https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.226...
  • Page 224 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. T he URL has the form: http://<IP>/nitro/v2/config/<resource_type>?pageno=<value>&pagesize=<value>. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.227...
  • Page 225 You can query or change multiple resources simultaneously and thus minimize network traffic. For example, you can add multiple NetScaler appliances in the same operation. You can also add resources of different types in one request. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.228...
  • Page 226 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/ HTTP Method. POST Request Payload. Header Cookie:NITRO_AUTH_TOKEN=tokenvalue Content-Type:application/vnd.com.citrix.sdx.ns+json X-NITRO-ONERROR:continue Payload "ns": https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.229...
  • Page 227 An errorcode of 0 indicates that the operation is successful. A non-zero errorcode indicates an error in processing the NIT RO request. T he error message field provides a brief explanation and the nature of the failure. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.230...
  • Page 228 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...
  • Page 229 You can convert a NetScaler MPX appliance to a NetScaler SDX appliance by upgrading the software through a new Solid State Drive (SSD) and a new Hard Disk Drive (HDD). Citrix supplies a field conversion kit to migrate a NetScaler MPX appliance to a NetScaler SDX appliance.
  • Page 230 2. Run the following command from the command line interface of the appliance to display the serial number: show hardware T he serial number might be helpful in the event that you want to contact Citrix Technical Support. Example > show hardware...
  • Page 231 System Health Statistics(Auxiliary): Voltage 0 (Volts) 0.00 Voltage 1 (Volts) 0.00 Voltage 2 (Volts) 0.00 Voltage 3 (Volts) 0.00 Voltage 4 (Volts) 1.50 Voltage 5 (Volts) 0.00 Voltage 6 (Volts) 0.00 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.234...
  • Page 232 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.
  • Page 233 12. Run the following command to execute the ns_hw_err.bash script, which checks for latent hardware errors: root@ns# /netscaler/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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.236...
  • Page 234 Are you sure you want to completely stop NetScaler (Y/N)? [N]:y To upgrade the appliance 1. Locate the solid-state drive on the back panel of the appliance, as shown in the following figure: https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.237...
  • Page 235 2. Verify that the replacement solid-state drive (SSD) 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.
  • Page 236 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.239...
  • Page 237 You are now ready to provision the VPX instances on the NetScaler SDX appliance. For instructions, see Provisioning NetScaler Instances . https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.240...
  • Page 238 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.241...
  • Page 239 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.
  • Page 240 23. Close the handle flush with the rear side of the appliance so that the solid-state drive locks securely into the slot. Important: T he orientation of the solid-state drive is important. Make sure that the Citrix product label is facing up when you insert the drive.
  • Page 241 You can convert a NetScaler MPX appliance to a NetScaler SDX appliance by upgrading the software through a new Solid State Drive (SSD). Citrix supplies a field conversion kit to migrate a NetScaler MPX appliance to a NetScaler SDX appliance.
  • Page 242 T he serial number might be helpful in the event that you want to contact Citrix Technical Support. Example > show hardware Platform: NSMPX-14000 12*CPU+16*IX+2*E1K+2*CVM N3 250101 Manufactured on: 10/2/2015 CPU: 2600MHZ Host Id: 234913926 Serial no: JSW4UCKKM5 Encoded serial no: JSW4UCKKM5 Done >...
  • Page 243 (AP): APIC ID: 40 cpu11 (AP): APIC ID: 42 cpu0: <ACPI CPU> on acpi0 acpi_throttle0: <ACPI CPU T hrottling> on cpu0 cpu1: <ACPI CPU> on acpi0 acpi_throttle1: <ACPI CPU T hrottling> on cpu1 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.246...
  • Page 244 NetScaler NS10.1: Build 133.11.nc, Date: Sep 21 2015, 17:59:51 platform: serial JSW4UCKKM5 platform: sysid 250101 - NSMPX-14000 12*CPU+16*IX+2*E1K+2*CVM N3 HDD MODEL: ar0: 227328MB <Intel MatrixRAID RAID1> status: READY https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.247...
  • Page 245 1. Power off the NetScaler appliance. 2. Locate two solid-state drives (SSDs) on the back of the appliance in slot #1 and slot #2, as shown in the following figure: https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.248...
  • Page 246 3. Verify that the replacement solid-state drives (SSDs) are the ones required for your NetScaler model. T he conversion requires minimum of four SSDs. T he Citrix label is on the top of one of the solid-state drives, which is pre-populated with a new version of BIOS and a recent build of the required NetScaler SDX Management Service.
  • Page 247 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.250...
  • Page 248 Navigate to Configuration > System and, in the System Administration group, click Reboot Appliance. Click Yes to confirm. You are now ready to provision the VPX instances on the NetScaler SDX appliance. For instructions, Provisioning NetScaler Instances. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.251...
  • Page 249 You can convert a NetScaler MPX appliance to a NetScaler SDX appliance by upgrading the software through a new Solid State Drive (SSD). Citrix supplies a field conversion kit to migrate a NetScaler MPX appliance to a NetScaler SDX appliance.
  • Page 250 2. Run the following command from the command line interface of the appliance to display the serial number: show hardware T he serial number might be helpful in the event that you want to contact Citrix Technical Support. 3. Run the following command to display the status of the active 10G interfaces: show interface 4.
  • Page 251 3. Verify that the replacement solid-state drives (SSDs) are the ones required for your NetScaler model. T he conversion requires minimum of four SSDs. T he Citrix label is on the top of one of the solid-state drives, which is pre- populated with a new version of BIOS and a recent build of the required NetScaler SDX Management Service.
  • Page 252 You can convert a NetScaler MPX appliance to a NetScaler SDX appliance by upgrading the software through a new Solid State Drive (SSD). Citrix supplies a field conversion kit to migrate a NetScaler MPX appliance to a NetScaler SDX appliance.
  • Page 253 Encoded serial no: KZCHGCN810 Done > T he serial number might be helpful in the event that you want to contact Citrix Technical Support. 3. Run the following command to display the status of the active interfaces: show interface Example >...
  • Page 254 T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) Bandwidth thresholds are not set. Interface 10/2 (10G Ethernet) #18 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.257...
  • Page 255 Interface 10/4 (10G Ethernet) #20 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> MT U=1500, native vlan=1, MAC=68:05:ca:30:e1:43, downtime 44h00m08s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.258...
  • Page 256 Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE RX: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.259...
  • Page 257 T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) Bandwidth thresholds are not set. Interface 10/9 (10G Ethernet) #0 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.260...
  • Page 258 Interface 10/11 (10G Ethernet) #2 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> MT U=1500, native vlan=1, MAC=68:05:ca:30:e1:a2, downtime 44h00m08s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.261...
  • Page 259 Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE RX: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.262...
  • Page 260 T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) Bandwidth thresholds are not set. Interface 10/16 (10G Ethernet) #7 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.263...
  • Page 261 Interface 40/2 (40G Ethernet) #21 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> MT U=1500, native vlan=1, MAC=3c:fd:fe:9c:fa:68, downtime 44h00m15s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.264...
  • Page 262 Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE RX: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.265...
  • Page 263 5. Run the following command for each of the interfaces that are not in the UP/UP state: * enable interface 10/x * enable interface 40/x where x is the new interface number. Example > enable interface 10/1 Done > enable interface 40/1 Done > https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.266...
  • Page 264 0.00 CPU Fan 0 Speed (RPM) 4650 CPU Fan 1 Speed (RPM) 4575 System Fan Speed (RPM) 4650 System Fan 1 Speed (RPM) 4650 System Fan 2 Speed (RPM) 4650 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.267...
  • Page 265 1.49 Voltage 2 (Volts) 1.50 Voltage 3 (Volts) 1.49 Voltage 4 (Volts) 1.49 Voltage 5 (Volts) 0.00 Voltage 6 (Volts) 0.00 Voltage 7 (Volts) 0.00 Fan 0 Speed (RPM) 4650 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.268...
  • Page 266 Copying WebInterface configuration files (if WI is installed) ..WI is not installed on this system. Nothing to copy. Running shell commands ..Running CLI show commands ..Running CLI stat commands ..Running vtysh commands ..https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.269...
  • Page 267 Created a symbolic link for the archive with /var/tmp/support/support.tgz /var/tmp/support/support.tgz ---- points to ---> /var/tmp/support/collector_P_192.168.100.1_23Mar2016_10_00.tar.gz If this node is part of HA pair, please run it on the other node also!! Done > https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.270...
  • Page 268 0xde200000-0xde2fffff irq 32 at device 0.0 on pci3 cavium0: [IT HREAD] Cavium cavium_probe : found card 0x177d,device=0x11 cavium1 mem 0xfb400000-0xfb4fffff irq 64 at device 0.0 on pci136 cavium1: [IT HREAD] root@ns# https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.271...
  • Page 269 (AP): APIC ID: 34 cpu8 (AP): APIC ID: 36 cpu9 (AP): APIC ID: 38 cpu10 (AP): APIC ID: 40 cpu11 (AP): APIC ID: 42 cpu0: <ACPI CPU> on acpi0 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.272...
  • Page 270 <CPU Frequency T hermal Control> on cpu6 est7: <Enhanced SpeedStep Frequency Control> on cpu7 p4tcc7: <CPU Frequency T hermal Control> on cpu7 est8: <Enhanced SpeedStep Frequency Control> on cpu8 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.273...
  • Page 271 <ACPI CPU> on acpi0 cpu3: <ACPI CPU> on acpi0 cpu4: <ACPI CPU> on acpi0 cpu5: <ACPI CPU> on acpi0 cpu6: <ACPI CPU> on acpi0 cpu7: <ACPI CPU> on acpi0 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.274...
  • Page 272 <Enhanced SpeedStep Frequency Control> on cpu10 p4tcc10: <CPU Frequency T hermal Control> on cpu10 est11: <Enhanced SpeedStep Frequency Control> on cpu11 p4tcc11: <CPU Frequency T hermal Control> on cpu11 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.275...
  • Page 273 Generating the events from newnslog files... Checking for HDD errors... Checking for HDD SMART errors... Checking for Flash errors... /var/nslog/dmesg.boot:* DEVELOPER mode - run NetScaler manually! * /var/tmp/ns_hw_tmp_10831//dmesg-a.out:* DEVELOPER mode - run NetScaler manually! * https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.276...
  • Page 274 Done 16. Run the following command to shut down the appliance. You will be asked if you want to completely stop the NetScaler. Type: shutdown -p now https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.277...
  • Page 275 3. Verify that the replacement solid-state drives (SSDs) are the ones required for your NetScaler model. T he conversion requires minimum of four SSDs. T he Citrix label is on the top of one of the solid-state drives, which is pre-populated with a new version of BIOS and a recent build of the required NetScaler SDX Management Service.
  • Page 276 1. Select the Configuration tab. 2. Verify that the System Resource section displays the accurate number of CPU cores, SSL cores, and the total memory for your NetScaler SDX appliance. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.279...
  • Page 277 8. Navigate to Configuration > System and, in the System Administration group, click Reboot Appliance. Click Yes to confirm. You are now ready to provision the VPX instances on the NetScaler SDX appliance. For instructions, Provisioning NetScaler Instances. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.280...
  • Page 278 You can convert a NetScaler MPX appliance to a NetScaler SDX appliance by upgrading the software through a new Solid State Drive (SSD). Citrix supplies a field conversion kit to migrate a NetScaler MPX appliance to a NetScaler SDX appliance.
  • Page 279 T he serial number might be helpful in the event that you want to contact Citrix Technical Support. Example > show hardware Platform: NSMPX-25000 20*CPU+16*F1X+4*F4X+2*E1K+2*CVM N3 250040 Manufactured on: 3/21/2016 CPU: 2800MHZ Host Id: 234913926 Serial no: 9AEXPCN859 Encoded serial no: 9AEXPCN859 Done 3.
  • Page 280 T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) Bandwidth thresholds are not set. Interface 10/2 (10G Ethernet) #18 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.283...
  • Page 281 Interface 10/4 (10G Ethernet) #20 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> MT U=1500, native vlan=1, MAC=00:e0:ed:2b:c6:d7, downtime 42h57m21s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.284...
  • Page 282 Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE RX: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.285...
  • Page 283 T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) Bandwidth thresholds are not set. Interface 10/9 (10G Ethernet) #0 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.286...
  • Page 284 Interface 10/11 (10G Ethernet) #2 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> MT U=1500, native vlan=1, MAC=00:e0:ed:2b:c6:ea, downtime 42h57m28s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.287...
  • Page 285 Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE RX: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.288...
  • Page 286 T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) Bandwidth thresholds are not set. Interface 10/16 (10G Ethernet) #7 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.289...
  • Page 287 Interface 40/2 (40G Ethernet) #21 flags=0x4000 <ENABLED, DOWN, down, autoneg, HAMON, 802.1q> MT U=1500, native vlan=1, MAC=00:e0:ed:2b:c8:6c, downtime 42h57m28s Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.290...
  • Page 288 Requested: media AUTO, speed AUTO, duplex AUTO, fctl OFF, throughput 0 LLDP Mode: NONE RX: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) T X: Pkts(0) Bytes(0) Errs(0) Drops(0) Stalls(0) NIC: InDisc(0) OutDisc(0) Fctls(0) Stalls(0) Hangs(0) Muted(0) https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.291...
  • Page 289 5. Run the following command for each of the interfaces that are not in the UP/UP state: enable interface 10/x enable interface 40/x where x is the new interface number. Example > enable interface 10/1 Done > enable interface 40/1 Done > https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.292...
  • Page 290 5V Standby Voltage(Volts) 0.00 Voltage Sensor2(Volts) 0.00 CPU Fan 0 Speed (RPM) 3675 CPU Fan 1 Speed (RPM) 3750 System Fan Speed (RPM) 3750 System Fan 1 Speed (RPM) 3675 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.293...
  • Page 291 Voltage 0 (Volts) 1.49 Voltage 1 (Volts) 1.49 Voltage 2 (Volts) 1.49 Voltage 3 (Volts) 1.49 Voltage 4 (Volts) 1.49 Voltage 5 (Volts) 0.00 Voltage 6 (Volts) 0.00 Voltage 7 (Volts) 0.00 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.294...
  • Page 292 Copying WebInterface configuration files (if WI is installed) ..WI is not installed on this system. Nothing to copy. Running shell commands ..Running CLI show commands ..Running CLI stat commands ..https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.295...
  • Page 293 Created a symbolic link for the archive with /var/tmp/support/support.tgz /var/tmp/support/support.tgz ---- points to ---> /var/tmp/support/collector_P_192.168.100.1_23Mar2016_14_39.tar.gz If this node is part of HA pair, please run it on the other node also!! Done > https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.296...
  • Page 294 0xde200000-0xde2fffff irq 32 at device 0.0 on pci3 cavium0: [IT HREAD] Cavium cavium_probe : found card 0x177d,device=0x11 cavium1 mem 0xfb400000-0xfb4fffff irq 64 at device 0.0 on pci136 cavium1: [IT HREAD] root@ns# https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.297...
  • Page 295 (AP): APIC ID: 16 cpu6 (AP): APIC ID: 18 cpu7 (AP): APIC ID: 20 cpu8 (AP): APIC ID: 22 cpu9 (AP): APIC ID: 24 cpu10 (AP): APIC ID: 32 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.298...
  • Page 296 <ACPI CPU> on acpi0 cpu14: <ACPI CPU> on acpi0 cpu15: <ACPI CPU> on acpi0 cpu16: <ACPI CPU> on acpi0 cpu17: <ACPI CPU> on acpi0 cpu18: <ACPI CPU> on acpi0 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.299...
  • Page 297 <CPU Frequency T hermal Control> on cpu11 est12: <Enhanced SpeedStep Frequency Control> on cpu12 p4tcc12: <CPU Frequency T hermal Control> on cpu12 est13: <Enhanced SpeedStep Frequency Control> on cpu13 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.300...
  • Page 298 (AP): APIC ID: 22 cpu9 (AP): APIC ID: 24 cpu10 (AP): APIC ID: 32 cpu11 (AP): APIC ID: 34 cpu12 (AP): APIC ID: 36 cpu13 (AP): APIC ID: 38 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.301...
  • Page 299 <ACPI CPU> on acpi0 cpu18: <ACPI CPU> on acpi0 cpu19: <ACPI CPU> on acpi0 est0: <Enhanced SpeedStep Frequency Control> on cpu0 p4tcc0: <CPU Frequency T hermal Control> on cpu0 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.302...
  • Page 300 <Enhanced SpeedStep Frequency Control> on cpu13 p4tcc13: <CPU Frequency T hermal Control> on cpu13 est14: <Enhanced SpeedStep Frequency Control> on cpu14 p4tcc14: <CPU Frequency T hermal Control> on cpu14 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.303...
  • Page 301 16G 185M /flash /dev/ar0s1e 194G 964M 178G /var root@ns# 13.Run the following command to execute the ns_hw_err.bash script, which checks for latent hardware errors: root@ns# ns_hw_err.bash Example root@ns# root@ns# ns_hw_err.bash https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.304...
  • Page 302 /var/tmp/ns_hw_tmp_10603//dmesg-a.out:* DEVELOPER mode - run NetScaler manually! * ****************************************** FOUND 2 Flash errors: DEVELOPER mode - run NetScaler manually ****************************************** Checking for Mega Raid Controller errors... Checking for SSL errors... Checking for BIOS errors... https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.305...
  • Page 303 16. Run the following command to shut down the appliance. You will be asked if you want to completely stop the NetScaler. Type: shutdown -p now Example root@ns# root@ns# exit logout https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.306...
  • Page 304 3. Verify that the replacement solid-state drives (SSDs) are the ones required for your NetScaler model. T he conversion requires minimum of four SSDs. T he Citrix label is on the top of one of the solid-state drives, which is pre-populated with a new version of BIOS and a recent build of the required NetScaler SDX Management Service.
  • Page 305 3. Select the System node and, under Set Up Appliance, click Network Configuration to modify network information of Management Service. 4. In the Modify Network Configuration dialog box, specify the following details: https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.308...
  • Page 306 8. Navigate to Configuration > System and, in the System Administration group, click Reboot Appliance. Click Yes to confirm. You are now ready to provision the VPX instances on the NetScaler SDX appliance. For instructions, Provisioning NetScaler Instances. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.309...
  • Page 307 T his section provides basic information about the SDX command line interface and commands to configure and retrieve details of the appliance. For details, see the following topics: System NetScaler XenServer https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.310...
  • Page 308 - SMS profile smsserver - SMS server properties smtpserver - SMT P server properties snmpalarm - SNMP Alarm Configurations snmpmanager - SNMP Agent Manager configuration snmptrap - SNMP Trap Destinations https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.311...
  • Page 309 - Technical Support timezone - Current timezone timezone_enum - T ime zones userlockoutpolicy - User Lockout Policy configuration vlandetails - VLAN details vlansummary - VLAN summary vmdevice - VM Device https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.312...
  • Page 310: Aaa Server

    Type of primary server. Support Types 1. LOCAL 2.RADIUS 3.LDAP 4.TACACS 5.KEYSTONE T his is a mandatory parameter. f allback_local_authentication Enable local fallback authentication primary_server_name Name of primary server name T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.313...
  • Page 311 File Name T op delete backupfile Synopsis delete backupfile file_name=<string> Description Use this operation to delete backup file Parameters f ile_name File Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.314...
  • Page 312 Use this operation to modify the number of previous backups to retain Parameters backup_to_retain Number of previous backups to retain T his is a mandatory parameter. policy_name Policy Name T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.315...
  • Page 313 Sep 10 , 20 14 Device Profile show deviceprofile Synopsis show deviceprofile [id=<string>] Description Use this operation to get device profiles Parameters Id is system generated key for all the device profiles T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.316...
  • Page 314 Description Use this operation to get the hostname T op set hostname Synopsis set hostname [hostname=<string>] Description Use this operation to modify hostname Parameters hostname Hostname T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.317...
  • Page 315: Ldap Server

    [port=<int>] [validate_ldap_server_certs=(false | true)] [ldap_host_name=<string>] [sec_type=<string>] [type=<string>] [subattribute_name=<string>] [change_password=(false | true)] [follow_referrals=(false | true)] [max_nesting_level=<int>] [group_search_filter=<string>] [group_attr_name=<string>] [max_ldap_referrals=<int>] [group_search_attribute=<string>] [group_search_subattribute=<string>] [auth_timeout=<int>] [nested_group_extraction=(false | true)] [group_name_identifier=<string>] [default_authentication_group=<string>] [bind_passwd=<stringx>] [bind_dn=<string>] [search_filter=<string>] [login_name=<string>] [base_dn=<string>] https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.318...
  • Page 316 Enable following LDAP referrals received from LDAP server max_nesting_level Number of levels at which group extraction is allowed group_search_f ilter String to be combined with the default LDAP group search string to form the search value https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.319...
  • Page 317 [port=<int>] [validate_ldap_server_certs=(false | true)] [ldap_host_name=<string>] [sec_type=<string>] [subattribute_name=<string>] [change_password=(false | true)] [follow_referrals=(false | true)] [max_nesting_level=<int>] [group_search_filter=<string>] [group_attr_name=<string>] [max_ldap_referrals=<int>] [group_search_attribute=<string>] [group_search_subattribute=<string>] [auth_timeout=<int>] [nested_group_extraction=(false | true)] [group_name_identifier=<string>] [default_authentication_group=<string>] [bind_passwd=<stringx>] [bind_dn=<string>] [search_filter=<string>] [login_name=<string>] [base_dn=<string>] https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.320...
  • Page 318 String to be combined with the default LDAP group search string to form the search value group_attr_name T he Attribute name for group extraction from the LDAP server https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.321...
  • Page 319 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 T he base or node where the ldapsearch should start T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.322...
  • Page 320 Description Use this operation to get SDX license information T op do license custom Synopsis do license custom Description Use this operation to apply new licenses files T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.323...
  • Page 321 File Name T op delete licensefile Synopsis delete licensefile file_name=<string> Description Use this operation to delete license file Parameters f ile_name File Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.324...
  • Page 322 Id is system generated key for all the mail profile. T his is a mandatory parameter. T op set mailprofile Synopsis set mailprofile id=<string> [to_list=<string>] [server_name=<internethost>] [cc_list=<string>] [profile_name=<string>] [bcc_list=<string>] [sender_mail_address=<string>] Description Use this operation to modify mail profile. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.325...
  • Page 323 List of to whom send the mail. T his is a mandatory parameter. server_name SMT P server name T his is a mandatory parameter. prof ile_name Profile name for the mail setting. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.326...
  • Page 324 T his is a mandatory parameter. cc_list List to whom CC the mail. bcc_list List to whom BCC the mail. sender_mail_address Email Address from where mail is send T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.327...
  • Page 325 Sep 10 , 20 14 Managed Device show manageddevice Synopsis show manageddevice [id=<string>] Description Use this operation to get managed devices Parameters Id is system generated key for all the managed devices T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.328...
  • Page 326 Sep 10 , 20 14 Health Monitoring Stats show managementservicestatistics Synopsis show managementservicestatistics [id=<string>] Description Use this operation to get health stats Parameters Id is system generated key T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.329...
  • Page 327: Network Config

    T his is a mandatory parameter. network_interf ace Interface on which management needs to be enabled T his is a mandatory parameter. svm_ip_address Management Service IP Address T his is a mandatory parameter. netmask https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.330...
  • Page 328 Netmask T his is a mandatory parameter. DNS Server T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.331...
  • Page 329 Sep 10 , 20 14 Network Pool show networkpool Synopsis show networkpool [id=<string>] Description Use this operation to get the network pool Parameters Id is system generated key for all the networks T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.332...
  • Page 330 List of Trusted Key Identifiers for Symmetric Key Cryptography automax_logsec Automax Interval (as power of 2 in seconds) authentication Authentication Enabled revoke_logsec Revoke Interval (as power of 2 in seconds) T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.333...
  • Page 331: Ntp Server

    NT P T ime Server Address T op set ntpserver Synopsis set ntpserver [minpoll=<int>] [preferred_server=(false | true)] [server=<internethost>] [autokey=(false | true)] [key_id=<int>] [maxpoll=<int>] [client=<string>] Description Use this operation to modify NT P Server Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.334...
  • Page 332 Parameters server NT P T ime Server Address T his is a mandatory parameter. minpoll Minimum Poll Interval pref erred_server NT P Server Preferred autokey Autokey Public Key Authentication key_id https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.335...
  • Page 333 Key Identifier for Symmetric Key Authentication maxpoll Maximum Poll Interval client Sender of request, whether from Setup Wizard or direct NT P configuration T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.336...
  • Page 334 Use this operation to get status of ntpd T op set ntpsync Synopsis set ntpsync [ntpd_status=(false | true)] Description Use this operation to enable/disable ntpd Parameters ntpd_status ntpd status T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.337...
  • Page 335: Show Passwordpolicy

    Synopsis set passwordpolicy [enable_password_complexity=(false | true)] [minimum_password_length=<int>] Description Use this operation to modify Password Policy details Parameters enable_password_complexity Enable user Password complexity minimum_password_length Minimum password length T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.338...
  • Page 336 Use this operation to modify the number of days data to retain Parameters data_to_keep_in_days Number of days data to retain T his is a mandatory parameter. policy_name Policy Name T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.339...
  • Page 337: Radius Server

    Synopsis set radiusserver id=<string> ip_address=<ipaddress> name=<string> [port=<int>] [ip_vendor_id=<int>] [ip_attribute_type= <int>] [nas_id=<string>] [auth_timeout=<int>] [pwd_attribute_type=<int>] [accounting=(false | true)] [group_vendor_id= <int>] [group_attribute_type=<int>] [pwd_vendor_id=<int>] [default_authentication_group=<string>] [group_separator= <string>] [pass_encoding=<string>] [radius_key=<stringx>] [enable_nas_ip=(false | true)] [groups_prefix=<string>] Description https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.340...
  • Page 338 Vendor ID for RADIUS group extraction group_attribute_type Attribute type for RADIUS group extraction pwd_vendor_id Vendor ID of the password in the RADIUS response. Used to extract the user password def ault_authentication_group https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.341...
  • Page 339: Add Radiusserver

    T his is a mandatory parameter. name Name of radius server T his is a mandatory parameter. radius_key Key of radius server T his is a mandatory parameter. port Port number of radius server https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.342...
  • Page 340 Enable password encoding in RADIUS packets send to the RADIUS server enable_nas_ip Enable NAS IP extraction groups_pref ix Prefix string that precedes group names within a RADIUS attribute for RADIUS group extraction T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.343...
  • Page 341 [device_ipaddress=<ipaddress>] Description Use this operation to start inventory of a given device. All devices if device IP Address is not specified. Parameters device_ipaddress Device IP Address T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.344...
  • Page 342 Id is system generated key for all the sms profile. T his is a mandatory parameter. T op set smsprofile Synopsis set smsprofile id=<string> [to_list=<string>] [server_name=<string>] [profile_name=<string>] Description Use this operation to modify sms profile. Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.345...
  • Page 343 T his is a mandatory parameter. server_name SMS server name T his is a mandatory parameter. prof ile_name Profile name for the sms setting. T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.346...
  • Page 344 T his is a mandatory parameter. T op set smsserver Synopsis set smsserver id=<string> [is_ssl=(false | true)] [optional2_key=<string>] [to_separator=<string>] [to_key=<string>] [username_key=<string>] [message_word_separator=<string>] [optional_key=<string>] [type=<string>] [base_url=<string>] [message_key=<string>] [optional_val=<string>] [server_name=<string>] [optional2_val1=<string>] [password_val=<stringx>] [username_val=<string>] [password_key=<string>] [optional3_key=<string>] [optional3_val=<string>] Description https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.347...
  • Page 345 Message key for the sms server optional_val Optional1 Val for the sms server server_name SMS server name optional2_val1 Optional2 Val for the sms server password_val Password Val for the sms server https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.348...
  • Page 346 HT T P type supported for the sms server T his is a mandatory parameter. base_url Base URL for the sms server, without payload T his is a mandatory parameter. message_key Message key for the sms server https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.349...
  • Page 347 Optional1 Val for the sms server optional2_val1 Optional2 Val for the sms server optional3_key Optional3 key for the sms server optional3_val Optional3 Val for the sms server T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.350...
  • Page 348: Smtp Server

    T his is a mandatory parameter. T op set smtpserver Synopsis set smtpserver id=<string> [is_ssl=(false | true)] [port=<int>] [server_name=<internethost>] [username=<string>] [is_auth= (false | true)] [password=<stringx>] Description Use this operation to modify smtp server https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.351...
  • Page 349 Use this operation to add smtp server Parameters server_name SMT P server name T his is a mandatory parameter. is_ssl Is this smtp server is SSL support configured. port SMT P Server port address. username https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.352...
  • Page 350 Username for the smtp server is_auth Is authentication enabled for this smtp server password Password for the smtp server T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.353...
  • Page 351 [name=<string>] [enable=(false | true)] [severity=<string>] Description Use this operation to modify snmp alarm configuration Parameters name Alarm Name enable Enable Alarm severity Alarm severity. Supported values: Critical, Major, Minor, Warning, Informational T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.354...
  • Page 352: Snmp Manager

    Use this operation to delete SNMP Manager Parameters snmp_manager Manager IPAddress T his is a mandatory parameter. T op set snmpmanager Synopsis set snmpmanager snmp_manager=<internethost> community=<string> Description Use this operation to modify SNMP Manager Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.355...
  • Page 353 Description Use this operation to add SNMP Manager Parameters snmp_manager Manager IPAddress T his is a mandatory parameter. community Community Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.356...
  • Page 354 Trap Destination Server Address T his is a mandatory parameter. T op set snmptrap Synopsis set snmptrap dest_server=<internethost> [community=<string>] [dest_port=<int>] Description Use this operation to modify snmp trap destination Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.357...
  • Page 355 [community=<string>] [dest_port=<int>] Description Use this operation to add snmp trap destination Parameters dest_server Trap Destination Server Address T his is a mandatory parameter. community Community Name dest_port Destination Port T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.358...
  • Page 356: Snmp User

    Name of SNMP User T his is a mandatory parameter. T op set snmpuser Synopsis set snmpuser security_level=<int> name=<string> [view_name=<string>] [auth_protocol=<int>] [privacy_protocol=<int>] [auth_password=<stringx>] [privacy_password=<stringx>] Description Use this operation to modify SNMP User https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.359...
  • Page 357 Security Level of SNMP User. Values: 0: noAuthNoPriv, 1: authNoPriv, 2: authPriv T his is a mandatory parameter. name Name of SNMP User T his is a mandatory parameter. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.360...
  • Page 358 Authentication Protocol of SNMP User. Values: 0:noValue, 1: MD5, 2: SHA1 privacy_protocol Privacy Protocol of SNMP User. Values: 0:noValue, 1: DES, 2: AES auth_password Authentication Password of SNMP User privacy_password Privacy Password of SNMP User T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.361...
  • Page 359: Snmp View

    Name of SNMP view T his is a mandatory parameter. T op set snmpview Synopsis set snmpview name=<string> [subtree=<string>] [type=(false | true)] Description Use this operation to modify SNMP View Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.362...
  • Page 360 Name of SNMP view T his is a mandatory parameter. subtree Subtree associated with the SNMP view type Include or Exclude the associated subtree . Values. true:Include, false: Exclude T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.363...
  • Page 361 T op delete sslcertfile Synopsis delete sslcertfile file_name=<string> Description Use this operation to delete ssl certificate file Parameters f ile_name File Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.364...
  • Page 362: Ssl Certificate

    Certificate T his is a mandatory parameter. status Tells whether the certificate is still valid or not subject Subject ssl_key valid_f rom Valid From days_to_expiry Days before SSL certificate expires https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.365...
  • Page 363 Public Key Algorithm password T he pass-phrase that was used to encrypt the private-key. version Version serial_number Serial Number signature_algorithm Signature Algorithm issuer Issuer valid_to Valid To T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.366...
  • Page 364 T op delete sslkeyfile Synopsis delete sslkeyfile file_name=<string> Description Use this operation to delete ssl key file Parameters f ile_name File Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.367...
  • Page 365 Use this operation to modify the syslog parameters Parameters timezone T imezone to be used in the syslog message date_f ormat Format of date to be added in the syslog message T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.368...
  • Page 366: Syslog Server

    [log_level_all=(false | true)] [log_level_error=(false | true)] [log_level_none=(false | true)] [log_level_warning=(false | true)] [port=<int>] [log_level_critical=(false | true)] [log_level_info=(false | true)] [name= <string>] Description Use this operation to modify a syslog server Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.369...
  • Page 367 Use this operation to add a syslog server Parameters port Syslog server port T his is a mandatory parameter. ip_address Syslog server IP address T his is a mandatory parameter. name Syslog server name https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.370...
  • Page 368 Send logs of level warning to this syslog server log_level_critical Send logs of level critical to this syslog server log_level_error Send logs of level error to this syslog server T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.371...
  • Page 369 File Name restore_type Restore Type [3: Appliance Restore, 4: Instance Restore] ip_address_list List of VM IP Address T op do systembackuprestore f actory_def ault Synopsis do systembackuprestore factory_default [reset_type=<int>] Description https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.372...
  • Page 370 Appliance Restore, 4: Instance Restore, 5: Backup ] T op do systembackuprestore backup Synopsis do systembackuprestore backup [file_name=<string>] Description Use this operation to Backup Parameters f ile_name File Name T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.373...
  • Page 371: System Group

    T his is a mandatory parameter. T op set systemgroup Synopsis set systemgroup id=<string> [name=<string>] [session_timeout=<int>] [session_timeout_unit=<string>] [enable_session_timeout=(false | true)] [permission=<string>] [users=<string...>] Description Use this operation to modify system group https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.374...
  • Page 372 Use this operation to add system group Parameters name Group Name T his is a mandatory parameter. permission Permission for the group (admin/read-only) T his is a mandatory parameter. session_timeout Session timeout for the Group https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.375...
  • Page 373 Session timeout unit for the Group enable_session_timeout Enables session timeout for group users Users belong to the group T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.376...
  • Page 374 File Name T op delete systemimage Synopsis delete systemimage file_name=<string> Description Use this operation to delete build file Parameters f ile_name File Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.377...
  • Page 375 Synopsis delete systemsession id=<string> Description Kill client session by providing id Parameters Id is system generated key for all the client sessions T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.378...
  • Page 376: System Settings

    Enable Metering for NS VPX's on SDX secure_access_only Secure Access only session_timeout Session timeout for the system session_timeout_unit Session timeout unit for the system enable_session_timeout Enables session timeout feature https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.379...
  • Page 377 Communication with NetScaler T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.380...
  • Page 378: System Status

    Synopsis show systemstatus Description Use this operation to get system status T op do systemstatus reboot Synopsis do systemstatus reboot Description Use this operation to reboot T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.381...
  • Page 379: System Upgrade

    Sep 10 , 20 14 System Upgrade do systemupgrade custom Synopsis do systemupgrade custom [image_name=<string>] Description Use this operation to upgrade Parameters image_name image_name T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.382...
  • Page 380 T op set systemuser Synopsis set systemuser id=<string> [external_authentication=(false | true)] [name=<string>] [session_timeout=<int>] [session_timeout_unit=<string>] [enable_session_timeout=(false | true)] [permission=<string>] [password=<stringx>] [encrypted=(false | true)] [groups=<string...>] Description Use this operation to modify system user https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.383...
  • Page 381 Synopsis add systemuser name=<string> password=<stringx> [external_authentication=(false | true)] [session_timeout=<int>] [session_timeout_unit=<string>] [enable_session_timeout=(false | true)] [permission=<string>] [encrypted=(false | true)] [groups=<string...>] Description Use this operation to add system user Parameters name https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.384...
  • Page 382 Session timeout unit for the user enable_session_timeout Enables session timeout for user permission Actions that this user is authorized to perform encrypted Provide encrypted password groups Groups to which user belongs T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.385...
  • Page 383 T his is a mandatory parameter. T op set tacacsserver Synopsis set tacacsserver id=<string> ip_address=<ipaddress> name=<string> [port=<int>] [tacacs_key=<stringx>] [auth_timeout= <int>] [accounting=(false | true)] Description Use this operation to modify TACACS server https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.386...
  • Page 384 Description Use this operation to add TACACS server Parameters ip_address IP Address of TACACS server T his is a mandatory parameter. tacacs_key Key shared between the TACACS+ server and clients https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.387...
  • Page 385 TACACS server auth_timeout T he maximum number of seconds the system will wait for a response from the TACACS server accounting Enable accounting in the tacacs server T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.388...
  • Page 386: Tech Support

    Use this operation to generate technical support archive Parameters f ile_name Technical support File Name T op show techsupport Synopsis show techsupport [file_name=<string>] Description Use this operation to get technical support file Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.389...
  • Page 387 Technical support File Name T op delete techsupport Synopsis delete techsupport file_name=<string> Description Use this operation to delete technical support file Parameters f ile_name Technical support File Name https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.390...
  • Page 388 T his is a mandatory parameter. T op do techsupport ManagementServiceAndXen Synopsis do techsupport ManagementServiceAndXen [file_name=<string>] Description Use this operation to generate technical support archive Parameters f ile_name Technical support File Name T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.391...
  • Page 389: Time Zone

    Use this operation to get the current time zone T op set timezone Synopsis set timezone [timezone=<string>] Description Use this operation to modify current time zone Parameters timezone T imezone T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.392...
  • Page 390 Sep 10 , 20 14 T ime zones show timezone_enum Synopsis show timezone_enum Description Use this operation to get key value pair for T imezones https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.393...
  • Page 391 Use this operation to modify User Lockout Policy details Parameters user_lockout_interval User lockout Interval in secoonds invalid_logins No of invalid logins for User lockout enable_user_lockout Enable user User lockout feature T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.394...
  • Page 392 Sep 10 , 20 14 VLAN details show vlandetails Synopsis show vlandetails [vlan_id=<int>] Description Use this operation to get vlan details Parameters vlan_id VLAN ID T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.395...
  • Page 393 Sep 10 , 20 14 VLAN summary show vlansummary Synopsis show vlansummary Description Use this operation to get vlan summary T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.396...
  • Page 394 Sep 10 , 20 14 VM Device show vmdevice Synopsis show vmdevice [id=<string>] Description Use this operation to get VM Instance Parameters Id is system generated key for all the VM Instances T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.397...
  • Page 395 - 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 https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.398...
  • Page 396 Id is system generated key for all the NetScaler Instances name Name of managed device T op do ns start Synopsis do ns start [id=<string>] Description Use this operation to start NetScaler Instance https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.399...
  • Page 397 <int>] [throughput=<doublelong>] [pps=<doublelong>] [number_of_cores=<int>] [reboot_vm_on_cpu_change=(false | true)] [password=<stringx>] [cmd_policy=<string>] [l2_enabled=(false | true)] [if_0_1=(false | true)] [if_0_2=(false | true)] [la_mgmt=(false | true)] [vlan_id_0_1=<int>] [vlan_id_0_2=<int>] [network_interfaces=<network_interface...>] [nsvlan_id= <int>] [vlan_type=<int>] [nsvlan_tagged=(false | true)] [nsvlan_interfaces=<string...>] Description https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.400...
  • Page 398 Assign packets per seconds to NetScaler Instance number_of _cores Number of cores that are assigned to VM Instance reboot_vm_on_cpu_change Reboot VMs on CPU change during resource allocation password Password for specified user on NetScaler Instance https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.401...
  • Page 399 VLAN Type, NS or L2 VLAN nsvlan_tagged NSVLAN Tagged nsvlan_interf aces VLAN Interfaces T op do ns f orce_reboot Synopsis do ns force_reboot [id=<string>] Description Use this operation to force reboot NetScaler Instance Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.402...
  • Page 400 Bond consisting of management ports on VM Instance nsvlan_tagged NSVLAN Tagged license Feature License for NetScaler Instance, needs to be set while provisioning (standard, enterprise, platinum) username User Name (except nsroot) to be configured on NetScaler Instance https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.403...
  • Page 401 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 Password for specified user on NetScaler Instance vm_memory_total Total Memory of VM Instance in MB nsvlan_id VLAN Id https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.404...
  • Page 402 Synopsis do ns force_stop [id=<string>] Description Use this operation to force stop NetScaler Instance Parameters Id is system generated key for all the NetScaler Instances T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.405...
  • Page 403 T op delete nsdocimage Synopsis delete nsdocimage file_name=<string> Description Use this operation to delete NetScaler Documentation file Parameters f ile_name File Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.406...
  • Page 404 T op delete nsimage Synopsis delete nsimage file_name=<string> Description Use this operation to delete NetScaler build file Parameters f ile_name File Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.407...
  • Page 405 T op delete nssslcertfile Synopsis delete nssslcertfile file_name=<string> Description Use this operation to delete ns ssl certificate file Parameters f ile_name File Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.408...
  • Page 406 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 T his is a mandatory parameter. T op set nssslcertkey Synopsis set nssslcertkey id=<string> [ssl_certificate=<string>] [ssl_key=<string>] [cert_format=<string>] [password=<stringx>] [save_config=(false | true)] [no_domain_check=(false | true)] Description https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.409...
  • Page 407 Use this operation to install certificates on NetScaler Instance(s) Parameters ssl_certif icate Certificate T his is a mandatory parameter. certkeypair_name Cert Key Pair Name T his is a mandatory parameter. https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.410...
  • Page 408 Use this operation to generate CSR for the certificate Parameters 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 T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.411...
  • Page 409 [polling_interval=<int>] [interval_unit=<string>] Description Use this operation to set the polling frequency of the NetScaler SSL certificates Parameters polling_interval Frequency of polling in minutes interval_unit Frequency unit (Minutes) T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.412...
  • Page 410 T op delete nssslkeyfile Synopsis delete nssslkeyfile file_name=<string> Description Use this operation to delete ns ssl key file Parameters f ile_name File Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.413...
  • Page 411 Synopsis do nsupgrade upgrade [image_name=<string>] [doc_file=<string>] [ns_ip_address_arr=<ipaddress...>] Description Use this operation to upgrade NetScaler Parameters image_name image_name doc_f ile Documentation File Name ns_ip_address_arr List of NS IP Address T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.414...
  • Page 412 - Xen Health Monitor (IPMI Sensor) - Temperature systemhealthvoltage - Xen Health Monitor (IPMI Sensor) - Voltage xenhotfix - Xen Hotfix xennsvpximage - NetScaler XVA File xensupplementalpack - Xen Supplemental Pack xenupgrade - Xen Upgrade https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.415...
  • Page 413 Use this operation to get XenServers Parameters Id is system generated key for all the XenServers T op do appliance reboot Synopsis do appliance reboot [id=<string>] Description Use this operation to reboot XenServer Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.416...
  • Page 414 Id is system generated key for all the XenServers T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.417...
  • Page 415 T his is a mandatory parameter. MT U value, should be between 1500-9126 static_channel_state Static channel state (Enabled/Disabled) channel_alias Alias name for this channel state State of the port. channel_tag_all_vlans https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.418...
  • Page 416: Set Channel

    Channel ID if this interface represents a channel (LA/1, LA/2 ...) T his is a mandatory parameter. MT U value, should be between 1500-9126 static_channel_state Static channel state (Enabled/Disabled) channel_alias https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.419...
  • Page 417 <string...> [mtu=<int>] [channel_alias=<string>] [state=<string>] [channel_tag_all_vlans=(false | true)] [lacp_channel_time= <string>] [channel_bandwidth_high=<int>] [channel_ha_monitoring=(false | true)] [channel_throughput=<int>] [channel_bandwidth_normal=<int>] Description Use this operation to create channel Parameters static_channel_state Static channel state (Enabled/Disabled) T his is a mandatory parameter. channel_id https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.420...
  • Page 418 HA-monitoring control for the channel. Possible values: true and false channel_throughput Minimum required throughput in Mbps for this channel channel_bandwidth_normal Lower end threshold of the channel bandwidth usage in Mbps T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.421...
  • Page 419: Channel Info

    Sep 10 , 20 14 Provides platfor specific channel information show channelinf o Synopsis show channelinfo Description Use this operation to get channelinfo T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.422...
  • Page 420 Sep 10 , 20 14 Host CPU Cores show cpucoreusage Synopsis show cpucoreusage Description Use this operation to get CPU Cores T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.423...
  • Page 421: Host Interface

    Use this operation to modify interface/channel Parameters mapped_port Mapped Port Name Ex: eth0 T his is a mandatory parameter. MT U value, should be between 1500-9126 port Port Name Ex: 10/1 apply_mac_address Apply Mac Address https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.424...
  • Page 422 State of the port. f low_control_auto_neg Auto Negotiation For Flow Control act_id Activity Id device_name Device Name port_type Port Type duplex Duplex T op do hostinterf ace custom Synopsis https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.425...
  • Page 423 [id=<string>] Description Use this operation to reset interface settings Parameters Id is system generated key T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.426...
  • Page 424 Id is system generated key for all logical drives T op add raidLogicalDrive Synopsis add raidLogicalDrive [name=<string>] [adapter_id=<int>] [state=<string>] [drives=<string>] [targetid=<int>] [virtualdrive= <int>] [size=<string>] [physical_disk_slot_1=<string>] [physical_disk_slot_2=<string>] Description Use this operation to create logical disk Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.427...
  • Page 425 State drives Drives targetid Target ID virtualdrive Virtual Drive size Logical Drive Size physical_disk_slot_1 First Slot for Raid Logical Drive physical_disk_slot_2 Second Slot for Raid Logical Drive T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.428...
  • Page 426 Use this operation to get physical disks Parameters slot Slot Number T op do raidPhysicalDrive remove_pd Synopsis do raidPhysicalDrive remove_pd [slot=<int>] Description Use this operation to remove physical disks Parameters slot https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.429...
  • Page 427 Use this operation to stop locating physical disks Parameters slot Slot Number T op do raidPhysicalDrive replace_missing Synopsis do raidPhysicalDrive replace_missing [slot=<int>] Description Use this operation to replace missing physical disks Parameters slot Slot Number T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.430...
  • Page 428 Sep 10 , 20 14 Health Summary show systemhealth Synopsis show systemhealth [id=<string>] Description Use this operation to get health of the SDX system resource Parameters Id is system generated key T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.431...
  • Page 429 Sep 10 , 20 14 Hardware Resource show systemhealthHardware Synopsis show systemhealthHardware Description Use this operation to get the current values of hardware resources https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.432...
  • Page 430 Sep 10 , 20 14 Software Resource show systemhealthSof tware Synopsis show systemhealthSoftware Description Use this operation to get the current values of software resources https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.433...
  • Page 431 Sep 10 , 20 14 Storage Repository show systemhealthStorageRepository Synopsis show systemhealthStorageRepository [bay_number=<string>] Description Use this operation to get details of the storage repositories Parameters bay_number Bay number T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.434...
  • Page 432 Sep 10 , 20 14 Disk IO Statistics show systemhealthdisk Synopsis show systemhealthdisk [name=<string>] Description Use this operation to get disk IO statistics Parameters name Name of the Disk T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.435...
  • Page 433 Xen Health Monitor (IPMI Sensor) - Fan Speed show systemhealthf anspeed Synopsis show systemhealthfanspeed Description Use this operation to get the IPMI sensor data (for all fan-speed sensors) T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.436...
  • Page 434 Sep 10 , 20 14 Xen Health Monitor (IPMI Sensor) - Miscellaneous show systemhealthpowersupply Synopsis show systemhealthpowersupply Description Use this operation to get the IPMI Sensor data (for all miscellaneous sensors) T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.437...
  • Page 435 Sep 10 , 20 14 Xen Health Monitor (IPMI Sensor) - Temperature show systemhealthtemperature Synopsis show systemhealthtemperature Description Use this operation to get the IPMI sensor data (for all temperature sensors) T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.438...
  • Page 436 Sep 10 , 20 14 Xen Health Monitor (IPMI Sensor) - Voltage show systemhealthvoltage Synopsis show systemhealthvoltage Description Use this operation to get the IPMI sensor data (for all voltage sensors) T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.439...
  • Page 437 File Name T his is a mandatory parameter. T op do xenhotfix custom Synopsis do xenhotfix custom [file_name=<string>] Description Use this operation to apply new xen hotfixes Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.440...
  • Page 438 File Name T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.441...
  • Page 439 T op delete xennsvpximage Synopsis delete xennsvpximage file_name=<string> Description Use this operation to delete NetScaler XVA file Parameters f ile_name File Name T his is a mandatory parameter. T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.442...
  • Page 440 File Name T his is a mandatory parameter. T op do xensupplementalpack custom Synopsis do xensupplementalpack custom [file_name=<string>] Description Use this operation to install new xen supplemental pack Parameters https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.443...
  • Page 441 File Name T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.444...
  • Page 442 Sep 10 , 20 14 Xen Upgrade do xenupgrade custom Synopsis do xenupgrade custom [image_name=<string>] Description Use this operation to upgrade XenServer Parameters image_name image_name T op https://docs.citrix.com © 1999-2017 Citrix Systems, Inc. All rights reserved. p.445...

Table of Contents