Skip to content

Backup Internal Object Store

Before you start

Goal

  • Take a backup of the Altair SLC Hub internal object store

Prerequisites

  • If you are using Windows, you will need to login as a user that is a member of the Administrators group, and the command prompt must be started 'as Administrator'. These steps will permit use of the hubctl command.
  • Before backing up the internal object store, you must first complete backups of:

Backup the internal object store

Firstly, ensure that the internal object store service (slchub.objstore) is running. To verify this, check the output of the following command shows an Active state of 'Active':

hubctl service status objstore

If the internal object store service is not running, start it by running:

hubctl service start objstore

With the internal object store service running, you can now take a backup. By default, a ZIP file will be output to [var directory]/backups/internalobjstore and include a timestamp in the filename. Optionally, you can specify a different location and filename by providing a filepath as an argument to the backup command, such as:

hubctl backup internalobjstore
or to specify a custom location: 
hubctl backup internalobjstore /var/slc-hub/backups/objectstore_backup_20250707T123045.zip


hubctl backup internalobjstore
or to specify a custom location: 
hubctl backup internalobjstore "C:\slc-hub\backups\objectstore_backup_20250707T123045.zip"

By default, the backup is compressed in a ZIP file. To skip compression and create an uncompressed backup directory, supply the --nocompress option:

hubctl backup internalobjstore --nocompress /var/slc-hub/backups/objectstore_backup_20250707T123045

hubctl backup internalobjstore --nocompress "C:\slc-hub\backups\objectstore_backup_20250707T123045"

Keep the backup file or directory in a safe location, or copy it to a different system.

Verification

Verify backup

  • Check the output from hubctl backup internalobjstore
  • You should see a message reading object store backup completed successfully to: ...
  • Verify that the backup file or directory exists at the specified location