Configure Global Settings

Configure Settings with CLI 2.0

Configure settings of Backup for macOS using CLI 2.0 commands (recommended).

All application settings are configured using the following command: ./cbbV2 config set

Configure Symlink Backup

To configure symlinks settings, execute the following command:

./cbbV2 config set symlinksbackup --mode "modevalue"

where:

Parameter Description Value
-mode Symlink backup settings Ignore, SymlinkOnly, CurrentPlace, OriginalPlaces, OriginalPlaceAndSymlink

Memory usage

To limit the amount of memory usage (the default is 100 MB), execute the following command:

./cbbV2 config set memoryusage --value "value"

The memory usage value is set in MB.

Ignore SSL Certificates

To ignore SSL certificates, execute the following command:

./cbbV2 config set ignoressl --value "value"

Possible values:

  • yes
  • no

Proxy Settings

To configure proxy settings, execute the following command:

./cbbV2 config set proxy --address "proxy IP address" --port "port number" --type "proxy type" --authentication "value" -- user "Username" --password "Password" 
Parameter Description Value
--address Proxy address String
--port Proxy port Number
--authentication enables/disables authentication on proxy server true (default), false
--user Username on proxy String
--password Password on proxy String

Chunk Size

To specify the default chunk size for multi-part upload, execute the following command:

./cbbV2 config set chunksize "Value"

The chunk size value is specified in bytes.

Directory for Temporary Chunks

To specify the directory where file chunks will be temporarily kept while being processed (the default is /tmp), execute the following command:

./cbbV2 config set chunkpath "Value"

Possible values: a valid path to a directory.

Queue Size

To specify the default queue size for restoring from long-term storage (Glacier-Flexible Retrieval, Deep Archive) (the default is 2000), execute the following command:

./cbbV2 config set queuesize "Value"

It takes approximately four hours to list files in the Glacier family storage classes. If the number of files to restore exceeds the queue size, you will repeatedly wait for four hours every time CloudBerry Backup restores one queue. In other words, if queue size equals 2000, and the number of files to be restored is 6000, you will wait for at least 12 hours to complete a restore

Set Number of Threads

To set the number of threads, use the following command:

./cbbV2 config set threadcount "Value"

Possible values: integer, >0

Limit Bandwidth to Cloud Storage

To limit the bandwidth to cloud storage, execute the following command:

./cbbV2 config set bandwidthcloud --limit "Value"

Possible values:

  • bandwidth in kilobytes or unlimited (-u)

Limit Bandwidth to Local Storage

To the bandwidth to local storage, execute the following command:

./cbbV2 config set bandwidthlocal --limit "Value"

where:

Possible values:

  • bandwidth in kilobytes or unlimited (-u)

Email Notifications

To configure default values for email notifications, execute the following command:

./cbbV2 config set notification --mail "email address" --user "Displayed user name"

Configure Settings with Classic CLI (current backup format only)

Symlinks Management

To configure symlinks settings, execute the following command:

./cbb option -set symlinkbackup -mode preferredMode

where:

Parameter Description Value
-mode Defines backup management mode Ignore / SymlinkOnly / CurrentPlace / OriginalPlaces

Enabling Web Access

To enable web access, execute the following command:

./cbb option -set wa -http on -http_port port -https on -https_port port

where:

Parameter Description Value
wa Indicates that Web Access settings are being configured
-http Enables http connection to to web interface on / off
-http_port Specifies the port for http connection. Should only be indicated in conjunction with -http Port
-https Enables https connection to to web interface on / off
-https_port Specifies the port for https connection. Should only be indicated in conjunction with -https on / off

Memory usage

To limit the amount of memory usage (the default is 100 MB), execute the following command:

./cbb option -set mu -v number

where:

Parameter Description Value
mu Indicates that memory usage is to be limited
-v The amount of RAM allowed to be used by a Backup worker process (in bytes) Number

Ignoring SSL Certificates

To instruct MSP360 (CloudBerry) Backup to ignore SSL certificates, execute the following command:

./cbb option -set ignoressl -v yes/no

where:

Parameter Description Value
ignoressl Indicates that SSL certificates must be ignored
-v Specifies if SSL certificates should be ignored yes / no

Configuring Proxy Settings

To configure proxy settings, execute the following command:

./cbb option -set ps -pt manual -pa proxyAddress -pp proxyPort -pu proxyUser -ps proxyPassword
Parameter Description Value
ps Indicates that proxy settings are being configured
-pa Proxy address String
-pp Proxy port Number
-pu Proxy user String
-ps Proxy password String

Specifying Chunk Size

To specify the default chunk size for multi-part upload, execute the following command:

./cbb option -set cs -v number

where:

Parameter Description Value
cs Indicates that chunk size is to be specified
-v The value for the default chunk size Number of bytes. Must represent powers of 2 (e.g. 1048576)

Specifying Directory for Temporary Chunks

To specify the path where file chunks will be temporarily stored while being processed (the default is /tmp), execute the following command:

./cbb option -set cp -v path

where:

Parameter Description Value
cp Indicates that temporary chunk directory is to be specified
-v The value for the default path String

Specifying Queue Size

To specify the default queue size for Glacier restore (the default is 2000), execute the following command:

./cbb option -set qs -v number

where:

Parameter Description Value
qs Indicates that the queue size is to be specified
-v The value for the queue size Integer

It takes approximately four hours to list files in Glacier. If the number of files to be restored exceeds the queue size, you will have to repeatedly wait for four hours every time MSP360 (CloudBerry) Backup restores one queue. In other words, if queue size equals 2000, and the number of files to be restored is 6000, you'll have to wait for at leat 12 hours for the restoration to complete.

Limiting the Number of Utilized Threads

To limit the number of utilized threads, specify the following command:

./cbb option -set tc -v number

where:

Parameter Description Value
tc Indicates that the number of threads is to be specified
-v Number of threads Integer between 1 and 100

Limit Bandwidth to Cloud Storage

To limit utilized bandwidth to cloud storage, execute the following command:

./cbb option -set bw -b kb

where:

Parameter Description Value
bw Indicated that bandwidth to cloud storage is to be specified
-b Specified bandwidth to cloud storage u (unlimited) / number in kilobytes

Limit Bandwidth to Local Storage

To limit utilized bandwidth to local storage, execute the following command:

./cbb option -set bwl -b kb

where:

Parameter Description Value
bwl Indicated that bandwidth to local storage is to be specified
-b Specified bandwidth to cloud storage u (unlimited) / number in kilobytes

Configure Email Notifications

To configure email notifications, execute the following command:

./cbb option -set n -e "email" -u "username"

where:

Parameter Description Value
n Indicates that email notification settings are to be specified
-e Email address String
-u Username String