Skip to main content
Version: vStor 4.14

Backing up Configuration Settings of Catalogic vStor

Backing up the Catalogic vStor configuration is crucial for server recovery after a failure. The configuration, which includes the current state of volumes and snapshots, database configuration, replication shares, scheduled replications, SSH information, etc., is automatically backed up every 24 hours and stored on a designated configbackup volume. This volume can also be replicated to a partner vStor server. Additionally, a local copy is saved at:

/opt/vstor/backup/vstor_config_<date_and_time>.tar.gz

A vStor server’s configuration is backed up automatically every 24 hours. That backup is retained for 14 days. This retention period may be modified in the system preferences by going to System > Preferences > Edit and entering a new value for configBackupRetentionDays.

Tip.

The automatic vStor server configuration backup can be disabled by entering 0 for configBackupRententionDays.

Backing up the Catalogic vStor configuration​

The latest backup determines the accuracy of your vStor server’s state. If you do not back up after making changes, those changes might be lost in case the server fails or gets corrupted.

If you replicate your configuration volume to a partner vStor (strongly recommended), make sure to schedule the replication shortly after the configuration backup, ensuring the most up-to-date version is always stored on the partner vStor.

Prerequisites​

  1. Create and Initialize a Pool: Make sure you have a pool set up.
  2. Establish a Partnership: Have at least one partnership with another Catalogic vStor server.

Running backup manually​

  1. Log in to the vStor Server:
    • Use SSH or the console.
    • Log in as admin.
  2. Run the Backup Command:
    • Use command: vstor system saveconfig
    • A file will be saved in /opt/vstor/backup.
    • Filename format: vstor_config_<date_and_time>.tar.gz.
  3. Backup Volume Details:
    • In vStor UI, you will see a configbackup volume for each pool, named config_volume_pool_<#>-<vstor_system_id>.
    • <#> = pool number, <vstor_system_id> = system ID of your vStor server.
    • When replicated to a partner server, it appears as a filesystem-type volume.
  4. Optional – Mounting for Tape Backup:
    • The configuration volume can also be mounted via NFS for tape backup.
See also.

For more details on best practices for data backup, see Data Backup: Best Practices.