DSE Advanced Replication connection options

When you run dse advrep commands, use connection options to authenticate to the external client. Provide the connection options before the command, subcommand, and options:

dse advrep CONNECTION_OPTIONS [command] [subcommand] [options]

Some commands use JMX authentication, and others authenticate with the username and password of the configured user. You can provide authentication credentials in several ways. See Provide credentials from DSE tools.

The default port for DSE Advanced Replication is 9042.

Connection options

Use the following options to connect and authenticate dse advrep commands. If an option has a short and long form, both forms are provided for reference; only use one form in your commands.

The default port for DSE Advanced Replication is 9042.

--cipher-suites

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

--host <hostname_or_IP>

The hostname or IP address of the DSE node to connect to. If included, the command won’t connect to the local node.

If omitted, the default is the local node.

--jmx-port <jmx_port>

The remote JMX agent port number.

Default: 7199

--jmx-pwd <jmx_password>

Password for authenticating with secure local JMX. If JMX authentication is required and you don’t provide a password, you are prompted to enter one.

--jmx-user <jmx_username>

Username 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

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

--keystore-path

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

--keystore-type

Specify the 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 your environment. For example: --keystore-type jks2

-p, --password

Provide the password to authenticate for database access.

Can use the DSE_PASSWORD environment variable.

--ssl

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 <token>

Specify the delegation token that can be used to login. Alternatively, the DSE_TOKEN environment variable can be used.

--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>

Specify the 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 your environment. For example: --truststore-type jks2

-u <username>

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

Examples

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

Was this helpful?

Give Feedback

How can we improve the documentation?

© Copyright IBM Corporation 2025 | Privacy policy | Terms of use Manage Privacy Choices

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: Contact IBM