Create a backup for the Console

  • Release version: Australia
  • Updated April 23, 2026
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Create a backup for the Console

    ServiceNow customers using the Discovery Console for OT can create full or partial backups of their Console data, including restore data, configuration, and logs. This capability supports disaster recovery by enabling administrators to restore the Discovery Console for OT, Discovery Sensor for OT, and OT Discovery Collector to previous states as needed. Admin access is required to initiate backups.

    Show full answer Show less

    Backup Options and Configuration

    Backups are created from the Settings > Export tab within the Console, specifically targeting the Console MongoDB. Customers can choose between two backup types:

    • Full backup: Contains the entire WebConsole database and all images.
    • Partial backup: Includes only specific database collections defined in the PartialIncludeCollections setting in the appsettings.json file. Image files are not included.

    The default collections included in a partial backup cover key asset, device, detection, and network data relevant to OT operations.

    Archive Data Inclusion

    Backup behavior for archived scan results can be controlled through configuration settings in appsettings.json:

    • ExcludeArchiveFromFull: When true, archived data is excluded from full backups; when false, it is included.
    • ExcludeArchiveFromPartial: When true, archived data is excluded from partial backups; when false, it is included if AssetScanResultsArchive is in the partial backup collections list.

    Backup Process and Management

    • Select the desired backup type and click the Backup Database button.
    • Upon successful backup, a ZIP file becomes available for download.
    • Download the backup ZIP file to your local system for safekeeping.
    • Optionally, delete the backup archive from the Console to free disk space after download.

    This process ensures reliable backup and recovery of critical OT discovery data and configurations within the ServiceNow Discovery Console for OT environment.

    You can create a full or partial backup of the Discovery Console for OT data.

    Creating a Console backup

    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.

    To create a backup of the Discovery Console for OT:

    1. Navigate to Settings > Export tab.
    2. Use the Database section to create a backup of the Console MongoDB.

      Database section
    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 are not 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.
      • Full backup:
        • If ExcludeArchiveFromFull = true Archive NOT included
        • If ExcludeArchiveFromFull = false Archive INCLUDED
      • 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.

      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.

      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 () to remove the archive and free up disk space on the Console.