This guide describes how to back up and restore Video Management System (VMS) server data for migration or disaster recovery.

Use these instructions for the following scenarios:

• Upgrading, reinstalling, or formatting the operating system (OS) on the server.
• Replacing server hardware (motherboard, network interface card, or hard drives).
• Migrating data to a new physical server.

Prerequisites

Before beginning any backup or recovery procedure, ensure you meet the following requirements:

• Physical Access: You must have physical or direct administrative access to the server.
• Version Compatibility: The target server must run the exact same VMS version as the source server during backup and restore. You can perform an in-client update to the latest version after data recovery succeeds.

Variable Definitions

File paths in this guide use placeholders to account for different OEM products and storage configurations. Replace these variables with your specific environment details:

Path Examples

• Windows: C:\Program Files\<COMPANY_NAME>\<PRODUCT_NAME> becomes C:\Program Files\Network Optix\Nx Witness
• Ubuntu Linux: /opt/<company_name>/mediaserver becomes /opt/networkoptix/mediaserver

Scenario 1: Upgrade or Reinstall a Bootable OS

Use this procedure if the server OS is functional or can boot into Safe Mode.

Step 1: Back up the Data

1. Open the local or remote Desktop Client and log into the server.
2. Back up the site databases and copy your license keys to a plain text file 
   (see Data Backup Reference section below).
3. Record your current storage configuration:
   • Windows: Note the drive letters of all storage partitions.
   • Linux: Note the mount points of all storage partitions.
   • Note: any external storage (CIFS/SMB) mounted as local partitions.
4. Shut down the server, connect an external backup drive, and power the server back on.
5. Stop the VMS Media Server service.
6. Copy the following components from the local filesystem to your external drive:
   • SQLite database files (*.sqlite)
   • Motion and analytics data
   • Custom SSL certificates (if applicable)
   • Media Server configuration parameters (serverGuid, storedMac, authKey)
   • Any recording archives stored on the OS partition

Step 2: Reinstall or Upgrade the OS and VMS

1. Perform the OS upgrade or clean installation.
2. Install the VMS Media Server and Desktop Client software.
3. Stop the VMS Media Server service immediately after installation finishes.

Step 3: Restore the Data

1. Restore your storage configuration within the OS by mapping the original drive letters (Windows), mount points (Linux), or network shares (CIFS/SMB).
2. Copy the *.sqlite files, motion/analytics data, SSL certificates, and OS-partition archives from your external drive back to their original filesystem paths.
3. Verify that the serverGuid, storedMac, and authKey parameters match the original values. If they differ, manually update them to the original values.
4. Start the VMS Media Server service.
5. Open the local Desktop Client and log in.
6. If the server belongs to a multi-server site: Verify the site connection. If the server appears disconnected or isolated, merge it back into the site, then restore the site database.
7. Verify your licenses. If a hardware ID (HWID) change invalidates the keys, reactivate them.
8. Verify the custom SSL certificate. If it is invalid, pin the correct certificate.
9. Go to the Media Server Settings and reindex the archive.

Scenario 2: Reinstall a Non-Bootable OS

Use this procedure if the OS fails to boot due to software corruption, but the underlying hardware is healthy. If you suspect hardware failure, see Scenario 3.

Step 1: Extract the Backup

1. Connect an external drive to the server.
2. Boot the server using a live recovery CD or USB drive.
3. Mount the server's OS partition and verify that the filesystem is accessible.
4. Copy the following components to your external drive:
   • *.sqlite files
   • Motion and analytics data
   • Custom SSL certificates
   • Recording archives from the OS partition
   • Ubuntu only: The mediaserver.conf configuration file.
     • Note: For Windows installations, this configuration resides in the system registry and cannot be extracted if the OS will not boot. Because the original registry values can't be retrieved, you must reactivate license keys and re-add SSL certificates.

Step 2: Reinstall the OS and VMS

1. Attempt to reinstall the OS using Repair Mode. If it boots successfully, proceed to Step 3.
2. If Repair Mode fails, perform a clean OS installation on the partition.
3. If a clean installation fails, format the partition and install the OS. If it still fails to boot, the server has an underlying hardware issue.
4. Complete the initial OS setup, then install the VMS Media Server and Desktop Client.
5. Stop the VMS Media Server service.

Step 3: Restore the Data

1. Copy the *.sqlite files, motion/analytics data, SSL certificates, and OS-partition archives from the external drive back to their original paths.
2. Update the Media Server configurations:
   • Ubuntu: Verify that serverGuid, storedMac, and authKey match the original values. Update them if necessary.
   • Windows: Because the original registry values are missing, you must manually reactivate license keys and re-add SSL certificates after starting the service.
3. Start the VMS Media Server service.
4. Open the local Desktop Client and log in.
5. If the server belongs to a multi-server site: Merge the server back into the site if needed, then restore the site database.
6. Verify your storage paths. If any paths are invalid:
   • Note the expected storage locations and mount points in the Media Server Settings.
   • Stop the VMS Media Server service.
   • Correct the drive letters, mount points, or network shares in the OS.
   • Restart the VMS media server service.
7. Go to Media Server Settings and reindex the archive.
8. Reactivate any invalidated license keys.
9. Verify and pin your custom SSL certificate.

Scenario 3: Replace Server Hardware

Replace Hard Drives

The most efficient method to replace a hard drive is to clone the source drive directly to the new drive using tools such as Clonezilla or Rescuezilla, or the Linux dd utility.

If the source drive is severely corrupted, cloning may fail. If cloning fails, follow the steps in Scenario 2: Reinstall a Non-Bootable OS.

Replace Motherboard or Network Card

Replacing a motherboard or network interface card alters the system's Hardware ID (HWID), which automatically invalidates your VMS licenses.

1. Open the local or remote Desktop Client, log into the server, and back up the site database.
2. Deactivate your license keys so you can reactivate them on the new hardware.
3. Record your storage configuration (drive letters, mount points, and network shares).
4. Stop the VMS Media Server service and back up the *.sqlite files, motion/analytics data, SSL certificates, and OS-partition archives to an external drive.
5. Replace the hardware components and boot the server.
   • If the OS fails to boot after the hardware swap, follow Scenario 2.
   • If the OS boots successfully, open the Desktop Client.
6. Reconnect the server to your site if necessary, reactivate your license keys, verify your SSL certificates, and reindex your storage archives.

Replace Other Components

Replacing components like RAM, CPUs, or power supplies does not affect the VMS configuration or software licenses. No special backup steps are required.

Scenario 4: Migrate to a New Server

Use this procedure to move your entire VMS installation to a completely new physical computer. The new computer must have an equal or greater number of physical hard drives than the source server.

1. Open the local or remote Desktop Client and back up the site database.
2. Deactivate your license keys on the source server.
3. Shut down the source server.
4. Temporarily connect the hard drives from the new computer to the old computer, then boot up the old computer.
5. Clone each original drive to its corresponding new drive. Label the new drives carefully during this process (e.g., OS Partition, Storage Drive D:).
6. Disconnect the newly cloned drives and install them into the new computer.
7. Configure the new computer's BIOS/UEFI to boot from the cloned OS drive, then power on the new server.
   • If the new hardware causes a boot failure, follow Scenario 2.
8. Once the OS boots successfully, verify that all storage drive letters and mount points match the original layout.
9. Open the Desktop Client, verify your storage information, reindex the archive, and reactivate your license keys.

Data Backup Reference

Critical: Always save backup files to an external storage drive or separate disk partition. Do not save backups to the same partition you are formatting or modifying.

Data Backup and Restore Matrix