CLI 2.0 general information

cbbV2 file - is the main file that is required to execute all the commands. So all the commands later in the articles will start with ./cbbV2, presuming that the location of the file is already opened. The file usually is located at:

/opt/local/MSP360 Backup/bin

Help information about cbbV2 can be found by executing these commands:

./cbbV2 --help
./cbbV2 -h

Example:

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

account <command> - account commands:
	add              	- add storage account
	delete           	- delete storage account
	edit             	- edit storage account
	info             	- get storage account details
	list             	- list of existing storage accounts
	sync             	- sync storage account

check_update     	- Check for a new version of program.
config <command> - general settings:
	export           	- export backup configuration to the specific file
	get              	- get the current value for a setting
	import           	- import backup configuration from the file
	set              	- set a new value for a setting

feedback <command> - feedback commands:
	save-log         	- save error report
	send-log         	- send error report

license <command> - license commands:
	activate         	- activate license
	info             	- show info of the current license
	release          	- release current license

plan <command> - plan commands:
	create_backup    	- create a new plan to backup files to storage
	create_restore   	- create a new plan to restore files from storage
	delete           	- delete plan
	details          	- get plan details
	edit_backup      	- edit an existing backup plan
	edit_restore     	- edit an existing restore plan
	list             	- list all plan names and ids
	start            	- run custom plan now
	stop             	- stop plan now

storage <command> - storage commands:
	deep-sync        	- storage deepsync
	delete           	- storage delete backup data
	list             	- storage list

version          	- Show product version

Some commands from the above have their options. It can be found by executing this command without additional options added.

Example: (In this case, we are searching for options for storage delete):

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

delete  - storage delete backup data
Usage: /opt/local/MSP360 Backup/raw_bin/cbbCommandLineV2 [options]

Options:
  -i, --account-id <id>      	Storage account ID
  -a, --account <name>       	Storage account name
  --bunch-id <bunch-id>      	Bunch ID
  -b, --bunch <bunch>        	Bunch name
  -g, --generation <generation>  Generation ID
  -r, --restore <restore>    	Restore point (dd.mm.yy hh:mm)
  --path <path>              	Specifies the path whose contents you would
                             	like to list.
  --limit <limit>            	Specifies the maximum number of items to
                             	display from the top of the list.
  --offset <offset>          	Specifies the offset (number of the items)
                             	from the top of the list to display the number
                             	of items specified by the  - limit parameter.
  --all                      	Show all restore points
  -h, --hint                 	Displays hint for selected generation
  -c, --confirm              	Confirm remove bunch or generation

Some commands have obligatory options, such as -c / --confirm. If they are absent, all such options will be seen in the command’s result.

Example:

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup -n 'test_backup' -s '/boot'
MSP360 Backup Command Line Interface started

Please confirm edit plan: test_backup.

The command requires confirmation (-c). Without it, the CLI will prompt for confirmation.:

ubuntuuser@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup -n 'test_backup' -s '/boot' -c
MSP360 Backup Command Line Interface started


Success.