Product Documentation

Create audit templates

You want to make sure that certain configurations are running on specific instances for optimal performance of your network. You also want to monitor configuration changes across managed Citrix ADC instances, troubleshoot configuration errors, and recover unsaved configurations after a sudden system shutdown. You can create audit templates with specific configurations you want to audit on certain instances. Citrix Application delivery Management (ADM) compares these instances with the audit template and reports if there is a mismatch in the configuration.  Whenever there is a configuration mismatch, Citrix ADM generates a configuration diff report, which enables you to troubleshoot, and rectify unwanted configuration changes.

You can automate the running of the audit template by

  • Scheduling the time at which the template should be run

  • Setting the frequency at which Citrix ADM should run the template. You can run the template daily, on a specific day in a week, or on a specific date in a month.

Also, you have an option to send the diff report generated by Citrix ADM to specified email addresses that you can configure. By this option, your user can receive the report as a mail attachment and there is no need for the user to log on to Citrix ADM to export the reports manually.

To create audit templates:

  1. Navigate to NetworksConfiguration Audit > Audit Templates, and click Add.

  2. On the Create Template page, and in the Audit Commands tab, specify the template name and its description.

  3. In the Configuration Editor page, type in your commands and save the commands as a configuration template. You can also drag an existing template from the left pane to the editor.

  4. Select the values that you want to convert to a variable, and then click Convert to Variable. For example, select the IP address of the load balancing server ”ipaddress1,” and click Convert to Variable. The variable is now enclosed with  ”$” as shown in the image below.

    localized image

    In the Define Variable window, set the properties for this variable - name, display name, and the type of the variable. Click the Advanced option if you want to further specify a default value for your variable.

    localized image

    You can also save the commands as a configuration template.

    localized image

  5. Click Save and then, click Next.

  6. In the Select Instances tab, select the instances you want to run the configuration audit on and click Next.

    localized image

  7. 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

  8. Click Next.

    localized image

  9. In the Template Preview tab, you can evaluate and verify the commands to be run on each instance or instance group. Click Next.

    localized image

  10. In the Schedule Template tab, you have the following options to schedule the running of the template and configuring the mail address to send the diff report.

    • Use global polling interval. Select this option to run the template on the instances at a time configured globally on Citrix ADM.

      Note: To configure global polling interval in Citrix ADM, navigate to Networks > Configuration Audit > Audit Templates, and click Global Polling Interval. In the Poll Interval field, enter the minutes at which Citrix ADM should globally poll the instances.

    • Customize template schedule. Use this option to configure the time and the frequency at which the templates need to be run

    • Send report through email. use this option to configure the mail profile to which the diff report should be sent as a mail attachment.

  11. Click Finish.

    localized image

    The audit template appears in the Audit Templates list and is run at the scheduled time against the configurations in the specified instances.

    localized image

Create audit templates

In this article