dse command connection options

When you run dse commands, use connection options to authenticate and connect to the target node or to JMX, depending on the command you are running.

Provide the connection options before the command, subcommand, and options:

dse
[-f CONFIG_FILE | -u USERNAME -p PASSWORD]
[-a JMX_USERNAME -b JMX_PASSWORD]
command 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.

Options

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

-f, --config-file config_filename

File path to configuration file that stores credentials.

The credentials in this configuration file override the credentials in ~/.dserc. If a credential isn’t specified in the given configuration file, then DSE uses the value set in ~/.dserc, if it exists.

The configuration file can contain DSE and JMX login credentials. For example:

username=<username>
password=<password>
jmx_username=<jmx_username>
jmx_password=<jmx_password>

The credentials in the configuration file are stored in plain text. DataStax recommends restricting access to this file only to the specific user.

-u

Specify the role name to authenticate for database access.

-p, --password

Provide the password to authenticate for database access.

-a, --jmxusername

Username for authenticating with secure local JMX.

-b, --jmxpassword

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.

Examples

Provide credentials on the command line:

dse -u user1 -p mypassword

Authenticate a connection using a configuration file:

dse -f configfile

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