Description of file names and parameters used in the example

Primary site

Command: mmbackupconfig

Usage: mmbackupconfig Device -o OutputFile
Table 1. Parameter description
Name Description
file_system_name (Device) Name of the file system to be backed up
filesystem_backup_config_file (OutputFile) A unique file name that holds information for a specific backed-up file system:
  • You will create a unique name (filesystem_backup_config_file) for each backed-up file system (which means you run this command once for each file system you want to back up)

Command: mcstore_sobar_backup.sh

Usage: mcstore_sobar_backup.sh <file_system_names> <sharing_container_pairset_name> <node_class_name> <global_filesystem_directory>.
Table 2. Parameter description
Name Description
file_system_names A comma-separated list of file systems to back up when using the mcstore_backup.sh script:
  • As of IBM Storage Scale release 5.0.1.0, using multiple file names in this script will run backups in series.
  • Cloud services nodes chosen automatically share the workload for creating the backups.
sharing_container_pair_set_name The name of a shared cloud container that is created and is accessed by both the primary and recovery clusters. This container must be large enough to accommodate space that is calculated according to this formula: 4 KB x number of inodes of all backed-up file systems. For example, if the number of inodes of the backed-up file system is 1000, then the recommended size of the container should be (4x1000)=4000 KB.
node_class_names The names of the Cloud services node classes associated with this backup.
global_filesystem_directory This is a working directory that is used to store data for the backups:
  • It is recommended to use a directory of a GPFS file system that is accessible by all nodes in the cluster to avoid possible local root file system overload.
  • It is also acceptable to use the GPFS file system that is being backed up (as long as sufficient space exists).

Command: mmcloudgateway service backupConfig --backup-file <BackupFile>, where BackupFile is a file used specifically for backing up all the Cloud services configuration data of all the node classes on the primary site.

Recovery Site

Command: mmrestoreconfig

Usage (to create a restore_out_file): mmrestoreconfig Device -i InputFile -F QueryResultFile

Usage (to restore image): mmrestoreconfig Device -i InputFile --image-restore

Table 3. Parameter description
Name Description
file_system Name of file systems to be recovered (matching backed up file systems)
filesystem_backup_config_file The file systems backups that you created on the primary and transferred to the recovery site.

Command: mcstore_sobar_download.sh

Usage: mcstore_sobar_download.sh <tct_config_backup_path> <sharing_container_pairset_name> <node_class_name> <sobar_backup_tar_name> <local_backup_dir>

Table 4. Parameter description
Name Description
tct_backup_config_path Path on the recovery site that has the Cloud services backup tar file that was generated with the mmcloudgateway service backupConfig command and securely transferred to a recovery site Cloud services node by the user.
sharing_container_pairset_name The sharing container that you created as a prerequisite to this procedure.
node-class-name The name of the Cloud services node class that is restored.
sobar_backup_tar_name The name of the .tar file that was generated by the mcstore_sobar_backup.sh script on the primary site, and transferred to the sharing container.
local_backup_dir A directory of your choice that is large enough to accept the 'SOBAR'.tar file. It is recommended to use a GPFS file system.

Command: mcstore_sobar_restore.sh

Usage: mcstore_sobar_restore.sh <sobar_backup_path> <file_system_name> <node_class_name> <rebuilddb_required: yes/no> <global_filesystem_directory>
Table 5. Parameter description
Name Description
sobar_backup_path Path to the 'SOBAR'.tar as designated by the mcstore_sobar_download.sh script.
file_system_name File system that is being restored
node_class_name Name of the Cloud services node class that is being restored.
rebuilddb_required Yes/no if a rebuild of the Cloud services metadata database is required. If you have Cloud services metadata database file systems separated from your data-only file systems, you will need to back them up as well.
global_filesystem_directory The path to the file system that is shared with the primary site via the sharing container pair set.