接続オプション
dsetoolユーティリティを使用してクラスターに接続するためのオプション。
構文
dsetool [connection_options] command command_args
構文規則 | 説明 |
---|---|
大文字 | リテラル・キーワード。 |
小文字 | リテラル以外。 |
Italics |
変数値。有効なオプションまたはユーザー定義値と置き換えます。 |
[ ] |
任意。角かっこ( [] )で任意のコマンド引数を囲みます。角かっこは入力しないでください。 |
( ) |
グループ。丸かっこ(( ) )は、選択肢を含むグループを示します。丸かっこは入力しないでください。 |
| |
または。縦棒(| )で代替要素を区切ります。要素のいずれかを入力してください。縦棒は入力しないでください。 |
... |
繰り返し可能。省略記号(... )は、構文要素を必要な回数だけ繰り返すことができることを示します。 |
'Literal string' |
単一引用符( ' )でCQL文内のリテラル文字を囲みます。大文字を維持するには、単一引用符を使用します。 |
{ key:value } |
マップ・コレクション。中かっこ( { } )でマップ・コレクションまたはキーと値のペアを囲みます。コロンでキーと値を区切ります。 |
<datatype1,datatype2> |
セット、リスト、マップ、またはタプル。山かっこ(< > )で、セット、リスト、マップまたはタプル内のデータ型を囲みます。データ型をカンマで区切ります。 |
cql_statement; |
CQL文の終了。セミコロン( ; )ですべてのCQL文を終了します。 |
[ -- ] |
コマンドライン・オプションとコマンド引数は、2つのハイフン(-- )で区切ります。この構文は、引数がコマンドライン・オプションと間違われる可能性がある場合に役立ちます。 |
' <schema> ...</schema> ' |
検索CQLのみ:単一引用符( ' )でXMLスキーマ宣言全体を囲みます。 |
@xml_entity='xml_entity_type' |
検索CQLのみ:スキーマ・ファイルおよびsolrconfigファイル内のXML要素を上書きする実体とリテラル値を示します。 |
JMX認証は、dsetoolコマンドの一部で使用されます。その他のdsetoolコマンドは、構成済みユーザーのユーザー名とパスワードを使用して認証します。接続オプションの短い形式と長い形式は、コンマで区切られます。
接続方法とdsetoolコマンドの認証方法を指定します。 注:
認証用の資格情報はさまざまな方法で提供できます。「認証のための資格情報」を参照してください。
dsetoolでKerberos認証を使用できるようにするには、「Kerberosが有効なクラスターでdsetoolを使用する」を参照してください。
このリストでは、短い形式(-f filename
)と長い形式(--config-file=filename
)を示します。
- -a, --jmxusername jmx_username
- セキュアなローカルJMXで認証するためのユーザー名。
- -b, --jmxpassword jmx_password
- セキュアなローカルJMXで認証するためのパスワード。パスワードを指定してしない場合、入力するように求められます。
- -c, --cassandra_port dse_port
- DSEポート番号。
- --cipher-suites ssl_cipher_suites
- SSLが有効な場合に、DSEに接続するためのSSL暗号化スイートのコンマ区切りリストを指定します。たとえば、--cipher-suites c1,c2,c3などです。
- -f, --config-file config_filename
- 資格情報を格納している構成ファイルのファイル・パス。この構成ファイル内の認証情報は、~/.dserc credentialsをオーバーライドします。指定しないと、~/.dserc(存在する場合)が使用されます。 構成ファイルには、DataStax EnterpriseおよびJMXのログイン認証情報を含めることができます。例を次に示します。
username=username password=password jmx_username=jmx_username jmx_password=jmx_password
構成ファイルの認証情報は、クリア・テキストで格納されます。DataStaxでは、このファイルへのアクセスを特定のユーザーのみに制限することを推奨しています。 - -h, --host IP_address
- 指定したホスト名またはIPアドレスに接続します。ローカル・ノードには接続しません。
- -j, --jmxport jmx_port
- リモートJMXエージェントのポート番号。
- --keystore-path ssl_keystore_path
- SSLクライアント認証が有効な場合に、DSEに接続するためのキーストアのパス。
- --keystore-password keystore_password
- SSLクライアント認証が有効な場合に、DSEに接続するためのキーストアのパスワード。
- --keystore-type ssl_keystore_type
- SSLクライアント認証が有効な場合に、DSEに接続するためのキーストアのタイプ。JKSはJava keytoolバイナリーによって生成されるキーのタイプですが、ユーザー環境によっては他のタイプである可能性もあります。
- -l, --username username
- データベース・アクセスのために認証するロール。
- -p, --password password
- データベース・アクセスを認証するためのパスワード。
- -s, --port solr_port
- Solrポート。
- --ssl true | false
- SSLをネイティブ接続に使用するかどうかを指定します。
- --ssl-protocol ssl_protocol
- SSLが有効な場合に、DSEに接続するためのSSLプロトコル。たとえば、--ssl-protocol ssl4などです。
- --sslauth true | false
- SSLクライアント認証を使用するかどうかを指定します。
- --truststore_password ssl_truststore_password
- SSLが有効な場合に、DSEへの接続に使用するトラストストア・パスワード。
- --truststore_path ssl_truststore_path
- SSLが有効な場合に、DSEへの接続に使用するトラストストアのパス。たとえば、--truststore-path /path/to/tsなどです。
- --truststore-type ssl_truststore_type
- SSLが有効な場合に、DSEに接続するためのトラストストアのタイプ。JKSはJava keytoolバイナリーによって生成されるキーのタイプですが、ユーザー環境によっては他のタイプである可能性もあります。たとえば、--truststore-type jks2などです。