dse add-node
For DSE Multi-Instance, simplifies adding and configuring a node on a host machine. When optional parameters are absent, the default values remain unchanged.
|
The user running the command must have permissions for writing to the directories that DSE uses, or use sudo. |
Restriction: DSE Multi-Instance commands are supported only on package installations.
Synopsis
dse add-node -n <nodeId>
[--advrep-directory <advrepdirectory>
[--analytics]:
[--cdc-directory=<cdcdirectory>]
[--cluster=<clustername>]
[--commit-directory=<commitdirectory>]
[--cpus=<number_of_cpus>]
[--dc=<datacenter_placement>]
[--data-directory=<datadirectory>]
[--dsefs] [--dsefs-directory=<dsefsdatadirectory>]
[--graph]
[--hadoop-logs=<hadooplogsdirectory>]
[help]
[--hints-directory=<hintsdirectory>]
[--jmxport=<jmx_port>]
[--listen-address=<listen_IP_address>]
[--logs-directory=<alllogsdirectory>]
[--max-heap-size=<heapsize>]
[--native-transport-address=<native_transport_IP_address>
[--num-tokens=<number_of_tokens>]
[--pig-logs=<piglogdirectory>]
[--rack=<rack_placement>]
[--rpc-address=<rpc_IP_address>]
[--saved-caches-directory=<savedcachesdirectory>]
[--search]
[--seeds=<IP_address1>,<IP_address2>,...]
[--spark-local-directory=<sparklocaldirectory>]
[--spark-log-directory=<sparklogdirectory>]
[--spark-worker-cores=<number_of_cores>]
[--spark-worker-directory=<sparkworkerdirectory>]
[--spark-worker-memory=<memory>]
[--tomcat-logs=<tomcatlogsdirectory>]
[--unix-group=<groupname>]
[--unix-username=<username>]
Syntax legend
| Syntax conventions | Description |
|---|---|
Italic, bold, or |
Syntax diagrams and code samples use one or more of these styles to mark placeholders for variable values. Replace placeholders with a valid option or your own user-defined value. In CQL statements, angle brackets are required to enclose data types in a set, list, map, or tuple.
Separate the data types with a comma.
For example: In Search CQL statements, angle brackets are used to identify the entity and literal value to overwrite the XML element in the schema and |
|
Square brackets surround optional command arguments. Do not type the square brackets. |
|
Parentheses identify a group to choose from. Do not type the parentheses. |
|
A pipe separates alternative elements. Type any one of the elements. Do not type the pipe. |
|
Indicates that you can repeat the syntax element as often as required. |
|
Single quotation marks must surround literal strings in CQL statements.
Use single quotation marks to preserve upper case.
+
For Search CQL only: Single quotation marks surround an entire XML schema declaration, such as |
|
Map collection.
Curly braces enclose maps ( |
|
Ends a CQL statement. |
|
Separate command line options from command arguments with two hyphens. This syntax is useful when arguments might be mistaken for command line options. |
New node configuration options:
- -n=nodeId, --node-id=nodeId
-
Required. For DSE Multi-Instance, the alphanumeric node name for the new node. The specified node name is automatically prepended with
dse-so that the resulting node ID isdse-nodeId. For example, if you specify node1, the resulting node name is dse-node1. - --advrep-directory=advrepdirectory
-
Optional. The DSE Advanced Replication data directory.
Default: </var/lib/dse-nodeId/advrep>
- --analytics
-
Enable DSE Analytics.
- --cdc-directory=cdcdirectory
-
Optional. The CDC raw data directory.
Default: /var/lib/dse-nodeId/cdc_raw
- --cluster=clustername
-
Optional. The name of the DataStax Enterprise (DSE) cluster that the new node belongs to. Only non-whitespace values are supported.
- --cpus=number_of_cpus
-
Optional. The number of cores.
- --commit-directory=commitdirectory
-
Optional. The commit log directory.
Default: /var/lib/dse-nodeId/commitlog
- --dc=datacenter_placement
-
Optional. The data center placement.
- --data-directory=datadirectory
-
Optional. The root directory for storing data.
Default: /var/lib/dse-nodeId/data
- --dsefs
-
Optional. Enable DSEFS.
- --dsefs-directory=dsefsdatadirectory
-
Optional. The DSEFS data directory.
Default: /var/lib/dse-nodeId/dsefs
- --graph
-
Optional. Enable DSE Graph.
- --hadoop-logs=hadooplogsdirectory
-
Optional. The log directory for Hadoop logs.
Default: logs-directory/hadoop
- --help
-
Optional. Send dse add-node option descriptions to standard output.
- --hints-directory=hintsdirectory
-
Optional. The hints directory.
Default:
/var/lib/<dse-nodeId>/hints - --jmxport=jmx_port
-
Optional. The DSE JMX metrics monitoring port.
- --listen-address=listen_IP_address
-
Optional. The IP address or hostname that DSE binds to when connecting to other nodes.
- --logs-directory=alllogsdirectory
-
Optional. The root directory for all of the logs.
Default:
/var/log/<dse-nodeId> - --max-heap-size=heapsize
-
Optional. The Java heap size. If you omit MB the size is interpreted as megabytes.
- --num-tokens=number_of_tokens
-
Optional. The number of tokens.
- --pig-logs=piglogdirectory
-
The log directory for Pig logs.
Default:
<logs-directory>/pig - --rack=rack_placement
-
Optional. The rack placement.
- --rpc-address=rpc_IP_address
-
Optional. The IP address or hostname that DSE binds to for RPC requests.
- --saved-caches-directory=savedcachesdirectory
-
Optional. The saved caches directory.
Default:
/var/lib/<dse-nodeId>/saved_caches - --search
-
Optional. Enable DSE Search.
- --seeds=IP_address1,IP_address2,…
-
Optional. A comma-separated list of IP addresses of the nodes to be used as seed nodes.
- --spark-local-directory=sparklocaldirectory
-
Optional. The local directory for an Apache Spark™ Worker.
Default:
/var/lib/`dse-nodeId/spark/rdd` - --spark-log-directory=sparklogdirectory
-
Optional. The log directory for Spark Worker.
Default:
/var/log/<dse-nodeId>/spark/worker - --spark-worker-cores=number_of_cores
-
Optional. The maximum number of cores used by Spark executors.
- --spark-worker-directory=sparkworkerdirectory
-
Optional. The data directory for Spark Worker.
Default:
/var/lib/<dse-nodeId>/spark/worker - --spark-worker-memory=memory
-
Optional. The maximum amount of memory used by Spark executors. Specify unit of measure with k (kilobytes), m (megabytes), g (gigabytes).
- --tomcat-logs=tomcatlogsdirectory
-
Optional. The log directory for tomcat logs.
Default:
<logs-directory>/tomcat - --unix-group=groupname
-
Optional. The UNIX group that owns the node configuration.
Default: cassandra
--unix-username=username ::+ Optional. The UNIX user that owns the node configuration.
+ Default: cassandra
Examples
Add a node that will join the cluster payroll on startup
dse add-node payrollnode --cluster payroll --listen-address 192.168.0.0
--rpc-address 192.168.0.1 --seeds 192.168.0.2
The payrollnode is created with the specified configuration options.