--- title: backup-service-nodes-threads-map pubDate: 2026-08-17T09:53:44.266Z antora: editUrl: https://github.com/couchbase/couchbase-cli/edit/trinity/docs/modules/cli/pages/cbcli/couchbase-cli-backup-service-nodes-threads-map.adoc xref: xref:7.6@server:cli:cbcli/couchbase-cli-backup-service-nodes-threads-map.adoc[] --- [Consult the llms.txt file for a full list of contents](/llms.txt) [View original HTML](/server/7.6/cli/cbcli/couchbase-cli-backup-service-nodes-threads-map.html) # backup-service-nodes-threads-map Manage the backup service nodes threads map. ## [](#synopsis)SYNOPSIS _couchbase-cli backup-service_ [--cluster ] [--username ] [--password ] [--client-cert ] [--client-cert-password ] [--client-key ] [--client-key-password ] [--output] nodes-threads [--get] [--set] [--add] [--node ] [--threads ] ## [](#description)DESCRIPTION Manage backup service nodes threads map. ## [](#action-options)ACTION OPTIONS \--get Get the backup service's nodes threads map. \--set Set a new backup service's nodes threads map. \--add Add a new entry in the backup service's nodes threads map. ## [](#options)OPTIONS \--node node UUID. \--threads Number of threads. ## [](#host-formats)HOST FORMATS When specifying a host for the couchbase-cli command the following formats are expected: * `couchbase://` or `couchbases://` * `http://:` or `https://:` * `:` It is recommended to use the couchbase:// or couchbases:// 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)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-certificatekey)PEM ENCODED CERTIFICATE/KEY An unencrypted PEM encoded certificate/key may be supplied by using: - `--client-cert `\- `--client-key ` 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-certificatepem-or-der-encrypted-pkcs8-key)PEM ENCODED CERTIFICATE/PEM OR DER ENCRYPTED PKCS#8 KEY An encrypted PKCS#8 formatted key may be provided using: - `--client-cert `\- `--client-key `\- `--client-key-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-pkcs12-certificatekey)ENCRYPTED PKCS#12 CERTIFICATE/KEY An encrypted PKCS#12 certificate/key may be provided using: - `--client-cert `\- `--client-cert-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)EXAMPLES To retrieve the backup service's nodes threads map: $ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p asdasd \ nodes-threads --get Node UUID | Threads ------------------------------------------------- 23ec390488495fec2074119a61d2eb91 | 3 76dc6557ed98ac7e78e70cf0d28921f3 | 4 This will show you each backup service node's UUID and the number of threads allocated to it. To set the backup service's nodes threads map: $ couchbase-cli backup-service -c 127.0.0.0:8091 -u Administrator -p asdasd \ nodes-threads --set --node 23ec390488495fec2074119a61d2eb91 --threads 3 SUCCESS: Set node threads map This will overwrite the map in the backup service with the number of threads allocated to the backup service node with UUID `23ec390488495fec2074119a61d2eb91` to 3. To add a new entry to the backup service's nodes threads map: $ couchbase-cli backup-service -c 127.0.0.1:8091 -u Administrator -p asdasd \ nodes-threads --add --node 76dc6557ed98ac7e78e70cf0d28921f3 --threads 4 SUCCESS: Updated node threads map This will add a new entry to the backup service's nodes threads map, allocating 4 threads to the backup service node with UUID `76dc6557ed98ac7e78e70cf0d28921f3`. ## [](#environment-and-configuration-variables)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)SEE ALSO [backup-service](couchbase-cli-backup-service.md) ## [](#couchbase-cli)COUCHBASE-CLI Part of the [couchbase-cli](couchbase-cli.md) suite