DataStax Enterprise start-up parameters

Use system property and JVM switches to modify the DataStax Enterprise settings during start up.

Use system property switches to modify DataStax Enterprise (DSE) settings at start up.
Tip: To automatically pass the setting to the database start-up script, uncomment or add the switch to the jvm.options file. Do not do both, that is add/uncomment the switch in the file and specify it on the command line.

Synopsis

On the command line use the following syntax:
dse cassandra -Dparameter_name=value
In the jvm.options file use the following syntax:
-Dparameter_name=value

DSE system property switches

Change DSE system properties using the following switches.

-Dcassandra.auto_bootstrap=false
Sets auto_bootstrap to false. Use during the initial set-up of a node to override the default setting in the cassandra.yaml file.

Default: true.

-Dcassandra.available_processors=number_of_processors
In a multi-instance deployment, each instance independently assumes that all CPU processors are available to it. Use this setting to specify a smaller set of processors.
-Dcassandra.config=directory
Sets the directory location of the cassandra.yaml file. The default location depends on the type of installation.
-Dcassandra.consistent.rangemovement=true
Set to true, makes bootstrapping behavior effective.
-Dcassandra.disable_auth_caches_remote_configuration=true
Disables authentication caches, for example the caches used for credentials, permissions, and roles. This will mean those config options can only be set (persistently) in cassandra.yaml and will require a restart for new values to take effect.
-Dcassandra.force_default_indexing_page_size=true

Disable dynamic calculation of the page size used when indexing an entire partition (during initial index build/rebuild). If set to true, the page size will be fixed to the default of 10000 rows per page.

-Dcassandra.ignore_dc=true | false
When set to true, ignores the datacenter name change on startup. Applies only when using DseSimpleSnitch. (Default: false)
-Dcassandra.initial_token=token
Use when DSE is not using virtual nodes (vnodes). Sets the initial partitioner token for a node the first time the node is started. (Default: disabled)
Note: Vnodes automatically select tokens.
-Dcassandra.join_ring=true | false
When set to false, prevents the node from joining a ring on startup. (Default: true) You can add the node to the ring afterwards using nodetool join and a JMX call.
-Dcassandra.load_ring_state=true | false
When set to false, clears all gossip state for the node on restart. (Default: true)
-Dcassandra.metricsReporterConfigFile=file
Enables pluggable metrics reporter.
-Dcassandra.native_transport_port=port
Sets the port on which the CQL native transport listens for clients. (Default: 9042)
-Dcassandra.native_transport_startup_delay_seconds=seconds
Delays the startup of native transport server for the number of seconds. (Default: 0)
-Dcassandra.partitioner=partitioner
Sets the partitioner. (Default: org.apache.cassandra.dht.Murmur3Partitioner)
-Dcassandra.partition_sstables_by_token_range=true | false
Whether to disable JBOD SSTable partitioning by token range to multiple data_file_directories. (Default: true). Set to false only as directed by DataStax Support.
-Dcassandra.replace_address=listen_address_of_dead_node|broadcast_address_of_dead_node
To replace a node, restart a new node in its place specifying the listen_address or broadcast_address that the new node is assuming. The new node must be in the same state as before bootstrapping, without any data in its data directory.
Note: The broadcast_address defaults to the listen_address except when the ring is using the Ec2MultiRegionSnitch.
-Dcassandra.replayList=table
Allows restoring specific tables from an archived commit log.
-Dcassandra.ring_delay_ms=ms
Defines the amount of time a node waits to hear from other nodes before formally joining the ring. (Default: 30000ms)
-Dcassandra.rpc_port=port
Sets the port for the Thrift RPC service, which is used for client connections. (Default: 9160).
-Dcassandra.ssl_storage_port=port
Sets the SSL port for encrypted communication. (Default: 7001)
-Dcassandra.start_native_transport=true | false
Enables or disables the native transport server. See start_native_transport in cassandra.yaml. (Default: true)
-Dcassandra.start_rpc=true | false
Enables or disables the Thrift RPC server. (Default: true)
-Dcassandra.storage_port=port
Sets the port for inter-node communication. (Default: 7000)
-Dcassandra.triggers_dir=directory
Sets the default location for the triggers JARs.
-Dcassandra.write_survey=true
Enables a tool for testing new compaction and compression strategies. write_survey allows you to experiment with different strategies and benchmark write performance differences without affecting the production workload. See Testing compaction and compression.
-Ddse.search.client.timeout.secs=seconds
Native driver search core management calls using the dsetool search-specific commands use the default request timeout of 600 seconds (10 minutes).
The location of the triggers directory depends on the type of installation:

Package installations
Installer-Services installations

/etc/dse/cassandra/triggers

Tarball installations
Installer-No Services installations

installation_location/resources/cassandra/conf/triggers
Starting a node without joining the ring:
  • Command line:
    dse cassandra -Dcassandra.join_ring=false
  • jvm.options:
    -Dcassandra.join_ring=false
Replacing a dead node:
  • Command line:
    dse cassandra -Dcassandra.replace_address=10.91.176.160
  • jvm.options:
    -Dcassandra.replace_address=10.91.176.160