Product Documentation
Application Delivery Management
14.1 - Current Release 13.1 13.0
View PDF

Create a configuration job

February 14, 2024
Contributed by: 
C

A job is a set of configuration commands that you can create and run on one or more multiple managed instances. You can create jobs to make configuration changes across instances, replicate configurations on multiple instances on your network, and record-and-play configuration tasks using the Citrix Application Delivery Management (ADM) GUI and convert it into CLI commands.

You can use the Configuration Jobs feature of Citrix ADM to create a configuration job, send email notifications, and check execution logs of the jobs created.

To create a configuration job on Citrix ADM:

  1. Navigate to the Networks > Configuration Jobs.

  2. Click Create Job.

  3. On the Create Job page, under the Select Configuration tab, specify the Job Name and select the Instance Type from the list.

  4. In the Configuration Source list, select the configuration job template that you want to create. Add the commands for the selected template.

    • You can either enter the commands or import the existing commands from the saved configuration templates.

    • You can also add multiple templates of different types in the Configuration editor while creating a job in the Configuration Jobs.

    • From the Configuration Source list, select the different templates and then drag the templates into the configuration editor. The template types can be Configuration Template, In built Template, Master Configuration, Record and Play, Instance and File.

    Note

    If you add the Deploy Master Configuration Job template for the first time, add a template of different type, then the whole job template becomes a Master Configuration type.

    You can also rearrange and reorder the commands in the configuration editor. You can move the command from one line to another by dragging and dropping the command line. You can also move or rearrange the command line from one line to any target line by simply changing the command line number in the text box. You can also rearrange and reorder the command line while editing the configuration job.

    You can define variables that enable you to assign different values for these parameters or run a job across multiple instances. You can review all the variables that you have defined while creating or editing a configuration job in a single consolidated view. Click the Preview Variables tab to preview the variables in a single consolidated view that you have defined while creating or editing a configuration job.

    You can customize rollback commands for every command on the configuration editor. To specify your customized commands, Enable the custom rollback option.

    Important

    For custom rollback to take effect, complete the Create Job wizard. And in the Execute tab, select the Rollback Successful Commands option from the On Command Failure list.

  5. In the Select Instances tab, select the instances on which you want to run the configuration audit.

    1. In a Citrix ADC high-availability pair, you can run a configuration job local to a primary or a secondary node. Select on which node you want to run the job.

      • Execute on primary nodes - Select this option to run the job only on primary nodes.

      • Execute on secondary nodes - Select this option to run the job only on secondary nodes.

      You can also choose both primary and secondary node to run the same configuration job. If you do not select either primary or secondary node, automatically the configuration job runs on the primary node.

  6. In the Specify Variable Values tab, you have two options:

    1. Download the input file to enter the values for the variables that you have defined in your commands, and then upload the file to the Citrix ADM server.

    2. Enter common values for the variables that you have defined for all instances

    3. Click Next.

To send an email and Slack notification for a job:

An email and Slack notification is now sent every time a job is run or scheduled. The notification includes details such as the success or failure of the job along with the relevant details.

  1. Navigate to Networks>Configuration Jobs.

  2. Select the job that you want to enable email and Slack notification and click Edit.

  3. In the Execute tab, go to the Receive Execution Report Through pane:

    • Select the Email check box and choose the email distribution list to which you want to send the execution report.

      If you want to add an email distribution list, click Add and specify the email server details.

    • Select the Slack check box and choose the slack channel to which you want to send the execution report.

      If you want to add a Slack profile, click Add and specify the Profile Name, Channel Name, and Token of the required Slack channel.

      Slack profile

  4. Click Finish.

To send an email and Slack notification for a job:

An email and Slack notification is now sent every time a job is run or scheduled. The notification includes details such as the success or failure of the job along with the relevant details.

  1. Navigate to Networks>Configuration Jobs.

  2. Select the job that you want to enable email and Slack notification and click Edit.

  3. In the Execute tab, go to the Receive Execution Report Through pane:

    • Select the Email check box and choose the email distribution list to which you want to send the execution report.

      If you want to add an email distribution list, click Add and specify the email server details.

    • Select the Slack check box and choose the slack channel to which you want to send the execution report.

      If you want to add a Slack profile, click Add and specify the Profile Name, Channel Name, and Token of the required Slack channel.

  4. Click Finish.

To view execution summary details:

  1. Navigate to Networks > Configuration Jobs.

  2. Select the job that you want to view the execution summary and click Details.

  3. Click Execution Summary to see:

    • The status of the instance on that run the job

    • The commands run on the job

    • The start and end time of the job, and

    • The instance user’s name

    Summary

Create a configuration job
February 14, 2024
Contributed by: 
C
February 14, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.