> 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/reporting/inventory/config-backup-history.md).

# Config Backup History

Early release version

#### Overview

Config Backup History shows what Config Backup has done for one device: every time Highlight checked the device's configuration (an **audit**) and every time that configuration changed. From here you can see whether backups are working, view or compare earlier versions of the config and download a copy. With the right permission you can also ask for a new audit straight away and record your decision on a change that needs attention.

All times are in UTC, to match the schedule Config Backup runs on.

**Note:** Config Backup works with SNMP devices that have been set up for it. If you cannot see the Config Backup button at all, Config Backup has not been switched on for your account.

#### Permissions

<table><thead><tr><th width="215">Permission</th><th>What you can do</th></tr></thead><tbody><tr><td><strong>View Config Backups</strong></td><td>Open the history, and view, compare and download configs.</td></tr><tr><td><strong>Manage Config Backups</strong></td><td>Everything in View Config Backups, plus <strong>Audit now</strong> and reviewing changes (<strong>Mark as resolved</strong>, <strong>Mark as failed</strong> and <strong>Add comment</strong>).</td></tr></tbody></table>

#### Opening the history

1. In Reporting, open Inventory and select the folder or location in the Network Explorer tree.
2. Click the row of the device. Its Tech Info panel opens.
3. In the **Run technical test** box, click **Config Backup**. The button sits next to **Test**.

The history opens in the same window, with the title **Config Backup History** followed by the device's system name. If the device has no system name (it shows as "None Set"), the title shows its IP address instead.

To go back to Tech Info, click **×** (**Back to Tech Info**) or press **Esc**.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FW1S4TknMqybUvyFsHCPO%2Fconfig-backup-history-tech-info-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%2FTYLHYPe9JhdeAcEiDuzc%2Fconfig-backup-history-tech-info-light.png?alt=media" alt="Tech Info for a device, with the Config Backup button next to Test in the Run technical test box"></picture><figcaption></figcaption></figure>

If the **Config Backup** button is greyed out, hover over it, or move to it with the Tab key, to see why:

<table><thead><tr><th width="330">Message</th><th>What it means</th></tr></thead><tbody><tr><td>You do not have permission to view config backups</td><td>Ask your administrator to give you the <strong>View Config Backups</strong> permission.</td></tr><tr><td>Config backup is not enabled for this device</td><td>The device has not been set up for Config Backup, or it is not an SNMP device.</td></tr></tbody></table>

#### The summary

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FEde7mYAYhSRMswUgpqmV%2Fconfig-backup-history-dialog-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%2FDOdYxtz4PQ0HWaGkhwit%2Fconfig-backup-history-dialog-light.png?alt=media" alt="Config Backup History dialog: the title with the device name, the Needs attention banner, IP address, Last run and Last config change, the two filters with the entry count, and the first rows of the list"></picture><figcaption></figcaption></figure>

A banner at the top gives the device's latest state. It shows the worse of the latest audit and the latest config change:

<table><thead><tr><th width="160">State</th><th>Banner message</th></tr></thead><tbody><tr><td><strong>Pass</strong></td><td>Config backup is working. The latest audit and config change passed.</td></tr><tr><td><strong>Needs attention</strong></td><td>The latest config change (date UTC) needs attention, followed by the check it did not pass.</td></tr><tr><td><strong>Failed</strong></td><td>The latest audit (date UTC) failed, followed by the reason, for example "no connection". Or the latest config change was marked as failed, followed by the name of the person who marked it.</td></tr></tbody></table>

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FjvT6XpewWX9rSzD2iE5G%2Fconfig-backup-history-banner-states-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%2Ftv2jJx7X7k64pLQp3a0g%2Fconfig-backup-history-banner-states-light.png?alt=media" alt="The summary banner in its three states: Pass in green, Needs attention in amber and Failed in red"></picture><figcaption></figcaption></figure>

Below the banner are three facts about the device. A dash (–) means there is no value yet.

