About dse client-tool

A command line interface that connects an external client to a DataStax Enterprise node and performs common utility tasks.

cassandra-env.sh

The location of the cassandra-env.sh file depends on the type of installation:

Package installations	/etc/dse/cassandra/cassandra-env.sh
Tarball installations	`installation_location`/resources/cassandra/conf/cassandra-env.sh

The dse client-tool command line interface connects an external client to a DataStax Enterprise node and performs common utility tasks.

For full dse client-tool command documentation, see the DSE Administrator Guide.

Connection options

Connection options specify how to connect and authenticate for all dse client-tool commands:


Short	Long	Description
	`--port`	Port number.
`-p`	`--password`	Password.
`-u`	`--username`	Username.
`-a`		DSE authorization username if proxy authentication is used.
`-t`		Delegation token which can be used to login. Alternatively, you can use the `DSE_TOKEN` environment variable.
--		Separates command parameters from a list of options.

Note:

If a username and password for RMI authentication are set explicitly in the cassandra-env.sh file for the host, then you must specify credentials.
The repair and rebuild commands can affect multiple nodes in the cluster.
Most nodetool commands operate on a single node in the cluster if -h is not used to identify one or more other nodes. If the node from which you issue the command is the intended target, you do not need the -h option to identify the target; otherwise, for remote invocation, identify the target node, or nodes, using -h.

Example:

nodetool -u username -pw password describering demo_keyspace

To show a listing of the dse client-tool subcommands:

dse client-tool help

To show the command line help for a specific dse client-tool subcommand:

dse client-tool help subcommand

For example:

dse client-tool help configuration