A newer version of this documentation is available.

View Latest

xdcr-setup

    +

    Manage references to remote clusters

    SYNOPSIS

    couchbase-cli xdcr-setup [--cluster <url>] [--username <user>]
        [--password <password>] [--create] [--delete] [--edit] [--list]
        [--xdcr-cluster-name <name>] [--xdcr-hostname <hostname>]
        [--xdcr-username <username>] [--xdcr-password <password>]
        [--xdcr-demand-encryption <num>] [--xdcr-encryption-type <type>]
        [--xdcr-certificate <file>]

    DESCRIPTION

    This command is used to manage the remote clusters that are available to be replicated to.

    OPTIONS

    -c
    --cluster

    Specfies the hostname of a node in the cluster. See the HOST FORMATS section for more information on specifying a hostname.

    -u
    --user <username>

    Specifies the username of the user executing the command. If you do not have a user account with permision to execute the command then it will fail with an unauthorized error.

    -p
    --password <password>

    Specifies the password of the user executing the command. If you do not have a user account with permision to execute the command then it will fail with an unauthorized error. If this argument is specified, but no password is given then the command will prompt the user for a password through non-echoed stdin. You may also specify your password by using the environment variable CB_REST_PASSWORD.

    --create

    Creates an new XDCR remote reference.

    --delete

    Deletes an XDCR remote reference.

    --edit

    Edits an XDCR remote reference.

    --list

    List all XDCR remote references.

    --xdcr-cluster-name <name>

    The name for the remote cluster reference.

    --xdcr-hostname <hostname>

    The hostname of the remote cluster reference.

    --xdcr-username <username>

    The username of the remote cluster reference.

    --xdcr-password <password>

    The password of the remote cluster reference.

    --xdcr-demand-encryption <num>

    Enable SSL when replicating with this cluster. To enable SSL set the value of this otion to 1. To disable SSL then set this option to 0. BY default the value of this option is set to 0.

    --xdcr-encryption-type <type>

    Specifes the type of encryption to use if encryption is enabled. This flag may either be set to "half" encryption or "full encryption". Half encryption means that passwords are encrypted, but data is not. This results in faster data transfer, but less security. Full encryption means that all data and passwords are encrypted which increases security, but reduces overall data transfer speed. This flag does not have any affect if encryption is not enabled. If encryption is enabled and this flag is set then the value defaults to full encryption.

    --xdcr-certificate <file>

    The path to the certificate used for encryption.

    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 create a new remote reference to a Couchbase cluster named "east" run the following command.

    $ couchbase-cli xdcr-setup -c 192.168.1.5 -u Administrator \
     -p password --create --xdcr-cluster-name east --xdcr-hostname 192.168.1.6
     --xdcr-username Administrator --xdcr-password password

    If the new remote reference should always be encrypted then make sure to enable encryption.

    $ couchbase-cli xdcr-setup -c 192.168.1.5 -u Administrator \
     -p password --create --xdcr-cluster-name east --xdcr-hostname 192.168.1.6 \
     --xdcr-username Administrator --xdcr-password password \
     --xdcr-demand-encryption 1 --xdcr-certificate /root/cluster.cert

    To list all current XDCR cluster references run the following command.

    $ couchbase-cli xdcr-setup -c 192.168.1.5 -u Administrator \
     -p password --list

    If you need to edit a cluster references named "east" and change the password run the following command.

    $ couchbase-cli xdcr-setup -c 192.168.1.5 -u Administrator \
     -p password --edit --xdcr-cluster-name east --xdcr-hostname 192.168.1.6
     --xdcr-username Administrator --xdcr-password new_password

    Note in the above example that you need to specify all of the current unchanging configuration parameters also to avoid them being reset to defaults.

    If you no longer need an XDCR remote reference then you can delete it. We should this below using the "east" remote reference as an exmaple.

    $ couchbase-cli xdcr-setup -c 192.168.1.5 -u Administrator \
     -p password --delete --xdcr-cluster-name east

    ENVIRONMENT AND CONFIGURATION VARIABLES

    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_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.

    COUCHBASE-CLI

    Part of the couchbase-cli suite