<table><thead><tr><th width="215">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>IP address</strong></td><td>the address Highlight uses to reach the device</td></tr><tr><td><strong>Last run</strong></td><td>the date and time (UTC) of the most recent audit or config change</td></tr><tr><td><strong>Last config change</strong></td><td>the date and time (UTC) of the most recent change to the device's config</td></tr></tbody></table>

#### The history list

The newest entry is at the top. Click the **Date (UTC)** heading to switch between newest first and oldest first. This is the only column you can sort by.

<table><thead><tr><th width="215">Column</th><th>Description</th></tr></thead><tbody><tr><td><strong>Date (UTC)</strong></td><td>when the entry was recorded</td></tr><tr><td><strong>Type</strong></td><td><strong>Audit</strong> is a check of the device's config. <strong>Config change</strong> means the check found that the config had changed, and the new config was stored.</td></tr><tr><td><strong>State</strong></td><td>the result, shown as a word with an icon (see the next section)</td></tr><tr><td><strong>Details</strong></td><td>what happened (see below)</td></tr><tr><td><strong>Duration (secs)</strong></td><td>how long the check took, in seconds. A dash (–) means the time was not recorded.</td></tr><tr><td><strong>Actions</strong></td><td>a menu of things you can do with the entry (see Row actions)</td></tr></tbody></table>

When a check finds that the config has changed, the list shows an **Audit** entry and a **Config change** entry for the same run.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2Fsp7M8mALBkaVriMEglQH%2Fconfig-backup-history-list-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%2F8usOujOZS3VWZcJUaWO9%2Fconfig-backup-history-list-light.png?alt=media" alt="History list with Audit and Config change entries in the Needs attention, Pass, Timed out and Resolved states"></picture><figcaption></figcaption></figure>

**State**

State is always shown as a word with an icon, never by colour alone.

<table><thead><tr><th width="215">State</th><th>Meaning</th></tr></thead><tbody><tr><td><strong>Pass</strong> (green tick)</td><td>An audit that passed, or a config change that is within the limits set for the device.</td></tr><tr><td><strong>Needs attention</strong> (amber triangle)</td><td>A config change that needs checking: it has fewer lines than the Minimum Line Count, or its number of lines changed by more than the Line Count % Change. These limits are set in the Config Backup settings for the device or folder.</td></tr><tr><td><strong>Resolved</strong> (green tick)</td><td>A <strong>Needs attention</strong> change that someone has marked as resolved.</td></tr><tr><td><strong>Failed</strong> (red cross)</td><td>A failed audit, or a change that someone has marked as failed. A failed audit reads <strong>No connection</strong> or <strong>Timed out</strong> when that was the cause.</td></tr></tbody></table>

**Details**

The **Details** column describes each entry. For example:

* An audit that found no change: "Config unchanged".
* A config change that passed: its line count and the change, for example "164 lines (+3%)".
* A change that needs attention: the check it did not pass, for example "Only 12 lines, below the 50-line minimum" or "Line count up 40%, above the 25% limit".
* A change that someone has reviewed: "Resolved by" or "Failed by" and their name, then the check that was flagged.
* A failed audit: the reason and the type of error. If there is no further detail, it says "The backup engine gave no further detail."

Comments added by users appear above the rest of the entry, newest first, each with the author's name and the time (UTC).

#### Filtering the list

Above the list there are two filters. They work together.

<table><thead><tr><th width="215">Filter</th><th>Options</th></tr></thead><tbody><tr><td><strong>Type</strong></td><td><strong>All</strong> shows every entry. <strong>Config changes</strong> hides the audit entries.</td></tr><tr><td><strong>Status</strong></td><td><strong>All statuses</strong> shows every entry. <strong>Issues</strong> shows only <strong>Needs attention</strong> and <strong>Failed</strong> entries.</td></tr></tbody></table>

The number of entries is shown beside the filters, for example "12 of 40 entries". If your filters hide every entry, the list says "No issues to show" or "No config changes to show". Click **Show all entries** to clear both filters.

The filters and the sort order are not remembered. They return to their starting settings each time you open the history.

#### Row actions

