Upgrade jobs

You can create the following maintenance tasks using NetScaler Console. You can then schedule the maintenance tasks at a specific date and time.

  • Upgrade NetScaler instances

  • Upgrade NetScaler SDX instances

  • Upgrade NetScaler BLX instances

  • Upgrade NetScaler instances in the Autoscale Group

  • Configure HA pair of NetScaler instances

  • Convert HA pair of instances to Cluster

Note:

If an upgrade job fails, NetScaler Console removes the build files and other extracted files to ensure that NetScaler instances have sufficient disk space for the next upgrade attempt.

Schedule upgrading of NetScaler instances

  1. Navigate to Infrastructure > Upgrade Jobs. Click Create Job.

    Create maintenance job

  2. In Create Maintenance Jobs, select Upgrade NetScaler (Standalone/High-Availability/Cluster) and click Proceed.

    Select upgrade maintenance job

  3. In Select Instance, type a name of your choice for Job Name.

  4. Click Add Instances to add NetScaler instances that you want to upgrade.

    • To upgrade an HA pair, specify the IP address of a primary or secondary node. However, using the primary instance to upgrade the HA pair is recommended.

    • To upgrade a cluster, specify the cluster IP address.

      Add instances to upgrade maintenance job

  5. Click Next to select the image. Select one of the following options from the Software Image list:

    • Local - Select the instance upgrade file from your local machine.

    • Appliance - Select the instance upgrade file from NetScaler Console file browser. The NetScaler Console GUI displays the instance files that are present at /var/mps/mps_images.

      • Skip image uploading to NetScaler if the selected image is already available - Select this option if the image is already present in the NetScaler instance.

      • Clean software image from NetScaler on successful upgrade - Select this option to clear the uploaded image in the NetScaler instance after the instance upgrade.

  6. Click Next to start the pre-upgrade validation on the selected instances.

    The Pre-upgrade validation tab displays the failed instances. Remove the failed instances and click Next.

    Important

    If you specify cluster IP address, NetScaler Console does pre-upgrade validation only on the specified instance not on the other cluster nodes.

  7. Optional, in Custom scripts, specify the scripts to run before and after an instance upgrade. Use one of the following ways to run the commands:

    • Import commands from file - Select the command input file from your local computer.

    • Type commands - Enter commands directly on the GUI.

      Custom scripts

    You can use custom scripts to check the changes before and after an instance upgrade. For example:

    • The instance version before and after the upgrade.

    • The status of interfaces, high-availability nodes, virtual servers, and services before and after upgrade.

    • The statistics of virtual servers and services.

    • The dynamic routes.

  8. Click Next. In Schedule Task, select one of the following options:

    • Upgrade now - The upgrade job runs immediately.

    • Schedule Later - Select this option to run this upgrade job later. Specify the Execution Date and Start Time when you want to upgrade the instances.

      If you want to upgrade a NetScaler HA pair in two stages, select Perform two stage upgrade for nodes in HA.

      Specify the Execution Date and Start Time when you want to upgrade another instance in the HA pair.

  9. Click Next. In Create Job, specify the following details:

    1. Specify when you want to upload the image to an instance:

      • Upload now - Select this option to upload the image immediately. However, the upgrade job runs at the scheduled time.

      • Upload at the time of execution - Select this option to upload the image at the time of upgrade job execution.

      • Backup the NetScaler instances before starting the upgrade. - Creates a backup of the selected NetScaler instances.

      • Saves NetScaler Configuration before starting the upgrade - Saves the configuration jobs that are configured on the instance before the upgrade.

      • Enable ISSU to avoid network outage on NetScaler HA pair - ISSU ensures the zero downtime upgrade on a NetScaler high-availability pair. This option provides a migration functionality that honors the existing connections during upgrade. So, you can upgrade a NetScaler HA pair without downtime. Specify the ISSU migration timeout in minutes.

  10. Click Create Job.

