> 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/admin/admin-page/folder.md).

# Folder

Insight UI - Consolidated Admin

### Overview

Highlight's Network Explorer tree comprises folders and locations. Folders may contain subfolders and/or locations. Only those with the permission **Manage folders/locations** will be able to complete these steps.

### Create folder

Refer to the [Create New page](https://help.highlight.net/admin/admin-page/create-new.md) for details.

Complete these fields:

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FeKPzS332mCpvVGWwkwnE%2FCreateFolder%20-%20dark.png?alt=media&amp;token=1c5856f3-41e2-4d8c-b7dc-c12042b286bd" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FDv5JybYGOx68prose18n%2FCreateFolder%20-%20light.png?alt=media&amp;token=53c95135-c0e1-443e-82e8-efd35836bee7" alt="Create folder"></picture><figcaption></figcaption></figure>

<table data-header-hidden><thead><tr><th width="169"></th><th></th></tr></thead><tbody><tr><td>Folder name</td><td>Enter the folder name, which may contain spaces and does not need to be unique. This field is required. </td></tr><tr><td>Time zone</td><td>Select a time zone which will initially apply to new subfolders and locations created in this folder; if unchanged the time zone is inherited from the parent folder - see the <a href="https://help.highlight.net/admin/admin-general-details.md#time-zones">Time zone section</a> for more details.</td></tr><tr><td>Category</td><td>If shown, select Internal Group for a service provider folder, Customer otherwise.</td></tr><tr><td>Customer Reference</td><td>Customer Reference - An optional reference of up to 100 characters can be set on a Customer folder. This reference is then applied to every watch in this folder and any subfolders (unless overridden) and can be shown in Reporting. Click <strong>Override</strong> to set. </td></tr><tr><td>Save</td><td>Stores all details.</td></tr></tbody></table>

### Edit folder - Main

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2Ft0uKRye6KyxrYXozLTC3%2FEditFolderMain%20-%20dark.png?alt=media&amp;token=40aca90f-5de8-484e-bb46-09993c86d042" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FYWP2xwJROWb29rNfSfAD%2FEditFolderMain%20-%20light.png?alt=media&amp;token=d0565860-1dd6-4ee7-8c89-1a68bdde0684" alt="Edit Folder Main"></picture><figcaption></figcaption></figure>

<table data-header-hidden><thead><tr><th width="164"></th><th></th></tr></thead><tbody><tr><td>Folder name</td><td>Edit the folder name if needed</td></tr><tr><td>Time zone</td><td>Select a time zone which will initially apply to new subfolders and locations created in this folder; if unchanged the time zone is inherited from the parent folder - see the <a href="https://help.highlight.net/admin/admin-general-details.md#time-zones">Time zone section</a> for more details.</td></tr><tr><td>Contact name</td><td>(Optional) If available select a user from those created in this folder. The contact name is sent an email (from the <strong>noreply@highlight.net</strong> address) when a watch is activated via the Admin Pending page.</td></tr><tr><td>Category</td><td>If shown, select Internal Group for a service provider folder, Customer otherwise</td></tr><tr><td>Cust ref</td><td>Customer Reference - An optional reference of up to 100 characters can be set on a Customer folder. This reference is then applied to every watch in this folder and any subfolders (unless overridden) and can be shown in Reporting. Click <strong>Override</strong> to set. </td></tr><tr><td>Agent Selection</td><td>Refer to the <a href="https://help.highlight.net/admin/admin-general-details/agent-selection.md">Agent selection page</a> for details on assigning an agent or agent group as a Flow collector, for Web testing, or as a Poller.</td></tr><tr><td>Alerting Thresholds</td><td>Set thresholds for WiFi, Bearers, Classes and Broadband. See the <a href="https://help.highlight.net/admin/admin-general-details/alerting-thresholds.md">Alerting Thresholds page</a> for further details</td></tr></tbody></table>

### Edit folder - Business Hours

Highlight uses business hours when displaying traffic trend graphics, for filtering report results, and when generating alerts.

See the [Business Hours](https://help.highlight.net/admin/admin-general-details/business-hours.md) page for further details on the settings involved.

### Edit folder - Features

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FpPglTOVjVZzMDUIVhNNX%2FEditFolderFeatures%20-dark.png?alt=media&amp;token=87f0337f-50a4-4e32-be16-e16d1e7340c5" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FOXuYqstXAMY4GQvmjWNM%2FEditFolderFeatures%20-%20light.png?alt=media&amp;token=0682498b-85c8-42a4-9bfa-a7806181bf2c" alt="Edit Folder Features"></picture><figcaption></figcaption></figure>

Use this section to enable or control features, such as SLA reporting and AppVis.

Settings on a parent folder are inherited in subfolders unless overridden.

{% hint style="info" %}
Users with the **Manage folders/locations** permission can see the Features tab but not enable or disable SLA Now unless they also have the **Edit watches** permission. Users without the **Edit watches** permission will see the message You don't have permission to change this
{% endhint %}

**Application Visibility:**  This section is only visible if AppVis is enabled for this folder. Setting this to Enabled means AppVis applications can be assigned to groups which will be visible in this folder and in any subfolders. The option disabled if an application domain is already set in a parent folder. If you have visibility then the path to that parent folder is shown

### Edit folder - CCD

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2F15Qv1NeR2HV5bTUy7aIC%2FEditFolderCCD%20-dark.png?alt=media&amp;token=d2c30e2b-fab0-4ed9-97cf-becd65411245" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FOBBH4frw66EEUn1gsPXu%2FEditFolderCCD%20-%20light.png?alt=media&amp;token=135fc360-2b03-4903-b389-5b0f7505f899" alt="Edit Folder CCD "></picture><figcaption></figcaption></figure>

If displayed, this tab provides the means to set the class names of interest for Highlight to autodiscover and report on.  Use Override to edit and add new. Find out more about [Override and Revert](https://help.highlight.net/admin/admin-general-details.md#override-and-revert).

See the [Define Classes](https://help.highlight.net/pages/602c86f35a8f0d8d635f6d6199f2239cf31c6bef#id-3.-capturing-class-information) section on the Class Autodiscovery page for further information about class discovery.

See the [CCD page](https://help.highlight.net/admin/admin-general-details/ccd.md) for full details on the settings involved.

### Edit folder - Domain

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FXZ4Bi9XDRzPLYajtFwS0%2FEditFolderDomain%20-%20light.png?alt=media&amp;token=6ef0f96e-692c-4dc3-9217-709d339da496" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FipiLHPwudbAPIGjKeXnd%2FEditFolderDomain%20-light.png?alt=media&amp;token=e02bc346-d4ea-43bf-b458-480bad54c943" alt="Edit Folder Domain"></picture><figcaption></figcaption></figure>

If this folder is a domain, then you see the domain name, URL(s), and whether switching to other domains is allowed. [Contact us](https://help.highlight.net/getting-started/contact-us.md) if you are interested in domains.

The dialog enables you to edit the specific company information which is accessed from

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td>Contact provider</td><td>on the home page</td></tr><tr><td>Domain contact details</td><td>from the user menu/side bar</td></tr><tr><td>Provider logo</td><td>on the Details page</td></tr></tbody></table>

The fields in this dialog are optional but, if empty, the panel will also be empty.

<table data-header-hidden><thead><tr><th width="200"></th><th></th></tr></thead><tbody><tr><td>About company</td><td>an optional free-text field - the contents appears in the main body of the About panel</td></tr><tr><td>Support phone</td><td>an optional number you'd like your users to contact for help</td></tr><tr><td>Support email</td><td>an optional email address</td></tr></tbody></table>

Refer to the [Override and Revert section](https://help.highlight.net/admin/admin-general-details.md#override-and-revert) for details on this functionality.&#x20;

### Edit folder - Authentication

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FsNtveUaapsNdfpXeGGTn%2FEditFolderAuthentication%20-dark.png?alt=media&amp;token=60c09449-1f03-40af-ac16-3e24b2b468ca" media="(prefers-color-scheme: dark)"><img src="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FzjCd6kAAeTTDEh8STQ9V%2FEditFolderAuthentication%20-%20light.png?alt=media&amp;token=d84c5fa3-6c0d-4317-9766-4f38f43258b7" alt="Edit Folder Authentication"></picture><figcaption></figcaption></figure>

Highlight supports authentication and single sign-on through a process called **Federated Authentication** where password authentication is handed off to a third-party OAuth directory (typically Microsoft Azure AD).

Highlight also provides [Multi-Factor Authentication for non-federated users](https://help.highlight.net/getting-started/new-user/user-authentication.md#multi-factor-authentication).

{% hint style="info" %}
Users with both the **Manage folders/locations** and **Manage authentication** permissions can edit the Authentication section
{% endhint %}

Use this tab for administering federated authentication (SSO) on a folder. This applies to all users at this folder level and below.

<table><thead><tr><th width="139"></th><th></th></tr></thead><tbody><tr><td>Status</td><td>Enabled or Disabled, disabled keeps the information in Highlight but not applied</td></tr><tr><td>Provider</td><td>Currently the only option is OIDC</td></tr><tr><td>Name</td><td>Enter a unique name for the authentication provider. The name can be up to 50 characters including a-z, 0-9 and dash. The name will be stored in lower case. This field is required.</td></tr><tr><td>Authority URL</td><td>Enter a valid Https URL up to 1024 characters for an OIDC provider. If Highlight cannot acquire a discovery document for the URL entered, then the URL is not recognised as an OIDC provider. This field is required.</td></tr><tr><td>Client ID</td><td>Enter up to 50 characters for the Client ID. This field is required.</td></tr><tr><td>Client Secret</td><td>This can be up to 1024 characters and is obscured on input. This field is required. </td></tr><tr><td>Email domains</td><td>Enter a comma-separated list of domain names up to 2048 characters in total. This field is required.</td></tr><tr><td>New users</td><td><strong>Create Highlight account for unknown users</strong><br>Check to have Highlight automatically create these accounts if the user has not previously logged in but has passed the authentication checks by the third-party provider. This is useful as new staff joining an organisation will be able to log into Highlight with no other admin intervention.<br>Auto-created users have no expiry date and the standard permissions (which include viewing heat tiles and details page, creating alerts and running reports). Extra admin permissions can be granted by other admin users if required.</td></tr></tbody></table>

### Edit folder - Config Backup

The **Config Backup** accordion sets up Config Backup for every SNMP device in this folder and below: whether it is switched on, the login Highlight uses to read each device's configuration, and the checks that flag a suspicious change. For an introduction to Config Backup, see the[ Config Backup functionality overview](https://help.highlight.net/functionality/config-backup-functionality.md).

**Permission needed:** **Manage folders/locations** to see it. **Edit watches** and **Manage Config Backups** as well, to change it.

<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>

**Why you might not see it**

The accordion is shown only when all of these are true:

* Config Backup has been switched on for your account. Only Highlight can do this, so contact us if you want to use it. Until it is switched on, no Config Backup menu, button or setting is shown anywhere.
* You have the **Manage folders/locations** permission, which you need to edit a folder.
* You are editing an existing folder. The accordion is not shown while you create a folder.
* You are using Consolidated Admin. Classic Admin Browse has no Config Backup settings.

You do not need **Manage Config Backups** to see the accordion, only to change it.

| What you see                                                                                     | Why                                                                                                                                |
| ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| No **Config Backup** accordion                                                                   | Config Backup is not switched on for your account, you do not have **Manage folders/locations**, or you are creating a new folder. |
| The accordion is shown, but the fields are greyed out and there is no **Override** or **Revert** | You are missing **Manage Config Backups** or **Edit watches**. You can see the settings but not change them.                       |
| "Config backup settings are not available for this folder."                                      | Highlight could not load the settings. Close the panel and open it again. If the message stays, contact us.                        |

**How it works**

* A device uses the Config Backup settings of its folder, or of the nearest folder above it that has them, unless the device has its own settings. A banner at the top of the accordion says: "Changes to these settings apply to every device in this folder and below, unless a device has its own settings."
* The **Status** switch, and the **Connection details** and **Sanity checks** together, are two separate groups. Each group shows where its values come from, with an **Override** link. Click **Override** to set values on this folder. The inherited values are copied across to start with, and later changes higher up no longer apply here. Click **Revert**, then save, to remove this folder's own values and inherit again. At the top of the tree there is nothing to inherit, so there is no **Override**. See Override and Revert.
* You can set Config Backup on folders and on individual devices, but not on locations. To set it for one device, see Watch SNMP.
* A device is backed up only if **Status** is **Enabled**, it is an SNMP device with an agent assigned, and it has a username, password and Device Type, set here or higher up. A device that is missing any of these is skipped.
* When backups run is set on each agent, not here. See Agent Tools: Config Backup.

<figure><picture><source srcset="https://25768351-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F68Wb63XzG9guH74bkPEb%2Fuploads%2FHJakApAdCQy66oyQtv1J%2Ffolder-config-backup-inherited-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%2FeVxgPLobKqaqRpCyhF3t%2Ffolder-config-backup-inherited-light.png?alt=media" alt="Config Backup accordion on a folder that inherits its settings: read-only values, with the folder path they come from and an Override link under each group"></picture><figcaption></figcaption></figure>

**The options**

<table><thead><tr><th width="209">Field</th><th>Description</th></tr></thead><tbody><tr><td><strong>Status</strong></td><td><strong>Enabled</strong> or <strong>Disabled</strong>. Switches Config Backup on or off for the devices below. The starting value is <strong>Disabled</strong>.</td></tr><tr><td><strong>SSH Username</strong> and <strong>SSH Password</strong></td><td>The login Highlight uses to reach each device. A read-only login is best, if the device allows it. The password is always shown masked, and typing replaces it.</td></tr><tr><td><strong>Device Type</strong></td><td>The type of device, chosen from an A to Z list of supported types, which also holds <strong>(not set)</strong>. The same type applies to every device below, so use a separate folder for each type, or set Config Backup on each device.</td></tr><tr><td><strong>SSH Kex</strong> and <strong>SSH Host Key</strong></td><td>Optional. Leave them blank unless Highlight Support asks you to complete them.</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. Clear the box to switch this check off.</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. Clear the box to switch this check off.</td></tr></tbody></table>

The sanity checks only flag a change. They do not stop a configuration being stored. See Config Backup History.

**Saving**

* Click **Save**, as for any other change to the folder. The Config Backup settings are saved first.
* After you click **Override** on the connection details, **SSH Username**, **SSH Password** and **Device Type** are required. If one is blank, the save is refused with an **Error saving config backup** message, for example "Config Backup: SSH Username, SSH Password, Device Type must be set.", and the folder is not saved.
* Highlight checks that these three fields are filled in, not that the login works. To test the login, click **Audit now** on a device's Config Backup History.
* The agent collects the latest settings before each run, so a change takes effect at the next backup.


---

# 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/admin/admin-page/folder.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.
