nodetool describecluster

Returns the name, snitch, partitioner, and schema version of a cluster.

Returns the name, snitch, partitioner, and schema version of a cluster.

Typically used to validate the schema after upgrading. If a schema disagreement occurs, see Handling schema disagreements and "Schema version mismatch detected" on node restart in the DataStax Support Knowledge Base.


nodetool [connection_options] describecluster
Table 1. Legend
Syntax conventions Description
UPPERCASE Literal keyword.
Lowercase Not literal.
Italics Variable value. Replace with a valid option or user-defined value.
[ ] Optional. Square brackets ( [ ] ) surround optional command arguments. Do not type the square brackets.
( ) Group. Parentheses ( ( ) ) identify a group to choose from. Do not type the parentheses.
| Or. A vertical bar ( | ) separates alternative elements. Type any one of the elements. Do not type the vertical bar.
... Repeatable. An ellipsis ( ... ) indicates that you can repeat the syntax element as often as required.
'Literal string' Single quotation ( ' ) marks must surround literal strings in CQL statements. Use single quotation marks to preserve upper case.
{ key:value } Map collection. Braces ( { } ) enclose map collections or key value pairs. A colon separates the key and the value.
<datatype1,datatype2> Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.
cql_statement; End CQL statement. A semicolon ( ; ) terminates all CQL statements.
[ -- ] Separate the command line options from the command arguments with two hyphens ( -- ). This syntax is useful when arguments might be mistaken for command line options.
' <schema> ... </schema> ' Search CQL only: Single quotation marks ( ' ) surround an entire XML schema declaration.
@xml_entity='xml_entity_type' Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.


The short form and long form parameters are comma-separated.

Connection options

-h, --host hostname
The hostname or IP address of a remote node or nodes. When omitted, the default is the local machine.
-p, --port jmx_port
The JMX port number.
-pw, --password jmxpassword
The JMX password for authenticating with secure JMX. If a password is not provided, you are prompted to enter one.
-pwf, --password-file jmx_password_filepath
The filepath to the file that stores JMX authentication credentials.
-u, --username jmx_username
The username for authenticating with secure JMX.

Command arguments

The datacenter name.


Get cluster name, snitch, partitioner, and schema version

nodetool describecluster dc1
Results without schema disagreement:
Cluster Information:
                Name: Test Cluster	
                Snitch: com.datastax.bdp.snitch.DseDelegateSnitch
	         DynamicEndPointSnitch: enabled
                Partitioner: org.apache.cassandra.dht.Murmur3Partitioner
                Schema versions:
                	d4f18346-f81f-3786-aed4-40e03558b299: []

Results when schema disagreement occurs:

Cluster Information:
                Name: Production Cluster
                Snitch: org.apache.cassandra.locator.DynamicEndpointSnitch
                Partitioner: org.apache.cassandra.dht.Murmur3Partitioner
                Schema versions:
                UNREACHABLE: 1176b7ac-8993-395d-85fd-41b89ef49fbb: []
Note: If schema disagreement occurs, the last line of the output includes information about unreachable nodes.