Create a backup for the Console
You can create a full or partial backup of the Discovery Console for OT data.
Before you begin
Role required: admin
About this task
To create a backup for the Console, you must have admin access.
To support disaster recovery, the Discovery Console for OT generates backup files containing restore data, configuration, and logs. Console administrators can initiate backups and restore the Discovery Console for OT, the Discovery Sensor for OT, and the OT Discovery Collector to their previous states when needed. This enhancement provides reliable disaster recovery capabilities across all system components.
Procedure
-
Navigate to Settings > Export tab.
-
Use the Database section to create a backup of the Console MongoDB.
[Omitted image "database-backup.png"] Alt text: Database backup
-
Select the Backup Type and select from the drop-down menu.
- A Full back up includes:
- entire WebConsole database
- all images
- A Partial backup only includes the collections defined in the
PartialIncludeCollectionssetting inappsettings.json.
- A Full back up includes:
-
If you select a Partial, the downloaded ZIP file, by default, includes only the following collections.
- AssetAutoScans
- AssetDeviceMessages
- AssetDeviceStatistics
- AssetDevices
- AssetProperties
- AssetRevisions
- AssetScanResults
- AssetScanResultsArchive
- AssetScans
- AssetSites
- Assets
- CyberDashboards
- DetectionRules
- DetectionScoreDetails
- Detections
- DeviceErrors
- DevicePolicyStatus
- DeviceScoreDetails
- DeviceWhitelistApplicationPermissions
- Devices
- EthernetVendorOrganizations
- EthernetVendorRanges
- EthernetVendors
- ExternalAssets
- NetworkZones
- Settings
- UnsafePorts Image files aren't included in a Partial backup.
-
Archive data can be included or excluded based on the system configuration.
-
You can set system configurations during the Console installation process.
-
The backup behavior for archived query results is controlled by the following Backup configuration settings in the
appsettings.jsonfile.- If
ExcludeArchiveFromFullis set to true, archived scan results are excluded from the Full backup. - If
ExcludeArchiveFromFullis set to false, archived scan results are included in the Full backup. - If
ExcludeArchiveFromPartialis set to true, archived scan results are excluded from the Partial backup. - If
ExcludeArchiveFromPartialis set to false, archived scan results are included in the Partial backup, provided thatAssetScanResultsArchiveis listed inPartialIncludeCollections.
-
Full backup
- If
ExcludeArchiveFromFull = trueArchive NOT included - If
ExcludeArchiveFromFull = falseArchive INCLUDED
- If
-
Partial backup
Even though
AssetScanResultsArchiveis in your list for backup in configuration:- If
ExcludeArchiveFromPartial = trueArchive NOT included - If
ExcludeArchiveFromPartial = falseArchive INCLUDED
- If
- If
-
After deciding the Backup Type, select the Backup Database button.
[Omitted image "backup-database-button.png"] Alt text: Backup database button
-
When the backup is finished, the screen displays "Database backup completed successfully."
-
A backup ZIP file is available to download.
[Omitted image "ZIP-name.png"] Alt text: ZIP file
-
Select the Download button and the ZIP is downloaded to your local system.
-
Once the file is downloaded, select the delete icon (trash can) to remove the archive and free up disk space on the Console.
Parent Topic:Settings page
---
title: Create a backup for the Console
description: You can create a full or partial backup of the Discovery Console for OT data.
locale: en-US
canonical_url: https://www.servicenow.com/docs/r/australia/operational-technology/console-create-backup.html
release: australia
topic_type: task
last_updated: "2026-09-10"
reading_time_minutes: 2
breadcrumb: [Settings page, Use the Console pages, Discovery Console for OT, Operational Technology Native Discovery components, Operational Technology Discovery, Operational Technology]
---
# Create a backup for the Console
You can create a full or partial backup of the Discovery Console for OT data.
## Before you begin
Role required: admin
## About this task
To create a backup for the Console, you must have **admin** access.
To support disaster recovery, the Discovery Console for OT generates backup files containing restore data, configuration, and logs. Console administrators can initiate backups and restore the Discovery Console for OT, the Discovery Sensor for OT, and the OT Discovery Collector to their previous states when needed. This enhancement provides reliable disaster recovery capabilities across all system components.
## Procedure
1. Navigate to **Settings > Export** tab.
2. Use the **Database** section to create a backup of the Console MongoDB.
\[Omitted image "database-backup.png"\] Alt text: Database backup
3. Select the **Backup Type** and select from the drop-down menu.
- A **Full** back up includes:
- entire WebConsole database
- all images
- A **Partial** backup only includes the collections defined in the `PartialIncludeCollections` setting in `appsettings.json`.
4. If you select a **Partial**, the downloaded ZIP file, by default, includes only the following collections.
- AssetAutoScans
- AssetDeviceMessages
- AssetDeviceStatistics
- AssetDevices
- AssetProperties
- AssetRevisions
- AssetScanResults
- AssetScanResultsArchive
- AssetScans
- AssetSites
- Assets
- CyberDashboards
- DetectionRules
- DetectionScoreDetails
- Detections
- DeviceErrors
- DevicePolicyStatus
- DeviceScoreDetails
- DeviceWhitelistApplicationPermissions
- Devices
- EthernetVendorOrganizations
- EthernetVendorRanges
- EthernetVendors
- ExternalAssets
- NetworkZones
- Settings
- UnsafePorts
Image files aren't included in a Partial backup.
5. Archive data can be included or excluded based on the system configuration.
6. You can set system configurations during the Console installation process.
7. The backup behavior for archived query results is controlled by the following Backup configuration settings in the `appsettings.json` file.
- If `ExcludeArchiveFromFull` is set to **true**, archived scan results are excluded from the Full backup.
- If `ExcludeArchiveFromFull` is set to **false**, archived scan results are included in the Full backup.
- If `ExcludeArchiveFromPartial` is set to **true**, archived scan results are excluded from the Partial backup.
- If `ExcludeArchiveFromPartial` is set to **false**, archived scan results are included in the Partial backup, provided that `AssetScanResultsArchive` is listed in `PartialIncludeCollections`.
1. **Full backup**
- If `ExcludeArchiveFromFull = true` Archive **NOT included**
- If `ExcludeArchiveFromFull = false` Archive **INCLUDED**
2. **Partial backup**
Even though `AssetScanResultsArchive` is in your list for backup in configuration:
- If `ExcludeArchiveFromPartial = true` Archive **NOT included**
- If `ExcludeArchiveFromPartial = false` Archive **INCLUDED**
8. After deciding the **Backup Type**, select the **Backup Database** button.
\[Omitted image "backup-database-button.png"\] Alt text: Backup database button
9. When the backup is finished, the screen displays "Database backup completed successfully."
10. A backup ZIP file is available to download.
\[Omitted image "ZIP-name.png"\] Alt text: ZIP file
11. Select the **Download** button and the ZIP is downloaded to your local system.
12. Once the file is downloaded, select the delete icon \(trash can\) to remove the archive and free up disk space on the Console.
**Parent Topic:**[Settings page](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/operational-technology/settings-page-console.md)
| title | Create a backup for the Console |
| description | You can create a full or partial backup of the Discovery Console for OT data. |
| locale | en-US |
| canonical_url | https://www.servicenow.com/docs/r/australia/operational-technology/console-create-backup.html |
| release | australia |
| topic_type | task |
| last_updated | 2026-09-10 |
| reading_time_minutes | 2 |
| breadcrumb | Settings pageUse the Console pagesDiscovery Console for OTOperational Technology Native Discovery componentsOperational Technology DiscoveryOperational Technology |