You are viewing the documentation for a prerelease version.

View Latest

setting-alternate-address

Modify alternate addresses

SYNOPSIS

_couchbase-cli setting-alternate-address [--cluster <url>] [--username <user>]
    [--password <password>] [--list] [--set] [--remove] [--hostname <host>]
    [--ports <ports>]

DESCRIPTION

This command is used to set the alternate address for a node. This alternate address allows the node to be connected by a different address, this is useful when an external agent tries to connect via a NAT’d environment such as cloud or kubernetes environments.

OPTIONS

-c
--cluster

Specifies 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 permission 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 permission 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.

--list

Show current alternate addresses

--set

Set alternate address for the node specified in the -c/--cluster option.

--remove

Remove alternate address for the node specified in the -c/--cluster option.

--hostname <host>

Alternate host address

--ports <port>

Alternate port mappings. Specified as a comma separated list: e.g. --ports kv=9000,kvSSL=9999. If not specified defaults will be used

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 set the alternate address and custom ports for node 192.168.1.5 we would use the following command

$ couchbase-cli setting-alternate-address -c 192.168.1.5:8091 --username Administrator \
 --password password --set --hostname 10.10.10.10 \
 --ports mgmt=1100,capi=2000,capiSSL=3000

To see the current alternate address configuration we would use the --list flag as follows:

$ couchbase-cli setting-alternate-address -c 192.168.1.5:8091 --username Administrator \
 --password password --list

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

COUCHBASE-CLI

Part of the couchbase-cli suite