Where an entry has actions, it has an **Actions** button (⋮) on the right. Click it to open the menu. An entry with no actions, such as an audit that passed, has no **Actions** button.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2Fjsb9tqnbV2B2WbkF8uXx%2Fconfig-backup-history-row-actions-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%2FhDgxFFaUi89X3vaN7g9w%2Fconfig-backup-history-row-actions-light.png?alt=media" alt="Actions menu open on a Needs attention row, with the Config section (Compare with previous, View config, Download config) and the Review section (Mark as resolved, Mark as failed, Add comment)"></picture><figcaption></figcaption></figure>

**Config** (you need View Config Backups)

* **Compare with previous**: compares this version with the one before it. Not offered on the oldest version.
* **Compare with current**: compares this version with the newest one. Not offered on the newest version.
* **View config**: shows the config.
* **Download config**: downloads the config as a text file.

These are offered only for a version that Highlight has stored.

**Review** (you need Manage Config Backups)

* **Mark as resolved** and **Mark as failed**: offered on **Needs attention** entries.
* **Add comment**: offered on any entry that is not **Pass** or **Resolved**.

#### Reviewing a change that needs attention

When a config change is flagged **Needs attention**, someone with the **Manage Config Backups** permission should check the change and record the outcome.

* **Mark as resolved**: use this when the change is fine. The entry becomes **Resolved**, with "Resolved by" and your name. There is no confirmation step.
* **Mark as failed**: use this when the change is a problem. The entry becomes **Failed**, with "Failed by" and your name. **This cannot be undone**: the entry no longer offers **Mark as resolved** or **Mark as failed**.
* **Add comment**: opens the **Add comment** screen, which shows the entry and a box for your comment. A comment can be up to 4,000 characters, and the box shows a count. **Add comment** stays disabled until the box holds something other than spaces. Click **Add comment** to save it. Your comment appears at the top of the entry's **Details**, with your name and the time. Click **Cancel**, or press **Esc**, to go back without saving.

If saving fails, a message appears and your text is kept so you can try again.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FJ4odtkIUqSGnaFJRw1G4%2Fconfig-backup-history-add-comment-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%2FgRHqhaiDmsuu7KflZkiX%2Fconfig-backup-history-add-comment-light.png?alt=media" alt="Add comment screen, with the entry at the top and the comment box with its character count"></picture><figcaption></figcaption></figure>

#### Viewing and comparing configs

**View config**

The **Config version** screen shows the version's date (UTC), its line count and its state, followed by the config with line numbers. You can compare it with the previous version or download it from here.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2F9JJXYwIAEExNdnpTyCbP%2Fconfig-backup-history-config-version-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%2FJCqzkue0Czlu0I7JigLk%2Fconfig-backup-history-config-version-light.png?alt=media" alt="Config version screen showing the version&#x27;s date, line count and state, and the config with line numbers"></picture><figcaption></figcaption></figure>

**Compare versions**

The **Compare versions** screen shows how many lines were added and removed, for example "12 added, 3 removed", and then the differences.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2Fz6fAK00057vFSX5iFRgB%2Fconfig-backup-history-compare-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%2Fa5iU7p2S2T4FyfrDMHzv%2Fconfig-backup-history-compare-light.png?alt=media" alt="Compare versions screen in Side by side layout, with removed and added lines highlighted and marks beside the scrollbar"></picture><figcaption></figcaption></figure>

* **Layout** switches between **Side by side** and **Combined**. Your choice is kept while the history is open.
* When the version is neither the oldest nor the newest, **Compare with** lets you switch between the **Previous version** and the **Current version**.
* Long runs of unchanged lines (more than 8 in a row) are folded away. Three lines are kept next to each change. Click **Show N unchanged lines** to see them.
* Marks beside the scrollbar show where the changes are. Click one to jump to it.
* If the two versions are the same, the screen says "No differences".
* **Download newer config** downloads the newer of the two versions.

**Getting back**

