Platform: LinuxProducts: MSP360 Backup
Article ID: s0464Last Modified: 19-Jun-2025
Edit Backup Plans (CLI 2.0)
As of Backup 4.0 for Linux, a new command line interface (CLI V2)is introduced. CLI V2 is a separate command line interface solution that has the enhanced functionality that covers the new backup format requirements.
Note that editing backup plans in the new backup format is available in the CLI v2 only
Edit File Backup Plan Using CLI V2 (new and current backup formats)
To edit a new backup plan, use the plan edit_backup command.
Example:
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup --name "test_backup" --account "s3_test" --source "/home/user/test data" --confirm
MSP360 Backup Command Line Interface started
Success.
This chapter covers the following topics:
Command Parameters
All command parameters can be found by executing the following command (command's results here are in a short form, since the command has numerous parameters):
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup
MSP360 Backup Command Line Interface started
edit_backup - edit an existing backup plan
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”
-i, --id <planId> Backup plan ID
-c, --confirm Confirm create or edit
plan
-a, --account <accountName> Storage account. Possible
values: AccountID or
AccountName
...
Command examples
Enable server-side encryption
About the command:
--sse <true/false> Sets the server-side
encryption mode. Applies
to Amazon S3 storage only,
Possible values: true,
false (default)
Example:
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup -n "test_backup" --sse true -c
MSP360 Backup Command Line Interface started
Success.
Set the threshold period in minutes for a full backup plan execution:
About the command:
--full-stop-auto-hours-value <hours> Sets the threshold period
in hours for a full backup
plan execution. Possible
values: integer, range
0-24.
--full-stop-auto-minutes-value <minutes> Sets the threshold period
in minutes for a full
backup plan execution.
Possible values: integer,
range 0-60.
Example:
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup -n "test_backup" --full-stop-auto-option true --full-stop-auto-minutes-value 44 -c
MSP360 Backup Command Line Interface started
Success.
Change backup source
The source used to be: /home/user/test data, now it should be: /home/user/Desktop, then the command will be:
About the command:
-s, --source <backupSource> Sets backup source(s).
Repeatable parameter.
Example: -- source “path1”
--source “path2” --source
“path3”
Example:
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup --name "test_backup" --source "/home/user/Desktop" --confirm
MSP360 Backup Command Line Interface started
Success.
The command completely replace the previous source with files / folders, listed in the command.
Enable compression
About the command:
--compression <true/false> Enables compression.
Possible values: true
(default), false
Example:
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup --name "test_backup" --compression true --confirm
MSP360 Backup Command Line Interface started
This changes will force a Full backup.
Success.
Exclude items
Do not use a backslash () at the end of the path. The source used to be: /home/user/ and contained folders: /home/user/data-store and /home/user/Desktop. In the example we are excluding: /home/user/Desktop.
About the command:
--exclude <excludeFiles> Excludes files and
directories from backup
dataset. Repeatable
parameter. Example:
--exclude “path1”
--exclude “path2”
--exclude “path3”
Example:
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup --name "test_backup" --exclude "/home/user/Desktop" --confirm
MSP360 Backup Command Line Interface started
Success.
Set schedule to backup every day at 13:00
About the command:
--schedule <true/false> Enables schedule for the
plan. Possible values:
true, false (default)
--specific-date-option <true/false> Runs the plan on a
specific date. Applies to
the current backup format
only. Possible values:
true, false (default)
--specific-date-value <date> Runs backup plan on
specific date and time.
Applies to the current
backup format only.
Example:
--specific-date-value
“03.04.2022 14:05”
--stop-auto-option <true/false> Enables plan stopping if
it runs more than
specified period. Possible
values: true, false
(default)
--stop-auto-hours-value <hours> Sets the value in hours
for the
--stop-auto-option. Value
range: 0-99. Example:
--stop-auto-option “true”
--stop-auto-hours value
“6”
--stop-auto-minutes-value <minutes> Sets the value in minutes
for the
--stop-auto-option. Value
range: 0-59. Example:
--stop-auto-option “true”
--stop-auto-hours value
“5”
--stop-auto-minutes-value
“45”
--use-recurring-option <true/false> Enables recurring
schedule usage. Applies to
the current backup format
only. Possible values:
true, false (default)
--frequency-value <value> Sets the frequency value
for recurring schedule.
Possible values (Daily,
Weekly, Monthly)
--occurs-at-option <true/false> Enables/disables the
backup plan execution at
specific time. This
parameter is used with the
--frequency-value set
“Daily”. Possible values:
true, false
--occurs-at-value <value> Sets the date and time of
the backup plan execution.
This parameter is used
with the --frequency-value
set “Daily” and the
--occurs-at-option set
“true”
--occurs-every-option <option> Sets the time in minutes
for the
--occurs-every-option
parameter. Possible
values: integer, value
range 1-60. This parameter
is used with schedule
frequency set as daily
--occurs-every-value <value> Sets the time in minutes
for the
--occurs-every-option
parameter. Possible
values: integer, value
range 1-60. This parameter
is used with schedule
frequency set as daily
--occurs-every-from <value> Sets the start date and
time the occurs every
option is enabled.
Example:
--occurs-every-from
“11:30”
--occurs-every-to <value> Sets the date and time
the ‘occurs every’ option
is enabled until. Example:
--occurs-every-to “23:00”
--week-day-numbers <numbers> Sets the day of the week
the backup plan is
executed. Possible values,
integer, range 1-7. This
parameter is used with the
--frequency-value=Weekly
parameter.
--monthly-type-value <value> Sets the type of monthly
backup execution. Possible
values: 0-6. If 0 is set,
backup will be executed
every month on the day
specified by --monthly-day
parameter. If values in
1-6 [First, Second, Third,
Fourth, Penultimate, Last]
range are set, backup will
be executed every month on
the specific week (e.g
first week, second week,
etc ..) on the day
specified by --monthly-day
parameter.
--monthly-day <day> Sets the day of the week
for recurring incremental
backup execution. Value
range: 1-7. This parameter
can be used only with
--frequency-value=Monthly
--monthly-every <value> Sets the month for
recurring incremental
backup execution. Value
range: 1-12. This
parameter can be used only
with
--frequency-value=Monthly
--monthly-repeat-from <value> Sets the specific date
for recurring incremental
backup execution. Value
format: “dd.mm.yyyy”. This
parameter can be used only
with
Example:
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup --name "test_backup" --schedule true --frequency-value Daily --occurs-at-value 13:00 --confirm
MSP360 Backup Command Line Interface started
Success.
Disable schedule
About the command:
--schedule <true/false> Enables schedule for the
plan. Possible values:
true, false (default)
Example:
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan edit_backup --name "test_backup" --schedule false --confirm
MSP360 Backup Command Line Interface started
Success.
Full list of parameters available for editing can be viewed in the following article.
Run Backup Plan
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan start -n "test_backup"
MSP360 Backup Command Line Interface started
Success.
Stop Backup Plan
ubuntu@ubuntu:/opt/local/MSP360 Backup/bin$ ./cbbV2 plan stop -n "test_backup"
MSP360 Backup Command Line Interface started
Success.