Backup and Restore Security Validation

This is only valid for the MSV (on-prem) version of Security Validation.

You can backup and restore the Security Validation Platform on the Systems Setting page of the Director or by using the platform's API.

Backup and Restore from the Director

Use the following procedures to backup (GUI only) or restore (GUI or API) the platform. Backing up is a best practice before you perform any Director upgrades.

Back up the Platform

  1. Go to Settings > Director Settings. The Systems Settings page opens. 
  2. Locate the Backup/Restore section on the page.
  3. Optional: In the Backup/Restore section, select Include SSL Cert.
  4. Click Download.

    If there is enough available memory, the backup is created and automatically downloads to your computer (an error displays if there are memory issues). The filename includes the Director version and has the following format:

    backup_Director version_unix timestamp_process id.vbk

    The backup file is also available for three days at the following location:

    /opt/apps/verodin/planner/tmp/backup_file_name.vbk

Restore from a system backup

Use the following procedure to restore the Director's database from a system backup.

This procedure is intended to restore the database on a system that is at the same software version as the backup. Any system updates not inline with the same software version as the backup will be lost or potentially corrupted.
  1. Go to Settings > Director Settings. The Systems Settings page opens. 
  2. In the Backup/Restore section, browse for and choose your backup file in the Upload System Backup dialog.
  3. Click Restore. After verifying that a restore process isn't already in process, the restore starts. The system also shows the progress as it loads the backup file.

  4. When the restore completes, update any configurations you changed that weren't included in the backup and check communication with your Actors.

    If you maintain the same IP for the Director, existing Actors and Protected Theaters should automatically work. If you use a different IP, you will need to run vreset on the Actors and Protected Theater and then register them again.

Backup and Restore the Platform using the API

The platform's API supports creating a system backup and restoring the Director from a system backup.

Use the following commands (more details about the processes are available in the API documentation):

  • Create a System Backup (no SSL cert)

    GET /settings/create_backup
  • Create a System Backup (SSL cert)

    GET /settings/create_backup?include_ssl_cert=true
  • Restore the Director from a system backup

    POST /settings/restore_backup
  • June 5, 2022
  • November 10, 2023
In This Article