> For the complete documentation index, see [llms.txt](https://help.highlight.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.highlight.net/functionality/config-backup-functionality.md).

# Config Backup Functionality

Early Release Version

## Overview

Config Backup keeps a history of the configuration of your network devices. On a schedule, an agent logs in to each device you choose and reads its configuration (an **audit**). Highlight stores a new version whenever the configuration has changed. You can then see when a device changed, compare any two versions, and receive a daily email that lists the devices that failed or look wrong.

This guide is for Partner Administrators. It takes you through switching Config Backup on, setting it up for the first time, and using it day to day. Where there is a more detailed page, the guide links to it.

{% hint style="info" %}
**Note:** Config Backup is an early release and is switched on for selected accounts first. It only reads device configurations: it does not send configuration changes to your devices. All times are in UTC.
{% endhint %}

## Before you start

You will need:

* Config Backup switched on for your account (Step 1).
* A user with the permissions in Step 2. To set Config Backup up you need **Manage Config Backups**, **Edit watches** and **Manage folders/locations**.
* Devices that Highlight monitors as SNMP devices. SD-WAN-only devices and endpoint devices cannot be backed up.
* An agent assigned to poll each device, which can reach the device over SSH. The Config Backup module is installed with the agent, so there is nothing extra to install. See [Agent installation](https://help.highlight.net/device-setup/agent-installation.md).
* A login for each device: an SSH username and password (a read-only login is best, if the device allows it) and the device type.

## Part 1: Switch Config Backup on

### Step 1. Ask Highlight to switch Config Backup on

Only Highlight can switch Config Backup on. [Contact us](https://help.highlight.net/getting-started/contact-us.md) and tell us which folder it is for. Everyone in or below that folder sees Config Backup the next time they load a page. Until then, every Config Backup menu, button and setting is hidden.

### Step 2. Give users the permissions

In [Consolidated Admin](https://help.highlight.net/admin/admin-page.md), find the user and click the cog on the left to edit it. Expand [**Permissions**](https://help.highlight.net/admin/admin-page/user.md#permissions).

| Permission                | Checkbox in Edit User                  | What it allows                                                                                                                              |
| ------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| **View Config Backups**   | **View config backup** (under User)    | Open a device's history, and view, compare and download configs.                                                                            |
| **Manage Config Backups** | **Manage config backup** (under Admin) | Everything in View Config Backups, plus **Audit now**, reviewing changes, setting up Config Backup and the **Config Backup** page in Admin. |

* **Manage config backup** needs **View config backup** as well. If you tick Manage on its own, the save is refused with "If selecting 'Manage config backup', you must also select 'View config backup'."
* You can only give a permission that you hold yourself. A box for a permission you do not hold is greyed out.
* Both permissions start off for existing users, so ask us to give your first administrator both when we switch Config Backup on.
* The two checkboxes only show if Config Backup is switched on for you.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2F015ft1gMxlqAfaifnA0f%2Fuser-permissions-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FAfYOsllO3Aq1R6Q3hhFF%2Fuser-permissions-light.png?alt=media" alt="Permissions accordion in Edit User, with View config backup under User and Manage config backup under Admin"></picture><figcaption></figcaption></figure>

## Part 2: Set it up

### Step 3. Choose when backups run

Each agent has its own schedule. In Consolidated Admin, find the agent and click the cog on the left to edit it. Expand **Agent Tools: Config Backup**.

* **Run backups** offers **Every hour**, **Every 2, 3, 4, 6, 8 or 12 hours** and **Once a day**.
* With every N hours, backups start at 00:00 UTC and repeat. For example, every 8 hours runs at 00:00, 08:00 and 16:00.
* With **Once a day**, you choose the hour, from 00:00 to 23:00 UTC.

A new agent runs **Once a day at 02:00 UTC**. After you save, the agent picks up the new schedule within about 10 minutes.

You need the permissions **Manage Config Backups** and **Manage folders/locations** to change the schedule. With **Manage Config Backups** but not **Manage folders/locations** you can see the schedule but not change it.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2F7OGpuic3Uvz3XBTxk6lC%2Fagent-config-backup-v2-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FLu8M3iNg0pMvK0Hy9tQX%2Fagent-config-backup-v2-light.png?alt=media" alt="Edit agent panel with the Agent Tools: Config Backup section open, set to run backups once a day at 02:00 UTC"></picture><figcaption></figcaption></figure>

### Step 4. Switch Config Backup on for your devices

Set Config Backup once on a folder, and every SNMP device below it uses the same settings. Or set it on a single device.

*On a folder*

1. In Consolidated Admin, find the folder and click the cog on the left to open **Edit Folder**.
2. Expand **Config Backup**.
3. Set **Status** to **Enabled**.
4. Complete the **Connection details** and **Sanity checks** (see the table below).
5. Save.

<table><thead><tr><th width="203">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>SSH Username</strong> and <strong>SSH Password</strong></td><td>The login the agent uses to reach the device. Both are required. The password is always shown masked.</td></tr><tr><td><strong>Device Type</strong></td><td>The type of device, chosen from a list of supported types. Required.</td></tr><tr><td><strong>Line Count % Change</strong></td><td>A config change is flagged <strong>Needs attention</strong> if its number of lines changes by more than this percentage. The starting value is 10.</td></tr><tr><td><strong>Minimum Line Count</strong></td><td>A config change is flagged <strong>Needs attention</strong> if it has fewer lines than this. The starting value is 10.</td></tr></tbody></table>

**SSH Kex** and **SSH Host Key** are optional. Leave them blank unless Highlight Support asks you to complete them.

* The same login and Device Type apply to every device below the folder. If the devices are different types, set Config Backup on each device, or use a separate folder for each type.
* The accordion shows on existing folders only, not while you are creating a folder. You need the permission **Manage folders/locations** to see it, and **Edit watches** and **Manage Config Backups** to change it. Without those it is read-only.
* A device is backed up only if it is an SNMP device with an agent assigned, an address, a Device Type and a login. A device missing any of these is skipped.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FNpYuEU76cX8Y1gDayo11%2Ffolder-config-backup-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2F0dKO4h3YyJrzBLixDjKk%2Ffolder-config-backup-light.png?alt=media" alt="Config Backup accordion in Edit Folder, with the guidance banner, Status switched on, and the folder&#x27;s own connection details and sanity checks, each group with a Revert link"></picture><figcaption></figcaption></figure>

*On a single device*

1. Find any watch on the device and click the cog on the left to open **Edit Watch**. The settings belong to the device, so every watch on the same device shares them.
2. Expand **Config Backup**, which comes after **Containers**.
3. If the device inherits its settings, each group shows the folder path it inherits from, with an **Override** link. Click **Override** to make changes for this device. The inherited values are copied to the device, and later changes to the folder no longer apply to it.
4. Complete the fields as above and save. Once a device overrides its settings, **SSH Username**, **SSH Password** and **Device Type** must all be filled in.

To go back to the folder's settings, click **Revert** and save.

The accordion is not shown for a watch that has no SNMP device, or for an SD-WAN-only device.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FhLOinECzZKwnJO4vsyNT%2Fwatch-snmp-config-backup-inherited-v2-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2Fsgh18CZRHTc5enkXcRh5%2Fwatch-snmp-config-backup-inherited-v2-light.png?alt=media" alt="Config Backup accordion on a device that inherits all its settings: read-only values, with the folder path they come from and an Override link under each group"></picture><figcaption></figcaption></figure>

### Step 5. Set up the daily report (optional)

The daily report is an email that lists failed devices first, then devices that need attention, then devices that passed. You need the permission **Manage Config Backups**.

1. In Admin, open **Config Backup**.
2. Click **Create New Report**. The report covers the folder you have selected in the tree, and everything below it.
3. Enter a **Name** and the **Send To** email addresses, separated by commas.
4. Choose **Include**: **All devices** or **Only with issues**.
5. Leave **Status** as **Enabled**, then save.

Each enabled report is emailed at 06:00 UTC every day. The time cannot be changed. **Run Now** shows a report on screen, and **Send Now** emails it straight away. For more detail, see[ Config Backup Reports](https://help.highlight.net/admin/config-backup-reports.md).

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2Fv7IzTL2mbx6T75xBgYwG%2Fconfig-backup-reports-create-report-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FsWACuRnUUIRvPIX5JFwL%2Fconfig-backup-reports-create-report-light.png?alt=media" alt="Create config backup report panel open beside the report list, with the folder path at the top, the Main fields Status, Name, Send To and Include, and Save and Cancel"></picture><figcaption></figcaption></figure>

### Step 6. Check the first backup

The first backup happens at the next scheduled run. To check sooner, with **Manage Config Backups**:

1. In Reporting, open [Inventory ](https://help.highlight.net/reporting/inventory.md)and click the device's row. Its Tech Info panel opens.
2. Click **Config Backup**, then **Audit now**.
3. After a minute or two, the results appear in the list by themselves.

The banner at the top shows **Pass**, **Needs attention** or **Failed**. If a device is skipped, a message says why. See [Config Backup History](https://help.highlight.net/reporting/inventory/config-backup-history.md).

## Part 3: Using Config Backup day to day

* **Read the daily email.** Each device links to its history. Start with **Failed**, then **Needs attention**.
* **Review changes that need attention.** In a device's history, use the **Actions** menu to **Mark as resolved**, **Mark as failed** or **Add comment**. Use **Compare with previous** to see what changed.
* **Fix a problem, then check again.** If an audit failed with **No connection** or **Timed out**, check that the agent can reach the device and that the login is right. Change the login in Edit Folder or Edit Watch, then click **Audit now**. The agent collects the latest device details before each run.
* **Rerun failed backups.** On the **Config Backup** page in Admin, click **Run Now** on a report. **Rerun Failed Backups (n)** asks for the failed devices in the output to be backed up again straight away. Run the report again to see how they went.
* **Add new devices.** A new SNMP device below a folder that has Config Backup enabled is included automatically, once it has an agent assigned. Allow about 10 minutes for the agent to pick it up.
* **Change the schedule.** Edit the agent, as in Step 3.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FpGZFS43ThXyEszcd3MIW%2Fconfig-backup-reports-report-output-dark.png?alt=media" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2F0RC3MbH1GdiJgPeI2evs%2Fconfig-backup-reports-report-output-light.png?alt=media" alt="Report Output after Run Now: the summary line, two Failed rows first, then Needs attention and Pass rows, and the Rerun Failed Backups (2) button"></picture><figcaption></figcaption></figure>

#### Troubleshooting

| What you see                                                | Why                                                                                                                                           | What to do                                             |
| ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| No Config Backup menu, button or setting anywhere           | Config Backup is not switched on for your account.                                                                                            | Ask Highlight to switch it on (Step 1).                |
| No **Config Backup** item in the Admin menu                 | You do not have **Manage Config Backups**.                                                                                                    | Ask an administrator to give you the permission.       |
| The **Config Backup** button in Tech Info is greyed out     | You do not have **View Config Backups**, or the device is not set up. Hover over the button to see which.                                     | Check your permissions, or set the device up (Step 4). |
| No **Config Backup** accordion in Edit Folder or Edit Watch | The folder or watch is not eligible, you lack **Edit folders**, or you are in Classic Admin Browse.                                           | Use Consolidated Admin. A watch needs an SNMP device.  |
| The accordion is read-only                                  | You need **Manage Config Backups** and **Manage folders/locations**.                                                                          | Ask an administrator for the permissions.              |
| No backups for this device yet                              | The first scheduled run has not happened.                                                                                                     | Wait for the run, or click **Audit now**.              |
| Audit not requested                                         | A message gives the reason: the device no longer exists, Config Backup is off for it, it has no agent, or its connection details are missing. | Fix the reason shown and try again.                    |
| Failed: No connection or Timed out                          | The agent could not reach the device, or the login was not accepted.                                                                          | Check the network path, SSH and the login.             |

## Permissions in detail

| What you can do                                                                              | No permission             | View only   | View and Manage                                             |
| -------------------------------------------------------------------------------------------- | ------------------------- | ----------- | ----------------------------------------------------------- |
| **Config Backup** button in Tech Info                                                        | Greyed out, with a reason | Yes         | Yes                                                         |
| Open the history, and view, compare and download configs                                     | No                        | Yes         | Yes                                                         |
| **Audit now**                                                                                | Hidden                    | Hidden      | Yes                                                         |
| **Mark as resolved**, **Mark as failed** and **Add comment**                                 | Hidden                    | Hidden      | Yes                                                         |
| **Config Backup** page in Admin, for reports                                                 | Hidden                    | Hidden      | Yes                                                         |
| **Config Backup** accordion in Edit Watch                                                    | Read-only                 | Read-only   | Yes, with **Edit watches**                                  |
| **Config Backup** accordion in Edit Folder (you need **Manage folders/locations** to see it) | Read-only                 | Read-only   | Yes, with **Edit watches**                                  |
| **Agent Tools: Config Backup** schedule in Edit Agent                                        | Hidden                    | Hidden      | Yes, with**Manage folders/locations**; read-only without it |
| Delete a folder or location that holds Config Backup reports                                 | Not allowed               | Not allowed | Allowed                                                     |
| Counts as an admin user, so can open the Admin menu                                          | No                        | No          | Yes                                                         |
| Give **View config backup** to another user                                                  | No                        | Yes         | Yes                                                         |
| Give **Manage config backup** to another user                                                | No                        | No          | Yes                                                         |

If **Manage Config Backups** is the only admin permission a user has, Admin opens on the **Config Backup** page.

## Good to know

* Config Backup works with SNMP devices only.
* You set Config Backup up in Consolidated Admin. Classic Admin Browse has no Config Backup settings.
* The sanity checks only flag a change. They do not stop the configuration being stored.
* Config Backup does not yet alert you if an agent stops or misses a run. The **Last run** in a device's history, and the **Date (UTC)** in the daily report, show when a device has gone quiet.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.highlight.net/functionality/config-backup-functionality.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
