A newer version of this documentation is available.

View Latest
February 16, 2025
+ 12

Manage the backup service settings

SYNOPSIS

_couchbase-cli backup-service [--cluster <url>] [--username <user>]
    [--password <password>] [--client-cert <path>] [--client-cert-password <password>]
    [--client-key <path>] [--client-key-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> or couchbases://<addr>

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

  • <addr>:<port>

It is recommended to use the couchbase://<addr> or couchbases://<addr> format for standard installations. The other 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 (or 18091 for https).

CERTIFICATE AUTHENTICATION (MTLS AUTHENTICATION)

This tool supports authenticating against a Couchbase Cluster by using certificate based authentication (mTLS authentication). To use certificate based authentication a certificate/key must be supplied, there a currently multiple ways this may be done.

PEM ENCODED CERTIFICATE/KEY

An unencrypted PEM encoded certificate/key may be supplied by using: - --client-cert <path> - --client-key <path>

The file passed to --client-cert must contain the client certificate, and an optional chain required to authenticate the client certificate.

The file passed to --client-key must contain at most one private key, the key can be in one of the following formats: - PKCS#1 - PKCS#8

Currently, only the following key types are supported: - RSA - DSA

PEM ENCODED CERTIFICATE/PEM OR DER ENCRYPTED PKCS#8 KEY

An encrypted PKCS#8 formatted key may be provided using: - --client-cert <path> - --client-key <path> - --client-key-password <password>

The file passed to --client-cert must contain the client certificate, and an optional chain required to authenticate the client certificate.

Currently, only the following key types are supported: - RSA - DSA

ENCRYPTED PKCS#12 CERTIFICATE/KEY

An encrypted PKCS#12 certificate/key may be provided using: - --client-cert <path> - --client-cert-password <password>

The file passed to --client-cert must contain the client certificate and exactly one private key. It may also contain the chain required to authenticate the client certificate.

Currently, only the following key types are supported: - RSA - DSA

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.

CB_CLIENT_CERT

The path to a client certificate used to authenticate when connecting to a cluster. May be supplied with CB_CLIENT_KEY as an alternative to the CB_USERNAME and CB_PASSWORD variables. See the CERTIFICATE AUTHENTICATION section for more information.

CB_CLIENT_CERT_PASSWORD

The password for the certificate provided to the CB_CLIENT_CERT variable, when using this variable, the certificate/key pair is expected to be in the PKCS#12 format. See the CERTIFICATE AUTHENTICATION section for more information.

CB_CLIENT_KEY

The path to the client private key whose public key is contained in the certificate provided to the CB_CLIENT_CERT variable. May be supplied with CB_CLIENT_CERT as an alternative to the CB_USERNAME and CB_PASSWORD variables. See the CERTIFICATE AUTHENTICATION section for more information.

CB_CLIENT_KEY_PASSWORD

The password for the key provided to the CB_CLIENT_KEY variable, when using this variable, the key is expected to be in the PKCS#8 format. See the CERTIFICATE AUTHENTICATION section for more information.

SEE ALSO

COUCHBASE-CLI

Part of the couchbase-cli suite