Confluent Platform の CLI ツール¶
Confluent Platform には以下のコマンドラインツールが用意されています。これらは、個別にインストールされる ccloud ツールを除き、すべて Confluent Platform の bin ディレクトリに含まれています。
| 名前 | 説明 |
|---|---|
| ccloud | このツールは、Confluent Cloud で Apache Kafka® のトピックを作成して管理します。詳細については、「Confluent Cloud CLI」を参照してください。 |
| confluent | このツールは、RBAC、シークレット、単一ノードの Confluent Platform インスタンスをデプロイする機能や、トピックの作成、アップデート、削除を含めて、Confluent Platform を管理します。詳細については、「Confluent CLI」を参照してください。 |
| confluent-hub | このツールは、コネクターをインストールして管理します。詳細については、「Confluent Hub コマンドリファレンス」を参照してください。 |
| confluent-rebalancer | このツールは、ブローカー間でデータとパーティションのバランスを調整します。詳細については、「データの自動バランス調整」を参照してください。 |
| connect-distributed | This tool runs Connect in distributed mode. For more information, see Getting Started with Kafka Connect. |
| connect-standalone | This tool runs Connect in standalone mode. For more information, see see Getting Started with Kafka Connect. |
| control-center-3_0_0-reset | このツールは、Control Center バージョン 3.0.0 からのアップグレード時に使用されます。詳細については、「Control Center のアップグレード」を参照してください。 |
| control-center-3_0_1-reset | このツールは、Control Center バージョン 3.0.1 からのアップグレード時に使用されます。詳細については、「Control Center のアップグレード」を参照してください。 |
| control-center-console-consumer | このツールは、Control Center コンソールコンシューマーを起動します。 詳細については、「Confluent モニタリングインターセプター」を参照してください。 |
| control-center-export | このツールは、データを Control Center から出力ファイルにエクスポートします。 |
| control-center-reset | このツールは、Control Center をリセットしてすべてのデータを削除します。詳細については、「Control Center のインストールと構成」を参照してください。 |
| control-center-run-class | このツールは、Control Center Java クラスのシンラッパーです。主にスクリプトの開始と停止に使用され、単独では実行されません。 |
| control-center-set-acls | このツールは、Control Center ACL の設定に使用されます。詳細については、「Control Center UI 認証」を参照してください。 |
| control-center-start | このツールは、Control Center を開始します。使用例については、「ZIP アーカイブと TAR アーカイブを使用した手動インストール」を参照してください。 |
| control-center-stop | このツールは、Control Center を停止します。使用例については、「ブローカー構成の動的な編集の有効化および無効化」を参照してください。 |
| kafka-acls | このツールは、ACL を追加、削除、およびリストします。詳細については、「ACL を使用した認可」を参照してください。 |
| kafka-avro-console-consumer | このツールは、コンソールから JSON 形式の Avro データを受信します。詳細については、「フォーマット、シリアライザー、逆シリアライザー」を参照してください。 |
| kafka-avro-console-producer | このツールは、コンソールに JSON 形式の Avro データを送信します。詳細については、「フォーマット、シリアライザー、逆シリアライザー」を参照してください。 |
| kafka-broker-api-versions | このツールは、クラスター内のすべてのノードの API バージョンを表示します。 |
| kafka-configs | このツールは、ブローカー構成とトピック構成をアップデートします。詳細については、「ブローカー構成の動的な変更」および「トピックの変更」を参照してください。 |
| kafka-console-consumer | このツールは、Kafka トピックからデータを読み取り、STDOUT に出力を送信します。詳細については「Kafka コンシューマー」を参照してください。 |
| kafka-console-producer | このツールは、Kafka トピックにデータを送信します。詳細については「Kafka プロデューサー」を参照してください。 |
| kafka-consumer-groups | このツールは、クラスターのアクティブなグループのリストを取得します。詳細については、「Kafka コンシューマーグループのコマンドツール」を参照してください。 |
| kafka-consumer-perf-test | このツールは、Kafka クラスターのコンシューマーパフォーマンスをテストします。 |
| kafka-delegation-tokens | このツールは、委任トークンの作成、更新、有効期限切れ設定、および記述を行います。詳細については、「委任トークンを使用した認証」を参照してください。 |
| kafka-delete-records | このツールは、パーティションレコードを削除します。 |
| kafka-dump-log | このツールは、ログファイルを解析し、その内容をコンソールにダンプします。これはログセグメントのデバッグに役立ちます。 |
| kafka-leader-election | このツールは、トピックパーティションのリーダー選出を開始します。 |
| kafka-log-dirs | このツールは、ブローカー上のログディレクトリごとにレプリカのリストを取得します。 |
| kafka-mirror-maker | このツールは、MirrorMaker を実行します。詳細については、Kafka ドキュメントの「Mirroring data between clusters」を参照してください。 |
| kafka-mqtt-run-class | このツールは、MQTT Proxy Java クラスのシンラッパーです。主にスクリプトの開始と停止に使用され、単独では実行されません。詳細については、「はじめに」を参照してください。 |
| kafka-mqtt-start | このツールは、MQTT Proxy を開始します。詳細については、「はじめに」を参照してください。 |
| kafka-mqtt-stop | このツールは、MQTT Proxy を停止します。詳細については、「はじめに」を参照してください。 |
| kafka-preferred-replica-election | このツールは、各パーティションのリーダーシップを "優先レプリカ" に戻し、サーバー間のリーダーシップのバランスを調整するために使用されます。詳細については、Apache Kafka wiki を参照してください。このツールは Kafka 2.4 で非推奨になり、kafka-leader-election に置き換えられました。 |
| kafka-producer-perf-test | このツールは、Kafka クラスターのプロデューサーパフォーマンスをテストします。詳細については、「データの自動バランス調整」を参照してください。 |
| kafka-protobuf-console-producer | このツールは、コンソールに JSON 形式の Protobuf データを送信します。詳細については、「フォーマット、シリアライザー、逆シリアライザー」を参照してください。 |
| kafka-protobuf-console-consumer | このツールは、コンソールから JSON 形式の Protobuf データを受信します。詳細については、「フォーマット、シリアライザー、逆シリアライザー」を参照してください。 |
| kafka-json-schema-console-producer | このツールは、コンソールから JSON 形式の JSON スキーマデータを送信します。詳細については、「フォーマット、シリアライザー、逆シリアライザー」を参照してください。 |
| kafka-json-schema-console-consumer | このツールは、コンソールから JSON 形式の JSON スキーマデータを受信します。詳細については、「フォーマット、シリアライザー、逆シリアライザー」を参照してください。 |
| kafka-reassign-partitions | このツールは、レプリカ間でトピックのパーティションを移動します。詳細については、「クラスターのスケーリング（Kafka クラスターへのノードの追加）」を参照してください。 |
| kafka-replica-verification | このツールは、一連のトピックのすべてのレプリカが同じデータを持つことを検証します。 |
| kafka-rest-run-class | このツールは、REST Proxy Java クラスのシンラッパーです。主にスクリプトの開始と停止に使用され、単独では実行されません。詳細については、「Confluent REST API」を参照してください。 |
| kafka-rest-start | このツールは、REST Proxy を開始します。詳細については、「Confluent REST API」を参照してください。 |
| kafka-rest-stop | このツールは、REST Proxy を停止します。詳細については、「Confluent REST API」を参照してください。 |
| kafka-rest-stop-service | このツールは、REST Proxy の実行中のインスタンスをすべて停止します。詳細については、「Confluent REST API」を参照してください。 |
| kafka-run-class | このツールは、Kafka Java クラスのシンラッパーです。主にスクリプトの開始と停止に使用され、単独では実行されません。 |
| kafka-server-start | このツールは、Kafka を開始します。 |
| kafka-server-stop | このツールは、Kafka を停止します。 |
| kafka-streams-application-reset | このツールは、アプリケーションをリセットし、そのデータを最初から再処理するように強制します。詳細については、「Kafka Streams アプリケーションリセットツール」を参照してください。 |
| kafka-topics | このツールは、Kafka トピックの作成、削除、説明、または変更に使用されます。詳細については、「トピックの追加」を参照してください。 |
| kafka-verifiable-consumer | このツールは、トピックからのメッセージを消費し、コンシューマーイベントを JSON オブジェクトとして STDOUT に発行します。イベントの例として、グループのバランス調整、受信メッセージ、コミットされたオフセットなどがあります。 |
| kafka-verifiable-producer | このツールは、指定されたトピックに対して増加する整数を生成し、"送信" リクエストごとに JSON メタデータを STDOUT に出力します。これにより、どのメッセージが acked され、どのメッセージがされていないかが外部から確認できます。 |
| ksql | このツールは、ksqlDB を実行します。詳細については、「ksqlDB CLI の構成」を参照してください。 |
| ksql-datagen | このツールは、定義したカスタムスキーマに準拠するテストデータを生成します。詳細については、「テストデータの生成」を参照してください。 |
| ksql-run-class | このツールは、ksqlDB Java クラスのシンラッパーです。主にスクリプトの開始と停止に使用され、単独では実行されません。 |
| ksql-server-start | このツールは、ksqlDB サーバーを起動します。詳細については、「ksqlDB サーバーの起動」を参照してください。 |
| ksql-server-stop | このツールは、ksqlDB サーバーを停止します。詳細については、「ksqlDB の運用」を参照してください。 |
| ksql-stop | このツールは、ksqlDB CLI を停止します。詳細については、「ksqlDB のインストール」を参照してください。 |
| replicator | このツールは、Replicator を実行します。詳細については「概要」を参照してください。 |
| replicator-verifier | このツールは Replicator 構成を検証します。詳細については、「Replicator 構成の検証」を参照してください。 |
| schema-registry-run-class | このツールは、Schema Registry Java クラスのシンラッパーです。主にスクリプトの開始と停止に使用され、単独では実行されません。詳細については、「Schema Registry API の使用例」を参照してください。 |
| schema-registry-start | このツールは、Schema Registry を開始します。詳細については、「Schema Registry API の使用例」を参照してください。 |
| schema-registry-stop | このツールは、Schema Registry を停止します。詳細については、「Schema Registry API の使用例」を参照してください。 |
| schema-registry-stop-service | このツールは、Schema Registry の実行中のインスタンスをすべて停止します。詳細については、「Schema Registry API の使用例」を参照してください。 |
| security-plugins-run-class | このツールは、Confluent セキュリティプラグインの Java クラスのシンラッパーです。主にスクリプトの開始と停止に使用され、単独では実行されません。 |
| sr-acl-cli | このツールは、Schema Registry ACL CLI ツールを実行します。詳細については、「Schema Registry ACL オーソライザー」を参照してください。 |
| support-metrics-bundle | このツールは、カレントディレクトリに "サポートメトリクスバンドル" ファイルを作成します。 |
| zookeeper-security-migration | このツールは、ZooKeeper 認証のセットアッププロセスの一部として znode の ACL をアップデートするために使用されます。詳細については、「実行中の ZooKeeper クラスターへのセキュリティの追加」を参照してください。 |
| zookeeper-server-start | このツールは、ZooKeeper を開始します。詳細については、「ZIP アーカイブと TAR アーカイブを使用した手動インストール」を参照してください。 |
| zookeeper-server-stop | このツールは、ZooKeeper を停止します。詳細については、「ZIP アーカイブと TAR アーカイブを使用した手動インストール」を参照してください。 |
| zookeeper-shell | このツールは、ZooKeeper シェルに接続します。 |