Connection options

Options for connecting to your cluster with the dsetool utility.

Synopsis

dsetool [<connection_options>]  <command> <command_args>

Syntax conventions Description

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.

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.

JMX authentication is used by some dsetool commands. Other dsetool 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. To enable dsetool to use Kerberos authentication, see Using dsetool with Kerberos enabled cluster.

Specify how to connect and authenticate the dsetool command.

This list shows short form (-f <filename>) and long form (--config-file=<filename>):

-a, --jmxusername jmx_username: User name for authenticating with secure local JMX.
-b, --jmxpassword jmx_password: Password for authenticating with secure local JMX. If you do not provide a password, you are prompted to enter one.
-c, --cassandra_port dse_port: DSE port number.

--cipher-suites ssl_cipher_suites

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

-f, --config-file config_filename

File path to configuration file that stores credentials. The credentials in this configuration file override the ~/.dserc credentials. If not specified, then use ~/.dserc if it exists.

The configuration file can contain DataStax Enterprise 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 clear text. DataStax recommends restricting access to this file only to the specific user.

-h, --host IP_address

Connect to the specified hostname or IP address. Do not connect to the local node.

-j, --jmxport jmx_port

Remote JMX agent port number.

--keystore-path ssl_keystore_path: Path to the keystore for connection to DSE when SSL client authentication is enabled.

--keystore-password keystore_password: Keystore password 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.
-l, --username username: Role to authenticate for database access.
-p, --password password: Password to authenticate for database access.
-s, --port solr_port: Solr port.
--ssl (true|false): Whether to use SSL for native connections.

--ssl-protocol ssl_protocol: SSL protocol for connection to DSE when SSL is enabled. For example, --ssl-protocol ssl4.
--sslauth (true|false): Whether to use SSL client authentication.

-t token: Specify delegation token which can be used to login, or alternatively, 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.

Connection options

Synopsis

Was this helpful?

Give Feedback