Auvik Network Automation helps authorized users run reusable command-line interface (CLI) scripts across eligible network devices. A template defines the commands. A job defines where and when those commands run, which devices receive them, and any device-specific values the commands require.
You can work with Auvik’s Automation from a multi-site level or from an individual site. At a multi-site level, site entitlement and your permissions determine which child sites and devices you can select.
Network impact warning: Scripts and commands may modify device configurations or otherwise affect your network environment. Review the script, target devices or selection criteria, and settings before proceeding.
Before you begin
Confirm the following before you create or run a job:
You have permission to perform the intended action. Template management and job execution use separate permissions. A user may be allowed to run an existing template without being allowed to create or edit one.
Each selected site has an Advanced or Performance subscription. Sites on other subscription tiers cannot be selected for a job.
Each target device is managed by Auvik and has working CLI credentials.
Elevated access is already configured in Discovery settings if the commands require it.
The device's dashboard status widget shows the backups indicator is green. A green backup check mark is a useful sign that Auvik has the CLI access required to run a CLI template.
Being monitored through SNMP does not make a device eligible for a CLI job. A managed switch can appear in Auvik through SNMP and still be unavailable to Network Automation if CLI access is not configured.
Recommendations for sensitive values
Auvik recommends against entering passwords, SNMP community strings, SNMPv3 credentials, shared keys, or other secrets in a template or parameter CSV. The current template workflow does not encrypt or securely store those values. Jobs that require a password or other secret supplied by the script are not supported through this workflow.
Future releases of Auvik’s Automation platform will allow for safe use of passwords or sensitive data.
Key terms
Term | Meaning | Example |
|---|---|---|
Template | A reusable definition containing CLI commands and, when needed, parameters | A template that adds a VLAN to an access point trunk |
Job | One immediate or scheduled execution of a selected template | Run the VLAN template against eligible switches at two sites |
Tag | A saved device query that is evaluated within the selected site scope | All Cisco Catalyst access switches running a selected software version |
Parameter or variable | A named placeholder in a template whose value can differ by device |
|
Parameter value | The value supplied for a parameter when the job is set up |
|
This article uses parameter for the input defined in a template and parameter value for the device-specific value supplied when a job is prepared. The Auvik interface may also refer to a parameter as a variable.
Create a CLI template
Open Job Templates at the hierarchy level where the template should be managed and run.
Select Create New Job Template.
Enter a clear name and description. The description should explain the intended change or query so that another operator can understand the template before running it.
Indicate whether the template requires elevated access.
Enter the CLI commands in execution order, with one command on each line.
Add parameters wherever a value needs to differ between target devices.
Review and save the template.
A template can be run from an eligible child site, subject to permissions and entitlement. To modify the template, return to the hierarchy level where it was created.
Define parameters
Use opening and closing double braces around an uppercase parameter name:
{{ ACCESS_POINT_VLAN }}
Use the same spelling wherever the parameter appears in the template. Descriptive names make CSV preparation and output review easier. For example:
{{ INTERFACE_NAME }}identifies the interface to change.{{ INTERFACE_DESCRIPTION }}supplies the description for that interface.{{ ACCESS_POINT_VLAN }}supplies a site- or device-specific VLAN ID.{{ SYSLOG_SERVER }}supplies a non-secret syslog destination.{{ NTP_SERVER }}supplies a non-secret NTP destination.
The following simplified template shows how a device-specific interface and purpose can be inserted into a Cisco Catalyst CLI script:
configure terminal interface {{ INTERFACE_NAME }} description USS_ENTERPRISE_DECK_12_{{ EQUIPMENT_PURPOSE }} end
Before using any example, confirm the commands against the exact vendor, platform, model, and software version of the target device.
Plan reusable parameter names
Consistent parameter names reduce preparation work across templates. For example, an organization can use ACCESS_POINT_VLAN in every applicable template rather than creating a different name for each site. The job can then supply the correct value for each selected device through the exported CSV.
Common examples include:
Device family | Scenario | Example parameters and values |
|---|---|---|
Cisco Catalyst | Describe an access point interface or add a wireless VLAN to an AP trunk |
|
Fortinet | Apply a consistent non-secret label to a selected interface |
|
HPE Aruba | Describe a switch port used by wireless equipment |
|
These examples show how to organize inputs, not universal device syntax. Keep separate templates when the required CLI differs by vendor, model, or software version.
Set up and run a job
1. Select and review a template
Open Run Job and select an available template. Use the template review option to confirm its description, commands, elevated-access requirement, and parameters before continuing.
2. Select the site scope
Choose the sites where the job may run. From a multi-site level, only Advanced and Performance sites that are within your authorized hierarchy are selectable.
Site scope sets the outer boundary for device selection. A tag or device rule cannot add a device from a site that is outside the selected scope.
3. Select devices
Select an existing tag, create a new tag, or define criteria for this job only.
A tag works like a saved query. Its logic can use these device properties:
Device type
Device vendor
Device model
Device software version
Device name
Use AND conditions to narrow the target set and OR conditions to include alternatives. Review the matching devices before continuing. If you create selection criteria only for the current job, the same logic applies without saving it as a tag.
4. Supply parameter values by CSV
If the selected template contains parameters and one or more selected devices still require values, Auvik prompts you to download a CSV.
Download the CSV from the job setup flow.
Enter the required value for each target device.
Leave the identifying information supplied by Auvik intact.
Upload the completed CSV.
Review the values and resolved target list before running the job.
A parameter can have a different value for each device. For example, one site can use access point VLAN 234 while another uses VLAN 310, without requiring separate copies of the template.
If a required parameter value is blank for a device, the job does not run on that device. Check for empty cells before uploading the CSV.
5. Run now or create a schedule
Choose whether to run the job immediately or create a schedule. Review the template, site scope, device selection, and parameter values one last time before confirming.
For a new or changed template, first select one representative eligible device. Review its output before expanding the target set. A successful run on one device does not prove that the commands are compatible with every model or software version.
Scheduling
Choose the recurrence with the scheduling controls.
Review and save the schedule.
Tags are evaluated as saved queries, so the matching device list can change between runs. A newly added device that meets the tag criteria may join a later run. A device that no longer matches may drop out.
Scheduled target disclosure: Target devices for this scheduled job are determined based on your selection criteria at the time of each run and may change.
Changing a template or tag used by a schedule stops the schedule. Auvik displays a notification that the scheduled job has been affected. Review the updated targets and parameter values, then reschedule the job.
Review a job in Automation Logs
Open Automation Logs and select a job to open its summary. Depending on the job, the summary can show:
Job status
Whether the job covered multiple sites
Start time and total or current runtime
Job description, when present
Device-selection criteria
Output captured from each device
The job can have one of these states:
Status | Meaning |
|---|---|
In progress | Auvik is still processing the job. |
Completed | Auvik finished processing the job. Review each device's output to confirm that the intended commands succeeded. |
Incomplete | The job did not finish as intended for all applicable work. Review the device list and output to identify what needs attention. |
Canceled | The job stopped before normal completion. Review the output to determine which devices, if any, received commands before cancellation. |
Job status describes the job lifecycle. It does not interpret every device's CLI response or confirm that the intended change occurred. A completed job can still contain an invalid-command message or other device-side error. Review the captured output for every device that matters to the change.
Use Export to download job output as CSV or JSON. Exports are useful for bulk review, record keeping, and confirming which devices returned the expected response.
Troubleshoot a missing or skipped device
If a device does not appear in the target list or does not receive the job, check the following.
Site scope and entitlement
Confirm that the device's site is included in the selected scope.
At a multi-site level, confirm that the child site has an Advanced or Performance subscription.
Confirm that your role has access to the site and permission to run jobs.
Device eligibility and access
Confirm that Auvik manages the device. SNMP monitoring alone is not sufficient.
Confirm that valid CLI credentials are configured.
If the template requires elevated access, confirm that elevated access is configured in Discovery settings.
Confirm that the backup indicator on the device is green.
Tag or selection criteria
Confirm that the device matches every required AND condition.
Confirm that its type, vendor, model, software version, and name contain the values expected by the rule.
Confirm that the tag is being evaluated inside the intended site scope.
For a scheduled job, confirm that the device still matches when that run begins.
Parameters
Confirm that the CSV contains a row for the device.
Confirm that every required parameter value is present. A blank required value prevents the job from running on that device.
Confirm that the values use syntax accepted by the target device.
Schedule changes
Confirm that nobody changed the selected tag or template after the schedule was created.
If either changed, review the notification and reschedule the job.
Safe operating practices
Treat every CLI job as an action against a real device.
Keep templates focused on one known job and use clear descriptions.
Verify commands for the exact device family and software version.
Review the selected sites and matching device count before execution.
Check CSV files for missing or incorrect values.
Start with one representative device when using a new or changed template.
Review per-device output even when the job status is Completed.
Never place passwords or other secrets in templates, parameters, or CSV files.