Schedule upgrading of NetScaler SDX instances

  1. Navigate to Infrastructure > Upgrade Jobs. Click Create Job.

  2. Select Upgrade NetScaler SDX and click Proceed.

  3. On the Upgrade NetScaler SDX page, in the Instance Selection tab:

    1. Add a Task Name.

    2. From the Software Image list, select either Local (your local machine) or Appliance (the build file must be present on NetScaler Console virtual appliance).

      The upload process begins.

    3. Add the NetScaler SDX instances on which you want to run the upgrade process.

    4. Click Next.

  4. On the Schedule Task tab, select Now from the Execution Mode list to upgrade a NetScaler SDX instance now, and click Finish.

  5. To upgrade a NetScaler SDX instance later, select Later from the Execution Mode list. You can then choose the Execution Date and the Start Time for upgrading the NetScaler instance, and click Finish

  6. You can also enable email and slack notifications to receive the execution report of the upgrading NetScaler SDX instance. Click the Receive Execution Report Through Email checkbox and Receive Execution Report through slack checkbox to enable the notifications.

    For more information to configure email distribution list and slack channel, see step 8 in Schedule upgrading of NetScaler instances

Schedule upgrading of NetScaler BLX instances

  1. Navigate to Infrastructure > Upgrade Jobs. Click Create Job.

  2. In Create Maintenance Jobs, select Upgrade NetScaler BLX and click Proceed.

  3. In Select Instance, type a name of your choice for Job Name.

  4. Click Add Instances to add the BLX instances that you want to upgrade.

    • To upgrade an HA pair, specify the IP address of a primary or secondary node. However, using the primary instance to upgrade the HA pair is recommended.

    • To upgrade a cluster, specify the cluster IP address.

  5. Click Next to select the image. elect one of the following options from the Software Image list:

    • Local - Select the instance upgrade file from your local machine.

    • Appliance - Select the instance upgrade file from NetScaler Console file browser. The NetScaler Console GUI displays the instance files that are present at /var/mps/mps_images.

      • Skip image uploading to NetScaler if the selected image is already available - Select this option if the image is already present in the NetScaler instance.

      • Clean software image from NetScaler on successful upgrade - Select this option to clear the uploaded image in the NetScaler instance after the instance upgrade.

  6. Click Next to start the pre-upgrade validation on the selected instances.

    The Pre-upgrade validation tab displays the failed instances. Remove the failed instances and click Next.

    Important

    If you specify cluster IP address, NetScaler Console does pre-upgrade validation only on the specified instance not on the other cluster nodes.

  7. Optional, in Custom scripts, specify the scripts to run before and after an instance upgrade. Use one of the following ways to run the commands:

    • Import commands from file - Select the command input file from your local computer.

    • Type commands - Enter commands directly on the GUI.

      Custom scripts

    You can use custom scripts to check the changes before and after an instance upgrade. For example:

    • The instance version before and after the upgrade.

    • The status of interfaces, high-availability nodes, virtual servers, and services before and after upgrade.

    • The statistics of virtual servers and services.

    • The dynamic routes.

  8. Click Next. In Schedule Task, select one of the following options:

    • Upgrade now - The upgrade job runs immediately.

    • Schedule Later - Select this option to run this upgrade job later. Specify the Execution Date and Start Time when you want to upgrade the instances.

      If you want to upgrade an HA pair in two stages, select Perform two stage upgrade for nodes in HA.

      Specify the Execution Date and Start Time when you want to upgrade another instance in the HA pair.

  9. Click Next. In Create Job, specify the following details:

    1. Specify when you want to upload the image to an instance:

      • Upload now - Select this option to upload the image immediately. However, the upgrade job runs at the scheduled time.

      • Upload at the time of execution - Select this option to upload the image at the time of upgrade job execution.

      • Backup the NetScaler instances before starting the upgrade - Creates a backup of the selected NetScaler instances.

      • Saves NetScaler Configuration before starting the upgrade - Saves the configuration jobs that are configured on the instance before the upgrade.

      • Enable ISSU to avoid network outage on NetScaler HA pair - ISSU ensures the zero downtime upgrade on a NetScaler high-availability pair. This option provides a migration functionality that honors the existing connections during upgrade. So, you can upgrade a NetScaler HA pair without downtime. Specify the ISSU migration timeout in minutes.

  10. Click Create Job.

