Citrix Application Delivery Management

Maintenance jobs

You can create the following maintenance jobs using Citrix ADM. You can then schedule the maintenance jobs at a specific date and time.

  • Upgrade Citrix ADC instances

  • Upgrade Citrix ADC SD WAN-WO instances

  • Upgrade Citrix ADC SDX instances

  • Upgrade Citrix ADC instances in the Autoscale Group

  • Configure HA pair of Citrix ADC instances

  • Convert HA pair of instances to 2-node Cluster

Schedule upgrading of Citrix ADC instances

  1. In Citrix ADM, navigate to Networks > Configuration Jobs > Maintenance Jobs. Click the Create Job button.

    Create maintenance job

  2. In Create Maintenance Jobs, select Upgrade Citrix ADC (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 ADC instances that you want to upgrade.

    • To upgrade an HA pair, specify the IP address of primary or secondary node. However, using 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 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, the ADM does pre-upgrade validation only on the specified instance not on the other cluster nodes.

  6. Optional, in Custom scripts, specify the scripts to execute before and after an instance upgrade. Use one of the following ways to execute 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 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.
  7. In Schedule Task, select one of the following options:

    • Upgrade now - The upgrade job executes immediately.

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

      If you want to upgrade an ADC 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.

  8. In Create Job, specify the following details:

    1. 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 an ADM file browser. The ADM GUI displays the instance files that are present at /var/mps/mps_images.

    2. 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 executes at the scheduled time.

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

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

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

    • Receive Execution Report through email - Sends the execution report in email. To add an email distribution list, see Create an email distribution list.

    • Receive Execution Report through slack - Sends the execution report in slack. To add a Slack profile, see Create a Slack profile.

    Create upgrade job and upload image to ADC

  9. Click Create Job.

Schedule upgrading of Citrix ADC SD-WAN WO instances

  1. Navigate to Networks > Configuration Jobs > Maintenance Jobs. Click Create Job button.

  2. On the Create Maintenance Job page, select Upgrade Citrix ADC SD-WAN WO and click Proceed.

    localized image

  3. On the Upgrade Citrix ADC SD-WAN WO page, in the Instance Selection tab, add a Task Name. From the Software Image list, select either Local (your local machine) or Appliance (the build file must be present on the Citrix ADM virtual appliance). Add the Citrix ADC SD-WAN WO instances on which you want to run the upgrade process. Click Next.

    localized image

  4. To upgrade Citrix ADC SD-WAN WO instance now, select Now from the Execution Mode list. Click Finish.

  5. To upgrade Citrix ADC SD-WAN WO instance later, select Later from theExecution Mode list. You can then choose the execution date and the start time for upgrading the Citrix ADC SD-WAN WO instance.

  6. You can enable email notification to receive the execution report of upgrading Citrix ADC SD-WAN WO instance. Click the Receive Execution Report Through Email check box to enable the email notification.

  7. Select the + icon to create the email distribution list.

    localized image

  8. On the Create Email Distribution List page, specify a name for the email distribution list. Add the SMTP mail server to use for sending email notifications to the email server. In the From box, add the Email address from which to send messages. In the To box, add email address or addresses to which to send messages. You can also add an email address or addresses to which to send message copies and copies without displaying these addresses in the messages or the copies. Click Create. After creating the email distribution list, click Finish to complete the configuring process.

Schedule upgrading of Citrix ADC SDX instances

  1. In Citrix ADM, navigate to Networks > Configuration Jobs > Maintenance Jobs. Click Create Job button.

  2. On the Create Maintenance Job page, select Upgrade Citrix ADC SDX and click Proceed.

    localized image

  3. On the Upgrade Citrix ADC SDX appliance(s) page, in the Instance Selection tab, add a Task Name. From the Software Image list, select either Local (your local machine) or Appliance (the build file must be present on the Citrix ADM virtual appliance). Add the Citrix ADC SDX instances on which you want to run the upgrade process. Click Next.

  4. You can enable email notification to receive the execution report of upgrading Citrix ADC SDX instance. Click the Receive Execution Report Through Email check box to enable the email notification.

  5. Select the + icon to create the email distribution list.

  6. To upgrade Citrix ADC SDX instance now, select Now from the Execution Mode list. Click Finish.

  7. To upgrade Citrix ADC SDX instance later, select Later from the Execution Mode list. You can then choose the execution date and the start time for upgrading the Citrix ADC SDX instance.

  8. On the Create Email Distribution List page, specify a name for the email distribution list. Add the SMTP mail server to use for sending email notifications to the email server. In the From box, add the Email address from which to send messages. In the To box, add email address or addresses to which to send messages. You can also add an email address or addresses to which to send message copies and copies without displaying these addresses in the messages or the copies. Click Create. After creating the email distribution list, click Finish to complete the configuring process.

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. In Citrix ADM, navigate to Networks > Configuration Jobs > Maintenance Jobs. Click the Create Job button.

  2. On the Create Maintenance Jobs page, 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 Citrix ADC version. This image is the existing version of Citrix ADC instances in the Autoscale group.

    3. In Citrix ADC Image, browse the Citrix ADC 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 Citrix ADC instances upgrade immediately.

      • Later: To start the Citrix ADC 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 upgrading Autoscale group. Click the Receive Execution Report Through Email check box and Receive Execution Report through slack check box to enable the notifications.

  5. Click Finish.

Schedule configuring HA pair of Citrix ADC Instances

  1. In Citrix ADM, navigate to Networks > Configuration Jobs > Maintenance Jobs. Click Create Job button.

  2. On the Create Maintenance Job page, select Configure HA Pair of Citrix ADC Instances and click Proceed.

    Configure HA pair

  3. On the Citrix ADC HA Pair page, in the Instance Selection tab, add a Task Name. Enter the primary IP address and the secondary address and Click Next.

    Select instances HA pair

  4. On the Schedule Task tab, you can either choose to configure the Citrix ADC HA pair now or later.

  5. To configure the Citrix ADC HA pair now, select Now from the Execution Mode list. You can enable email notification to receive the execution report of Citrix ADC HA pair. Click the Receive Execution Report Through Email check box to enable the email notification.

  6. To configure the Citrix ADC HA pair later, select Later from the Execution Mode list. You can then choose the eExecution date and the start time. You can enable email notification to receive the execution report of Citrix ADC HA pair. Click the Receive Execution Report Through Email check box to enable the email notification.

  7. Select the + icon to create the email distribution list.

  8. On the Create Email Distribution List page, specify a Name for the email distribution list. Add the SMTP mail server to use for sending email notifications to the email server. In the From box, add the email address from which to send messages. In the To box, add email address or addresses to which to send messages. You can also add an email address or addresses to which to send message copies and copies without displaying these addresses in the messages or the copies. Click Create. After creating the email distribution list, click Finish to complete the configuring process.

Schedule converting HA pair of instances to Cluster

  1. In Citrix ADM, navigate to Networks > Configuration Jobs > Maintenance Jobs. Click Create Job button.

  2. On the Create Maintenance Job page, select Convert HA Pair of Instances to 2 Node Cluster and click Proceed.

    Convert HA pair instances to two node cluster

  3. On the Migrate Citrix ADC HA to Cluster page, in the Instance Selection tab, add a Task Name. Specify the primary IP address, secondary address, primary node ID, secondary node ID, cluster IP address, cluster ID, and backplane. Click Next.

    Select instances to two node cluster

  4. On the Schedule Task tab, you can either choose to migrate the Citrix ADC HA to Cluster now or later.

  5. To configure the Citrix ADC HA pair later, select Later from the Execution Mode list. You can then choose the execution date and the start time. You can enable email notification to receive the execution report of Citrix ADC HA pair. Click the Receive Execution Report Through Email check box to enable the email notification.

  6. Select the + icon to create the email distribution list.

  7. On the Create Email Distribution List page, specify a name for the email distribution list. Add the SMTP mail server to use for sending email notifications to the email server. In the From box, add the email address from which to send messages. In the To box, add email address or addresses to which to send messages. You can also add an email address or addresses to which to send message copies and copies without displaying these addresses in the messages or the copies. Click Create. After creating the email distribution list, click Finish to complete the configuring process.