|
CloudBerry Backup command line interface allows to setup backup plan, edit plan
and global options, restore files from S3 account, etc. Command line interface
can be used for integrating backup process into production environment.
Example shows basic usage of command line interface:
Example 1:
Set global key and secret key (the same as setting File->Amazon S3 Account...)
cbb.exe –o –k ADSIOUJOPWEJKFWEOIDJPWO –s MqlGHAl7nz8CabdsSYJbDFE9345FEa7UifQsLxeR
Example 2:
Setup backup plan. Backup plan for backuping files “C:\work\weekreport.xls” & “C:\work\month.xls” and folder “C:\Documents and Settings\scott” will be created. Files filter, purge options and plan name are set.
cbb.exe –b –k ADSIOUJOPWEJKFWEOIDJPWO –s
MqlGHAl7nz8CabdsSYJbDFE9345FEa7UifQsLxeR –b mybucket –p avnout –f “C:\work\weekreport.xls” –f “C:\work\month.xls” –d “C:\Documents and Settings\scott” –bm “*.doc;*.docx;*.xls;*.txt;*.jpg;*.png” –es yes –ca no –purge 5m –n “Documents backup”
Example 3:
Restore files from S3
Latest versions of files from mybucket will be restored to “c:\restoredfiles\”.
cbb.exe –b –k ADSIOUJOPWEJKFWEOIDJPWO –s SDLKHFLKSJDHFWEM23749087239 –b mybucket –p avnout –rt latest –rl “c:\restoredfiles\” –o –f “C:\work\weekreport.xls” –d “C:\Documents and Settings\scott\2009may”
Setting global options (-o):
Commands splitted into groups global options, backup options, restore options, list and exectute.
| Parameter |
Description |
Value |
| -lk |
License key
Not available in beta3
|
|
| -k(ey)
|
Amazon S3 access key
|
|
| -s(ecret)
|
Amazon S3
secret key
|
|
| -b(ucket) |
Existing
bucket name.
Creation of a new bucket
and checking whether bucket exists are not supported in beta 3
|
|
| -p(refix) |
A folder on
S3 bucket which is used for backup. |
|
|
-ssl
|
Use SSL
|
yes,no
|
|
-bw(andwidth)
|
|
Unlimited(u), 1-100000
|
|
-proxy
|
|
no, auto,
manual
|
|
-pa
|
Proxy
address
|
|
|
-pp
|
Proxy port
|
|
|
-pt
|
Proxy
authentication
|
yes,no
|
|
-pu
|
Proxy user
|
|
|
-pd
|
Proxy domain
|
|
|
-ps
|
Proxy
password
|
|
| -purge |
Purge
versions that are older than specified period
|
no,
1d(w,m,y) where d=days, w=weeks, m=months, y =years; Range [1-400]
|
| -keep
|
Keep number
of versions
|
all, 1-100
|
| -hp
|
Purge
history
|
no,
1d(w,m,y) where d=days, w=weeks, m=months, y =years; Range [1-400]
|
|
-hk
|
Keep number
of records in history
|
all, 1-100
|
|
-l(ogging)
|
Logging
level
|
no,l(ow),h(igh),d(ebug)
|
Setting backup plan options (-b):
| Parameter |
Description |
Value |
|
-planname |
Existing plan name |
Error if two parameters
specified |
|
|
-planid |
Existing plan id |
|
|
-newplan |
Create new plan |
|
|
-delete |
Delete backup plan |
|
|
-default |
Use default connection
settings (key, secret, bucket, prefix) |
|
|
-k(ey) |
Amazon S3 access key |
|
|
-s(ecret) |
Amazon S3 secret key |
|
|
-b(ucket) |
Bucket name where to backup
to |
|
|
-p(refix) |
A folder on S3 bucket which
is used for backup |
|
|
-f(ile) |
Backup file |
|
|
-d(irectory) |
Backup directory |
|
|
-rf |
Remove file from backup list |
|
| -rd |
Remove directory from backup
list |
|
| -ba |
Backup all |
Error if two parameters specified |
No value |
|
-bm |
Backup files mask |
|
| -ebm |
Except backup files mask |
|
|
-es |
Except system and hidden files |
yes,no |
| -ca |
Compress all (“no” by default) |
Error if two parameters
specified |
yes,no |
|
-cm |
Compress mask |
|
| -ecm |
Do not compress mask |
|
| -e(ncryption) |
Encryption algorithm |
no,aes128,des64,rc240,3des112,… |
|
-ep |
Encryption password |
|
|
-purge |
Purge versions that are older
then specified period |
no,default, 1d(w,m,y) where d=days, w=weeks, m=months, y =years |
|
-keep |
Keep number of versions |
all, default, 1- 100 |
|
-n(ame) |
Set plan name |
|
|
Schedule properties (not
available in beta 3) |
|
-st |
Schedule type |
no,d(aily),m(onthly),w(eekly) |
|
-sds |
Schedule daily start time |
One of |
10:15 |
|
-sdf |
Schedule daily frequency |
1m, 5h |
|
-swd |
Schedule weekly days |
m,tu,w,th,f,sa,su |
|
-smd |
Schedule month day |
< |
Setting restore options (-r):
|
Parameter |
Description |
Value |
| -k(ey) |
Amazon S3 access key |
|
| -s(ecret) |
Amazon S3 secret key |
|
|
-b(ucket) |
Bucket name |
|
|
-p(refix) |
A folder on S3 bucket which is used for backup |
|
|
-default |
Use default connection settings (key, secret, bucket, prefix) |
|
|
-rt |
Restore type |
latest (default), Date time |
|
-rl |
Restore location |
original (default), “path” |
|
-o(verwrite) |
Overwrite existing files |
yes,no |
|
-ep |
Encryption password |
|
|
-f(ile) |
Restore file |
|
|
-d(irectory) |
Restore directory |
|
| -v(ersion) |
Restore file version |
Currently not supported in beta3!
c:\docs\report.docx:20090712183312 (report.docx version, modified 2009.07.12
18:33.12). |
Plan listing (-l):
Lists all available plans (name and id)
Integrated help usage:
- General Command help:
cbb.exe
or
cbb.exe -?
- Command help:
Plan starting:
“CBBackupPlan.exe” <plan id>
<plan id> can be determined using:
- cbb.exe –b –planname “Existing plan name”
or
- cbb.exe -l (command will list all backup plans)
|