About the nodetool utility
A command line interface for monitoring a cluster and performing routine database operations.
cassandra-env.sh
- The cassandra-env.sh file is located in the installation_location/conf directory.
The nodetool utility is a command-line interface for monitoring a cluster and performing routine database operations. It is typically run from an operational node.
The nodetool utility supports the most important JMX metrics and operations, and includes other useful commands for cluster administration, such as the proxyhistogram command.
Command formats
install_location/bin/nodetool [options] command [args]
Connection options
Connection options specify how to connect and authenticate for all nodetool commands:
| Short | Long | Description |
|---|---|---|
-h |
--host |
Hostname or IP address. |
-p |
--port |
Port number. |
-pwf |
--password-file |
Password file path. |
-pw |
--password |
Password. |
-u |
--username |
Username. |
| -- | 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
Using nodetool command help
nodetool help- Provides a listing of nodetool commands.
nodetool help command name- Provides help on a specific command. For example:
nodetool help upgradesstables
For more information, see nodetool help.