Configuration jobs

Last published : Sep 26, 2026
NetScaler Console configuration management process ensures the proper replication of configuration changes, system upgrades, and other maintenance activities across multiple NetScaler instances in the network.
NetScaler Console allows you to create configuration jobs that help you to perform all these activities with ease on several devices as a single task. Configuration jobs and templates simplify the most repetitive administrative tasks to a single task on NetScaler Console. A configuration job contains a set of configuration commands that you can run on one or multiple managed devices.
Configuration Jobs can either use SSH commands to do configuration commands or use SCP to do file copy from either locally or to another appliance, for example, we can schedule a HA-failover or HA-upgrade.
You can create a configuration job by using one of the following four options in NetScaler Console. Use one of these to create a reusable source of commands and instructions to the system to run a configuration job.
  1. Configuration Template
  2. Instance
  3. File
  4. Record and Play

Configuration Template

You can create configuration templates while creating a job and saving a set of configuration commands as a template. When you save these templates on the Create Jobs page, they are automatically displayed on the Create Template page. For more information, see How to Use the Master Configuration Template on NetScaler Console.
Note
The Rename option is disabled for the default configuration templates. However, you can rename custom configuration templates.
You can use one of the following templates:
Configuration Editor: You can use the configuration editor to type in CLI commands, save the configuration as a template, and use it to configure jobs.
Inbuilt Template: You can choose from a list of configuration templates. These templates provide the syntaxes of the CLI commands and allow you to specify values for the variables. The inbuilt templates are listed, with their descriptions in the table below. You can schedule a job by using the built-in template option. A job is a set of configuration commands that you can run on one or more managed instances. For example, you can use the built-in template option to schedule a job to configure syslog servers. You can also choose to run the job immediately or schedule the job to be run at a later stage.
For more information, see How to Use Configuration Templates to Create Audit Templates

Instance

You can perform a single-bundle upgrade of your NetScaler SDX instances running NetScaler release 11.0 and later. To perform a single-bundle upgrade, you use a built-in task in NetScaler Console. You can also upgrade a NetScaler instance by extracting the running configuration or a saved configuration and running the commands on another NetScaler instance of the same type. This upgrade allows you to replicate the configuration of one instance on the other.

File

You can upload a configuration file from your local machine and create jobs.
Advantages of using a file
  • You can use any text file to create a reusable source of configuration commands.
  • Any kind of formatting is not required.
  • The file can be saved on your local machine.
You can either create and save a new file or import an existing file, and run the commands.

Record and Play

Using Create job you can either enter your own CLI commands, or you can use the record and play button to get commands from a NetScaler session. When you run the job, changes in the ns.conf on the selected instance are recorded and copied to NetScaler Console. See, How to Use Record-and-Play to Create Configuration Jobs.

Export the report of this dashboard

To export the report of this page, click the Export icon on the top right side of this page. On the Export page, you can do one of the following:
  1. Select Export Now tab. To view and save the report in PDF, JPEG, PNG, or CSV format.
  2. Select Schedule Export tab. To schedule the report daily, weekly, or monthly and send the report over an email or a slack message.
Note
  • If you select Weekly recurrence, ensure that you select the weekdays on which you want the report to be scheduled.
  • If you select Monthly recurrence, ensure that you enter all the days that you want the report to be scheduled separated by commas.

Related Articles