Every screen other than the history has a **← Config Backup History** link. Press **Esc** for the same result. From the history itself, **Esc** goes back to Tech Info. If a menu is open, **Esc** closes the menu first.

The address in your browser follows the screen you are on, so you can copy it to share the same view.

#### Audit now

**Audit now** asks Highlight to check the device straight away, instead of waiting for the next scheduled run. It is in the toolbar, and you need the **Manage Config Backups** permission to see it.

1. Click **Audit now**. The button is disabled and shows a spinner until Highlight answers.
2. A message at the top right of the window says "A request has been made to re-audit this device. Wait a minute or two for the results." The device is checked ahead of any others that are waiting.
3. **Audit now** is then unavailable for about a minute, with "Available again in Ns" underneath it.
4. The results appear in the list by themselves when they arrive. You do not need to refresh.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FyafMjRmnQ3CXTwKHwoRC%2Fconfig-backup-history-audit-now-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%2F2ZbCC13smHDI25DvVmlG%2Fconfig-backup-history-audit-now-light.png?alt=media" alt="Config Backup History just after Audit now: the request message at the top right, and Audit now unavailable with Available again in 52s underneath"></picture><figcaption></figcaption></figure>

Audit now runs the same check as the schedule. If the config has changed, a new **Config change** entry appears. If it has not changed, a new **Audit** entry appears saying "Config unchanged", and no new version is stored. Audit now does not take a fresh copy of the config when nothing has changed.

If the request is not picked up within 5 minutes it expires, and you can click **Audit now** again.

If the audit cannot be requested, a message says "Audit not requested" followed by the reason, and you can click **Audit now** again straight away. The reason is one of:

* the device no longer exists
* config backup is turned off for this device
* the device has no poller agent
* the device is missing its config backup connection details

If the Config Backup service is not available, the message shows what the server said, for example "The config backup service is not available. Try again later."

#### Downloading the latest config

**Download latest config** downloads the newest version that Highlight has stored for the device. If nothing has changed for a while, this can be an older version than the date of the last audit, because a new version is only stored when the config changes.

If every run for a device has failed, there is no stored version, and the message "Unable to fetch the latest config for this device." is shown.

#### When the history cannot be shown

<table><thead><tr><th width="330">Message</th><th>What to do</th></tr></thead><tbody><tr><td>No backups for this device yet</td><td>Config Backup has not run for this device. Backups run on the schedule set in Agent Tools. If you have <strong>Manage Config Backups</strong>, click <strong>Audit now</strong> to run one straight away.</td></tr><tr><td>You can't view this device's backups</td><td>You do not have the <strong>View Config Backups</strong> permission. An administrator can give it to you.</td></tr><tr><td>The config history for this device couldn't be loaded. Try again in a moment.</td><td>Click <strong>Try again</strong>.</td></tr><tr><td>This config version could not be found.</td><td>The version in the link no longer exists. Go back to the history and choose another.</td></tr><tr><td>This collection run could not be found.</td><td>The entry in the link cannot be found. Go back to the history and choose another.</td></tr></tbody></table>

#### Using the keyboard and a screen reader

* Press **Tab** to move into a filter, then use the arrow keys to move between its options.
* The list scrolls with the keyboard when it has focus.
* With the focus on an **Actions** button, press **Enter**, **Space** or **↓** to open the menu on its first item (**↑** opens it on the last). Use the arrow keys, **Home** and **End** to move between items. **Esc** closes the menu and returns to the button.
* A screen reader announces "Marked as resolved", "Marked as failed", "Comment added" and "History refreshed". While **Audit now** is waiting for an answer, it tells a screen reader that it is busy.

#### Good to know

* The list shows up to the latest 1,000 runs, all on one page.
* The limits for **Needs attention** are applied when you view the history. If the limits are changed, older entries can change state.
* Some devices change their own config every time it is read, for example when an internal password or key changes. For these devices the history can show a **Config change** on every run even though nothing has really changed.
* Config Backup History is designed for the Insight UI. In the Classic interface it works but is not styled.


---

# 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/reporting/inventory/config-backup-history.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.
