第3章 コマンドラインインターフェイスの使用
コマンドラインインターフェイス (CLI) は、対話式ターミナルを使用してメッセージブローカーとの対話を可能にします。CLI を使用すると、ブローカーのアクションを管理したり、メッセージを設定したり、ファイルにユーザーとロールを追加したり、その他の便利なコマンドを入力したりできます。
CLI を使用して、Bash または Zsh シェル、あるいはカスタム artemis シェルでブローカーと対話できます。各シェルで同じコマンドが使用できます。デフォルトでは、artemis シェルにはコマンドとコマンドパラメーターの自動補完機能が組み込まれています。CLI コマンドとコマンドパラメーターの自動補完を Bash または Zsh シェルに追加することもできます。
3.1. artemis Shell で CLI の使用
artemis シェルインターフェイスは、artemis コマンドで使用できるコマンドとパラメーターの自動補完機能を提供します。シェルは、ブローカー URI やログイン認証情報などの提供された接続情報を、同じシェルセッションで実行する後続のコマンドにも再利用します。
手順
インストール中に作成したユーザーアカウントに切り替えます。以下に例を示します。
$ su - amq-broker
シェルを起動するには、
artemisコマンドを使用します。以下に例を示します。$ /var/opt/amq-broker/mybroker/bin/artemis
artemisシェルを起動するときにブローカー接続の詳細を指定する場合は、artemis shellコマンドを使用します。以下に例を示します。$ /var/opt/amq-broker/mybroker/bin/artemis shell --user myuser --password mypassword --url tcp://localhost:61616
提供された認証情報と URI は、ブローカーによる認証を必要とするシェルで実行される後続のコマンドに再利用されます。
Tab キーを押すと、シェル内の任意の場所に自動補完情報が表示されます。以下に例を示します。
-
artemisシェルで使用できるコマンドのリストを表示するには、シェルプロンプトで Tab キーを押します。 -
コマンドのサブコマンドを表示するには、コマンドの後に Tab キーを押します。たとえば、
checkと入力して Tab キーを押すと、checkコマンドのサブコマンドが表示されます。自動補完情報によると、checkコマンドはcluster、node、queueの 3 つのサブコマンドをサポートしています。 -
サブコマンドの自動補完情報を表示するには、サブコマンドの後に Tab キーを押します。たとえば、
check nodeと入力して Tab キーを押します。それ以上の自動補完情報が表示されない場合は、--(例:check node --) と入力し、Tab キーを押して、コマンドに使用できるパラメーターを表示します。
-