Schedule upgrading Autoscale group

Perform the following steps to upgrade all the instances in the cloud services that are part of the Autoscale group:

  1. Navigate to Infrastructure > Upgrade Jobs. Click Create Job.

  2. Select Upgrade Autoscale Group and click Proceed.

  3. In the Upgrade Settings tab:

    1. Select the Autoscale Group that you want to upgrade.

    2. In Image, select the NetScaler version. This image is the existing version of NetScaler instances in the Autoscale group.

    3. In NetScaler Image, browse the NetScaler version file to which you want to upgrade.

      If you check Graceful Upgrade, the upgrade task waits until the specified drain connection period to expire.

    4. Click Next.

  4. In the Schedule Task tab:

    1. Select one of the following from the Execution Mode list:

      • Now: To start the NetScaler instances upgrade immediately.

      • Later: To start the NetScaler instances upgrade at later time.

    2. If you select the Later option, select the Execution Date and Start Time when you want to start the upgrade task.

    You can also enable email and slack notifications to receive the execution report of the upgrading Autoscale group. Click the Receive Execution Report Through Email checkbox and Receive Execution Report through slack checkbox to enable the notifications.

  5. Click Finish.

Schedule configuring HA pair of NetScaler instances

  1. Navigate to Infrastructure > Upgrade Jobs. Click Create Job.

  2. Select Configure HA Pair of NetScaler Instances and click Proceed.

  3. On the NetScaler HA Pair page, in the Instance Selection tab:

    1. Add a Task Name.

    2. Select the primary IP address. Click OK.

    3. Enter the primary RPC node password.

    4. Select the secondary IP address. Click OK.

      Note:

      The RPC node password fields are available in NetScaler release 14.1 and later.

    5. Enter the secondary RPC node password.

    6. Click to enable Turn on INC(Independent Network Configuration) mode if you have the HA pair instances in two subnets.

    7. Click Next.

      Select HA pair

  4. On the Schedule Task tab, select Now from the Execution Mode list to upgrade a NetScaler instance now, and click Finish.

  5. To upgrade a NetScaler HA pair later, select Later from the Execution Mode list. You can then choose the Execution Date and the Start Time for upgrading the NetScaler instance, and click Finish.

  6. You can also enable email and slack notifications to receive the execution report of creating the NetScaler HA pair. Click the Receive Execution Report Through Email checkbox and Receive Execution Report through slack checkbox to enable the notifications.

    For more information to configure email distribution list and slack channel, see step 8 in Schedule upgrading of NetScaler instances

Schedule converting HA pair of instances to cluster

  1. Navigate to Infrastructure > Upgrade Jobs. Click Create Job.

  2. Select Convert HA Pair of Instances to 2 Node Cluster and click Proceed.

  3. On the Migrate NetScaler HA to Cluster page, in the Instance Selection tab, add a Task Name. Specify the Primary IP address, Secondary IP address, Primary Node ID, Secondary Node ID, Cluster IP Address, Cluster ID, and Backplane, and then click Next.

  4. On the Schedule Task tab, select Now from the Execution Mode list to upgrade a NetScaler instance now, and click Finish.

  5. To upgrade later, select Later from the Execution Mode list. You can then choose the Execution Date and the Start Time for upgrading the NetScaler HA pair instance, and click Finish.

  6. You can also enable email and slack notifications to receive the execution report of upgrading a NetScaler SDX instance. Click the Receive Execution Report Through Email checkbox and Receive Execution Report through slack checkbox to enable the notifications.

    For more information to configure email distribution list and slack channel, see step 8 in Schedule upgrading of NetScaler instances.