Application Settings

This article describes how you can use CloudBerry Backup CLI to manage and customize your application's settings.

Use the option (-o) command to customize your CloudBerry Backup application's settings:

C:\Program Files\CloudBerryLab\CloudBerry Backup>cbb option -?

Specifying the Bandwidth Limit

Specify the following parameter to limit the bandwidth allocated to CloudBerry Backup when it transfers data between a cloud and local storage.

  • -bw (-bandwidth)
    Specifies the maximum bandwidth, in kB/sec. For example:
  cbb option -bandwidth 1000

Specifying the Retention Policy

Use the following parameters to provide a common retention policy for data in all of your backups.

  • -purge Makes a backup service delete file versions that were modified or uploaded to your backup storage more than a certain number of days ago. The following values are supported:

  • "no" - indicates that data is stored for indefinite period.

  • "d (day)" - specifies for how many days to store your data.

  • "w (week)" - specifies for how many weeks to store your data.

  • "m (month)" - specifies for how many months to store your data.

    For example:

    cbb option -purge 21w
    
  • -delayPurge Specifies the maximum number of versions that a backup service should keep in the storage for each file. The following values are supported:

  • "no" - enables immediate removal of files after they have been deleted in a source storage.

  • "d (day)" - specifies for how many days to keep locally deleted files in the backup storage.

  • "w (week)" - specifies for how many weeks to keep locally deleted files in the backup storage.

  • "m (month)" - specifies for how many months to keep locally deleted files in the backup storage.

For example:

  cbb option -delayPurge 21day
  • -keep

    Specifies the maximum number of versions that a backup service should keep in the storage for each file. For example:

  cbb option -keep 9

If you enabled ransomware protection, a backup service will ignore the current retention policy settings on detecting ransomware activity. In this case, the backup service will keep the latest undamaged version of your files regardless of what retention policy is defined for your application or for the current backup plan.

Specifying the History and Logging Options

The following parameters specify the retention settings for the history that CloudBerry Backup maintains to keep track of any changes made to the source and target storages.

  • -hp Makes the history keep records only for a certain period of time and delete any records exceeding the specified lifespan. The following values are supported:

  • "no" - makes history records stored for indefinite period.

  • "d (day)" - specifies for how many days to store history records.

  • "w (week)" - specifies for how many weeks to store history records.

  • "m (month)" - specifies for how many months to store history records.

    For example:

    cbb option -hp 21day
    
  • -hk
    Specifies the maximum number of records stored in the application's history. The following values are supported:

  • "all" - indicates that a history can contain any number of records.

  • An integer value, specifying the maximum record count.

    For example:

  cbb option -hk 1000

The following parameter specifies the level of detail for the application's logs. A higher level of detail requires more disk space and computing resources for maintaining the log.

  • -l (-logging) Specifies the detail level for records in the application logs. The following values are supported:

  • "no" - disables the application logging.

  • "l (low)" - enables a low level of logging detail (only critical information is logged).

  • "h (high)" - enables a high level of logging detail.

  • "d (debug)" - enables the highest level of logging detail.

    Please be informed that selecting this mode may result in decreased application performance. We do not recommend using this mode unless you need to report any issue and send a detailed log for investigation to CloudBerry Lab.

The following example illustrates how to switch the logging detail level to low.

cbb option -logging low

Specifying the Proxy Settings

You can use the following parameters to enable CloudBerry Backup to use a proxy server.

  • -proxy Specifies whether or not a proxy server is enabled. The following values are supported:

  • "no" - disables the use of a proxy server.

  • "auto" - enables the application to automatically detect a proxy server.

    We do not recommend enabling auto-detection for proxy settings, because the application may be unable to properly detect proxy servers defined for other user accounts than the one under which the backup service is running.

  • "manual" - enables you to manually configure the proxy settings.

    To manually configure a proxy server, you need to specify its address and port. If the server requires authentication, you also need to specify the corresponding domain and user credentials.

  • -pa Specifies the proxy server's address.

  • -pp Specifies the port number assigned to a proxy server.

  • -pt Specifies whether or not a proxy server requires authentication.

  • -pd Specifies the domain used for proxy authentication.

  • -pu Specifies the user name used for proxy authentication.

  • -ps Specifies the password used for proxy authentication.

The following example illustrates how to manually configure a proxy server.

cbb option -proxy manual -pa "my.proxy.co" -pp 1080 -pt yes -pd "td://myproxy" -pu "userName" -ps "password"

Switching the User Mode

The following parameter enables you to change the user mode specified during CloudBerry Backup installation.

  • -userMode Specifies the application user mode. The following values are supported.
  • "common" - makes the application settings and backup plans shared among all users on this computer. With this option selected, all users will be able to back up and restore folders of other users.
  • "current" - makes the current user on this computer have an individual set of backup plans and application configuration. With this option selected, users will not be able to back up and restore folders of other users.

The following example illustrates how to customize the application user mode.

cbb option -userMode current

You need to restart the backup service after changing the user mode.

Relocating the Temporary Database and Repository

The following parameters enables you to specify a custom location for the backup repository and a temporary database used for processing Microsoft SQL Server backups.

  • -databaseLocation
    Specifies a custom location for a backup repository that CloudBackup uses for keeping track of changes made to your backups. This repository is located in a user's "AppData" directory by default.

Please ensure that the specified directory exists before executing this command.

For example:

  cbb option -databaseLocation "C:\Repository"

See Managing the Repository to learn how you can shrink the repository if it takes too much disk space.

  • -msSqlTempLocation
    Specifies a custom location for temporary data required to process SQL Server backups. This data is stored in a user's "AppData" directory by default.

Please ensure that the specified directory exists before executing this command.

For example:

  cbb option -msSqlTempLocation "C:\SqlServer"

Customizing the Memory Options

Use the following parameters to optimize the speed of processing large files (100 MB and more) by CloudBerry Backup.

  • -cs Specifies the chunk size, in kB.

    This value should be within the 1 - 5242880 range.

  • -t (-threads) An integer value, specifying the number of threads.

Cloudberry processes large files in chunks that are stored in memory in multiple threads. The application utilizes 6 threads with the chunk size of 100 MB by default. As a result, processing two backups in parallel requires 1200 MB of memory in total, which is calculated as follows:

6 threads x 100 MB x 2 workflows = 1200 MB

When the total chunk size exceeds the amount of memory available to the application, the backup service begins storing the remaining chunks in a temporary folder on disk, which may affect the backup processing speed because of additional time required for disk input/output operations.

The following example illustrates how to reset the chunk size and thread count to their default values.

cbb option -cs 5242880 -threads 6

Disabling SSL Validation

Use the following parameter to make your CloudBerry Backup application implicitly trust any self-signed SSL certificates.

We strongly recommend that you never disable SSL validation unless the certificates issued by an application are absolutely trusted, because this may compromise your application security.