dse client-tool cassandra

Performs token management and partitioner discovery.

Token management commands require Kerberos authentication mode.


dse <connection_options> client-tool cassandra
(cancel-token <token> |
generate-token [<username>] |
renew-token <token> |
Syntax conventions Description


Literal keyword.


Not literal.


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.


Set, list, map, or tuple. Angle brackets ( < > ) enclose data types in a set, list, map, or tuple. Separate the data types with a comma.


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.


Search CQL only: Identify the entity and literal value to overwrite the XML element in the schema and solrconfig files.

cancel-token token

Cancel the specified token.

generate-token [username]

Generate delegation token to access Kerberos DSE from non-Kerberos clusters.

  • When the username is not specified, the current user is the token renewer. Only DSE processes can renew a token.

  • When the username is specified as the token renewer, that user can renew and cancel the token.


Returns the partitioner that is being used by the node.

renew-token token

Renew the specified token.


Generate token for the current user

dse client-tool cassandra --generate-token

Generate token with user AdminAlicia as the token renewer</p>

dse client-tool cassandra generate-token --token-renewer AdminAlicia

Return the current partitioner

dse client-tool cassandra partitioner

Cancel specified token

dse client-tool cassandra cancel-token <token>

Renew specified token

dse client-tool cassandra renew-token <token>

Was this helpful?

Give Feedback

How can we improve the documentation?

© 2024 DataStax | Privacy policy | Terms of use

Apache, Apache Cassandra, Cassandra, Apache Tomcat, Tomcat, Apache Lucene, Apache Solr, Apache Hadoop, Hadoop, Apache Pulsar, Pulsar, Apache Spark, Spark, Apache TinkerPop, TinkerPop, Apache Kafka and Kafka are either registered trademarks or trademarks of the Apache Software Foundation or its subsidiaries in Canada, the United States and/or other countries. Kubernetes is the registered trademark of the Linux Foundation.

General Inquiries: +1 (650) 389-6000, info@datastax.com