Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

A newer version of this documentation is available.

View Latest

backup-service-settings

    March 16, 2025
    + 12

    Manage the backup service settings

    SYNOPSIS

    _couchbase-cli backup-service [--cluster <url>] [--username <user>]
    [--password <password>] settings [--get] [--set] [--history-rotation-period <days>]
    [--history-rotation-size <mebibytes>]

    DESCRIPTION

    Manage the backup service settings

    OPTIONS

    --get

    Retrieve current backup service settings.

    --set

    Set backup service settings.

    --history-rotation-size <mebibytes>

    The history size in mebibytes at which it should be rotated. Valid values are between 5 and 200.

    --history-rotation-period <days>

    The period in days at which the history should be rotated. Valid values are between 1 and 365.

    HOST FORMATS

    When specifying a host for the couchbase-cli command the following formats are expected:

    • couchbase://<addr>

    • <addr>:<port>

    • http://<addr>:<port>

    It is recommended to use the couchbase://<addr> format for standard installations. The other two formats allow an option to take a port number which is needed for non-default installations where the admin port has been set up on a port other that 8091.

    EXAMPLES

    To retrieve the backup service settings:

    $ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
  settings --get
-- Backup service configuration --
History rotation size: 70 MiB
History rotation period: 28 days

    To set the backup service configuration use the --set flag and any of the configuration flags for example:

    $ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p password \
  settings --set --history-rotation-size 70 --history-rotation-period 365
SUCCESS: Backup service settings set

    ENVIRONMENT AND CONFIGURATION VARIABLES

    CB_REST_USERNAME

    Specifies the username to use when executing the command. This environment variable allows you to specify a default argument for the -u/--username argument on the command line.

    CB_REST_PASSWORD

    Specifies the password of the user executing the command. This environment variable allows you to specify a default argument for the -p/--password argument on the command line. It also allows the user to ensure that their password are not cached in their command line history.

    SEE ALSO

    backup-service

    COUCHBASE-CLI

    Part of the couchbase-cli suite