Platform: LinuxProducts: MSP360 Backup
Article ID: s0466Last Modified: 31-Aug-2025

Create Restore Plans (CLI 2.0)

As of Backup 4.0 for Linux, a new command line interface (CLI 2.0) is introduced. CLI 2.0 is a separate command line interface solution that has the enhanced functionality that covers the new backup format requirements.

Create Restore Plan Using CLI 2.0 (new and current backup formats)

To create a new restore plan, use the plan create_restore file command.

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan create_restore --name "local NBF" --account "s3_test" --source "/home/user/test data/cbb_SettingsMigration.log" --restore-location "/home/user/Documents" --latest-version "true" --confirm
MSP360 Backup Command Line Interface started

Success.

The command has mandatory parameters that will be shown if absent:

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan create_restore --name "local NBF" --account "s3_test" --source "/home/user/test data/cbb_SettingsMigration.log" --confirm
MSP360 Backup Command Line Interface started

Options [ latest-version ] or [ restore-point ] is mandatory

This chapter covers the following topics:

Command Parameters

All command parameters can be found by executing the following command (command results here are in a short form, since the command has numerous parameters):

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan create_restore
MSP360 Backup Command Line Interface started

create_restore  - create a new plan to restore files from storage
Usage: /opt/local/MSP360 Backup/raw_bin/cbbCommandLineV2 [options]

Options:
  -n, --name <planName>                           	Backup plan name. Default
                                                  	value is “Backup plan
                                                  	dd.mm.yyyy hh:mm:ss”
  -c, --confirm                                   	Confirm create or edit
                                                  	plan
  -a, --account <accountName>                     	Storage account. Possible
                                                  	values: AccountID or
                                                  	AccountName
  --sync <syncBeforeRun>                          	Runs sync before restore
                                                  	plan run. Possible values:
                                                  	on, off (default)
  -s, --source <backupSource>                     	Sets backup source(s).
                                                  	Repeatable parameter.
                                                  	Example: -- source “path1”
                                                  	--source “path2” --source
                                                  	“path3”
  --latest-version                                	Restores the latest
                                                  	version
  --restore-point <restorePoint>                  	Restore point. Display
                                                  	format: dd.mm.yyyy hh:mm
                                                  	or mm/dd/yy hh:mm AP
  --restore-location <location>                   	Sets the path to restore
  --overwrite-files <true/false>                  	Overwrite existing files
                                                  	upon restore. Possible
                                                  	values: true/false
  --latest-version                                	Restores the latest
                                                  	version
  --restore-point <restorePoint>                  	Restore point. Display
                                                  	format: dd.mm.yyyy hh:mm
                                                  	or mm/dd/yy hh:mm AP
  --restore-location <location>                   	Sets the path to restore
  --overwrite-files <true/false>                  	Overwrite existing files
                                                  	upon restore. Possible
                                                  	values: true/false

| Top |

Create Restore Plan Command Examples

"--bunch" parameter is mandatory for restore from backup plans in the new backup format

If a backup plan is created with this parameter - this will be a restore plan for a New Backup Format. If this parameter is absent, by default the backup plan will be created for the current backup format.

The description of the --bunch parameter:

  --bunch <Bunch>                                 	Bunch (backup plan)  ID
                                                  	or plan name. Applies to
                                                  	the new backup format only

| Top |

Create Restore Plan in the New Backup Format

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan create_restore --bunch "local NBF" --account "s3_test" --source "/home/user/test data/cbb_SettingsMigration.log" --restore-location "/home/user/Documents" --latest-version "true" --confirm
MSP360 Backup Command Line Interface started

Success.

Create Backup Plan in the current backup format

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan create_restore -a "local" -s "/home/user/test data/cbb_SettingsMigration.log" --restore-location "/home/user/" --latest-version "true" -c
MSP360 Backup Command Line Interface started

Success.

| Top |

Run restore Plan

View the command examples to execute restore plans:

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan start -n "test restore"
MSP360 Backup Command Line Interface started

Success.

Stop Restore Plan

View the command examples to stop running restore plans:

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan stop -n "test restore"
MSP360 Backup Command Line Interface started

Success.

| Top |

List all existing restore plans (check restore plan status)

To list all existing backup plans, use command list -r:

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan list
MSP360 Backup Command Line Interface started

list  - list all plan names and ids
Usage: /opt/local/MSP360 Backup/raw_bin/cbbCommandLineV2 [options]

Options:
  -b, --backup   Lists existing backup plans
  -r, --restore  Lists existing restore plans

Example of the command execution:

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan list -r
MSP360 Backup Command Line Interface started

Restore plan list
1 : Display name: test restore
	Id: {fd3baed2-f205-435f-8418-0048428972f6}
	Type: File
	Status: Stopped
	Last run status: Success
	Last run time: Fri Aug 15 14:21:45 2025 GMT

Success.

As it can be seen, this command also demostrates the Status parameter that can be used to check the current restore plan state.

| Top |

Check restore plan details

Plan's details can be checked using details command:

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan details
MSP360 Backup Command Line Interface started

details  - get plan details
Usage: /opt/local/MSP360 Backup/raw_bin/cbbCommandLineV2 [options]

Options:
  -i, --id <planId>  	Plan ID
  -n, --name <planName>  Plan name
  --progress         	Add progress info to details

The example of the command's execution:

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan details -n "test restore"
MSP360 Backup Command Line Interface started

Name             	: test restore
Type             	: Restore
ID               	: {fd3baed2-f205-435f-8418-0048428972f6}
Destination ID   	: {932691e0-bdaf-4d22-8cbe-2d812238c0b4}
Destination name 	: local
Notification: disabled
Restore items:
	/home/anastasia/test data/cbb_SettingsMigration (10th copy).log
Restore type     	: Last Version
Restore to original location: false
Restore destination  : /home/anastasia/
Encryption password  : Is not specified!
Only new files   	: false
Skip existing files  : true
Schedule         	: Not scheduled
Run missed plan  	: false
Stop plan after  	: false

Success.

| Top |

https://git.cloudberrylab.com/egor.m/doc-help-std.git
Production