You are viewing the documentation for a prerelease version.

View Latest

setting-on-demand

Manage on demand pricing settings

SYNOPSIS

_couchbase-cli setting-on-demand [--cluster <url>] [--username <user>]
    [--password <password>] [--set] [--get] [--generate-report]
    [--reporting-enabled <1|0>] [--contract-id <id>]
    [--customer-token <token>]

DESCRIPTION

Allows updating of on demand pricing settings as well as the generation of RAM/cores usage reports.

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.

--get

Retrieves the current licensing settings.

--set

Specify new license settings.

--generate-report

Generates a new usage report informing of the amount of RAM and number of cores in use.

--reporting-enabled <1|0>

Specify where reporting is enabled.

--contract-id <id>

Specify the contract id.

--customer-token <token>

Specify the customer token.

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.

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