Product Documentation
NetScaler® Console service
View PDF

Audit configuration changes across instances

September 27, 2025
Contributed by: 
C S

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 NetScaler instances, troubleshoot configuration errors, and recover unsaved configurations after a sudden system shutdown. You can create audit templates with specific configurations you want to run on certain instances. The NetScaler Console compares these instances with the audit template and reports if there is a mismatch in configuration. This comparison enables you to troubleshoot and rectify the errors.

You can automate the running of the audit template by scheduling the time at which the template must be run. You can also set the frequency at which NetScaler Console must run the template. You can run the template daily, on a specific day in a week, or on a specific date in a month. You can also send the diff report generated by NetScaler Console to specified email addresses that you can configure. By this option, your user receives the report as a mail attachment and there is no need for the user to log on to NetScaler Console to check the reports manually.

To create audit templates:

  1. Navigate to Infrastructure > Configuration > Configuration 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, type in your commands and save the commands as a configuration template. You can also drag an existing template from the left pane on 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 ipaddress and click Convert to Variable as shown in the following image.

    Convert to variable

    Click the Advanced option if you want to further specify a default value for your variable.

    You can also save the commands as a configuration template.

    Save as configuration template

  5. Click Save and then, click Next.

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

  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 NetScaler Console server

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

  8. Click Next.

    Specify variable values

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

  10. In the Schedule Template tab, you have three options to automate the running of the template and 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 NetScaler Console

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

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

  11. Click Finish.

    Schedule template

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

Viewing Details of Configuration Changes

You can also use the Configuration Audit dashboard to view high-level details about configuration changes such as:

  • The top 10 instances by configuration change

  • The number of saved and unsaved configurations

  • The file added, removed, or modified in the nsconfig folder

View configuration changes

NetScaler Console also allows you to poll configuration audits manually and adds all the configuration audits of the instances immediately to the NetScaler Console. To do so, navigate to Infrastructure > Configuration > Configuration Audit, click Poll Now, the pop-up page Poll Now provides you an option to poll all NetScaler instances in the network, or poll the selected instances.

You can also force an audit on an instance. To do so, click the any of the following charts:

  • NetScaler Config Saved Status

  • NetScaler Config Drift

On the Audit Reports page, select the instance and, in the Action list, select Poll Now.

Poll now

The NetScaler Config File Status chart provides you the status of the NetScaler files present in the nsconfig folder. The NetScaler Console records and compares changes in files within the nsconfig folder and displays the differences. See, View the file status audit reports.

Set configuration audit notifications

  1. Navigate to Infrastructure > Configuration > Configuration Audit.

  2. On the Configuration Audit page, click Settings.

  3. On the Settings page:

    1. Select the Perform Audit on receiving “netScalerConfigChange event check box, to enable the notification settings.

    2. Set the Delay time for Audit.

  4. In Configuration Audit Polling, set the Polling Interval.

    The NetScaler Console polls the configuration audit events for the specified polling interval.

  5. In Config Files Diff Notification, select the platform on which you want to receive the notifications:

    • Email - Select the email distribution list. Click Add to add a email distribution list to receive notification.

    • Slack - Select the Slack channel from the list. Click Add to add a channel to receive notification.

Configuration audit notification settings

Audit configuration changes across instances
September 27, 2025
Contributed by: 
C S
September 27, 2025
Contributed by: 
C S

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.