About the dse advrep command

The command line tool provides commands and options for configuring and using DSE Advanced Replication.


dse advrep [connection_options] [command] [sub_command] [sub_command_options]

The default port for DSE Advanced Replication is 9042.

Syntax legend
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.

Using dse advrep command line help

To view a listing of dse advrep commands:

dse advrep help

To view help for a specific command:

dse advrep help command [ sub_command ]

Connection options

JMX authentication is supported by some dse commands. Other dse commands authenticate with the user name and password of the configured user. The connection option short form and long form are comma separated.

You can provide authentication credentials in several ways, see Credentials for authentication.

General connection options:

--separator field_separator

The field separator for use with the --no-pretty-print command.


Print verbose messages for command.


Displays which arguments are recognized as Spark configuration options and which arguments are forwarded to the Spark shell.


If not specified, data is printed using tabular output. If specified, data is printed as a comma separated list unless a separator is specified.

--cipher-suites ssl_cipher_suites

Comma-separated list of SSL cipher suites for connection to DSE when SSL is enabled. For example, --cipher-suites c1,c2,c3.

--host hostname

The DSE node hostname or IP address.

--jmx-port jmx_port

The remote JMX agent port number. Default: 7199.

--jmx-pwd jmx_password

The password for authenticating with secure local JMX. If you do not provide a password, you are prompted to enter one.

--jmx-user jmx_username

The user name for authenticating with secure local JMX.

--kerberos-enabled true|false

Whether Kerberos authentication is enabled for connections to DSE. For example, --kerberos-enabled true.

--keystore-password keystore_password

Keystore password for connection to DSE when SSL client authentication is enabled.

--keystore-path ssl_keystore_path

Path to the keystore for connection to DSE when SSL client authentication is enabled.

--keystore-type ssl_keystore_type

Keystore type for connection to DSE when SSL client authentication is enabled. JKS is the type for keys generated by the Java keytool binary, but other types are possible, depending on user environment.

-p password

The password to authenticate for database access. Can use the DSE_PASSWORD environment variable.


Whether SSL is enabled for connection to DSE. --ssl-enabled true is the same as --ssl.

--ssl-protocol ssl_protocol

SSL protocol for connection to DSE when SSL is enabled. For example, --ssl-protocol ssl4.

-t delegation_token

The delegation token to use at login. Alternatively, use the DSE_TOKEN environment variable.

--truststore-password ssl_truststore_password

Truststore password to use for connection to DSE when SSL is enabled.

--truststore-path ssl_truststore_path

Path to the truststore to use for connection to DSE when SSL is enabled. For example, --truststore-path /path/to/ts.

--truststore-type ssl_truststore_type

Truststore type for connection to DSE when SSL is enabled. JKS is the type for keys generated by the Java keytool binary, but other types are possible, depending on user environment. For example, --truststore-type jks2.

-u username

User name of a DSE authentication account. Can use the DSE_USERNAME environment variable.


This connection example specifies that Kerberos is enabled and lists the replication channels:

dse advrep --host ip-10-200-300-138.example.lan --kerberos-enabled=true conf list

To use the server YAML files:

dse advrep --use-server-config conf list

To list output without pretty-print with a specified separator:

dse advrep --no-pretty-print --separator "|" destination list-conf

This output results:


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