コマンドユーティリティー (imqcmd) は、ブローカ、接続サービス、接続、物理的送信先、永続サブスクリプション、およびトランザクションの管理に使用します。
製品のバージョン情報または使用方法に関するヘルプを表示するための -v または -h オプションを使用する場合を除き、すべての imqcmd コマンドでサブコマンドを指定する必要があります。使用可能なサブコマンドのリストを次に示し、それらの詳細を以下の対応する節で説明します。サブコマンドがブローカアドレス (-b オプション) を受け付ける場合、ホスト名またはポート番号を指定しないときは常に、値はデフォルトで localhost および 7676 になります。
shutdown bkr |
ブローカをシャットダウンします |
restart bkr |
ブローカを再起動します |
pause bkr |
ブローカを停止します |
resume bkr |
ブローカを再開します |
update bkr |
ブローカのプロパティーを設定します |
reload cls |
クラスタ設定を再読み込みします |
query bkr |
ブローカのプロパティー値を一覧表示します |
metrics bkr |
ブローカのメトリックスを表示します |
pause svc |
接続サービスを停止します |
resume svc |
接続サービスを再開します |
update svc |
接続サービスのプロパティーを設定します |
list svc |
ブローカで使用可能な接続サービスを一覧表示します |
query svc |
接続サービスのプロパティー値を一覧表示します |
metrics svc |
接続サービスのメトリックスを表示します |
list cxn |
ブローカ上の接続を一覧表示します |
query cxn |
接続情報を表示します |
create dst |
物理的送信先を作成します |
destroy dst |
物理的送信先を破棄します |
pause dst |
物理的送信先のメッセージ配信を停止します |
resume dst |
物理的送信先のメッセージ配信を再開します |
update dst |
物理的送信先のプロパティーを設定します |
purge dst |
物理的送信先からすべてのメッセージを消去します |
compact dst |
物理的送信先を圧縮します |
list dst |
物理的送信先を一覧表示します |
query dst |
物理的送信先のプロパティー値を一覧表示します |
metrics dst |
物理的送信先のメトリックスを表示します |
destroy dur |
永続サブスクリプションを破棄します |
purge dur |
永続サブスクリプションのすべてのメッセージを消去します |
list dur |
トピックの永続サブスクリプションを一覧表示します |
commit txn |
トランザクションをコミットします |
rollback txn |
トランザクションをロールバックします |
list txn |
ブローカが追跡しているトランザクションを一覧表示します |
query txn |
トランザクション情報を表示します |
コマンドユーティリティーではブローカを起動できません。代わりにブローカユーティリティー (imqbrokerd) を使用します。ブローカの起動後は、表 13–2 に示す imqcmd サブコマンドを使用して、ブローカを管理および制御できます。
表 13–2 ブローカ管理のためのコマンドユーティリティーサブコマンド
構文 |
説明 |
---|---|
shutdown bkr [-b hostName :portNumber] | |
restart bkr [-b hostName :portNumber] |
ブローカをシャットダウンしてから、そのブローカの起動時に指定されたオプションを使用して再起動します。 |
pause bkr [-b hostName :portNumber] |
詳細については、「ブローカの停止」を参照してください。 |
resume bkr [-b hostName :portNumber] | |
update bkr [-b hostName :portNumber] -o property1= value1 [ [-o property2 =value2] … ] |
ブローカのプロパティーを設定します ブローカのプロパティーについては、第 14 章「ブローカのプロパティーのリファレンス」を参照してください。 |
reload cls |
クラスタ設定を再読み込みします [ブローカクラスタに対してのみ適用します] すべての持続情報を最新の状態にします。 |
query bkr -b hostName :portNumber |
ブローカのプロパティー値を一覧表示します クラスタでは、指定されたブローカに接続している実行中のすべてのブローカも一覧表示します。 |
metrics bkr [-b hostName :portNumber] [-m metricType] [-int interval] [-msp numSamples] |
ブローカのメトリックスを表示します -m オプションでは、表示するメトリックスのタイプを指定します。 ttl: ブローカで送受信されているメッセージとパケット rts: ブローカで送受信されているメッセージとパケットのフローレート (秒単位) cxn: 接続、仮想メモリーヒープ、およびスレッド デフォルト値: ttl。 -int オプションでは、メトリックスを表示する間隔を秒単位で指定します。デフォルト値: 5。 -msp オプションでは、表示するサンプル数を指定します。デフォルト値: 無制限 (無限)。 |
表 13–3 に、接続サービスを管理するための imqcmd サブコマンドを示します。
表 13–3 接続サービス管理のためのコマンドユーティリティーサブコマンド
構文 |
説明 |
---|---|
pause svc -n serviceName [-b hostName: portNumber] |
admin 接続サービスは停止できません。 |
resume svc -n serviceName [-b hostName: portNumber] | |
update svc -n serviceName [-b hostName: portNumber] -o property1= value1 [ [-o property2 =value2] … ] |
接続サービスのプロパティーを設定します 接続サービスのプロパティーについては、「接続のプロパティー」を参照してください。 |
list svc [-b hostName :portNumber] |
ブローカで使用可能な接続サービスを一覧表示します |
query svc -n serviceName [-b hostName: portNumber] |
接続サービスのプロパティー値を一覧表示します |
metrics svc -n serviceName [-b hostName: portNumber] [-m metricType] [-int interval] [-msp numSamples] |
接続サービスのメトリックスを表示します -m オプションでは、表示するメトリックスのタイプを指定します。 ttl: 指定の接続サービスを介してブローカで送受信されているメッセージとパケット rts: 指定の接続サービスを介してブローカで送受信されているメッセージとパケットのフローレート (秒単位) cxn: 接続、仮想メモリーヒープ、およびスレッド デフォルト値: ttl。 -int オプションでは、メトリックスを表示する間隔を秒単位で指定します。デフォルト値: 5。 -msp オプションでは、表示するサンプル数を指定します。デフォルト値: 無制限 (無限)。 |
表 13–4 に、接続を管理するための imqcmd サブコマンドを示します。
表 13–4 接続サービス管理のためのコマンドユーティリティーサブコマンド
構文 |
説明 |
---|---|
list cxn [-svn serviceName] [-b hostName: portNumber] |
指定された接続サービスに対する、ブローカ上のすべての接続を一覧表示します。接続サービスを指定しない場合は、すべての接続が一覧表示されます。 |
query cxn -n connectionID [-b hostName: portNumber] |
表 13–5 に、物理的送信先を管理するための imqcmd サブコマンドを示します。-t (送信先タイプ) オプションには常に、2 つの値のいずれかを指定できます。
q: キュー送信先
t: トピック送信先
構文 |
説明 |
---|---|
create dst -t destType -n destName [-o property1 =value1] [ [ -o property2 =value2] … ] |
物理的送信先を作成します [マスターブローカが一時的に使用できなくなっているブローカクラスタでは実行できません。] 送信先名 destName は、スペースを含まない英数字だけを使用でき、英字、下線 (_)、またはドル記号 ($) 文字で始める必要があります。文字列 mq で始めることはできません。 |
destroy dst -t destType -n destName |
物理的送信先を破棄します この操作は、デッドメッセージキューなど、システムが作成した送信先には適用できません。 |
pause dst [-t destType -n destName] [-pst pauseType] |
-t および -n オプションで指定された物理的送信先のメッセージ配信を停止します。これらのオプションを指定しない場合は、すべての送信先が停止されます。 -pst オプションでは、停止するメッセージ配信のタイプを指定します。 CONSUMERS: メッセージコンシューマへの配信を停止します PRODUCERS: メッセージプロデューサへの配信を停止します ALL: すべてのメッセージ配信を停止します デフォルト値: ALL |
resume dst [-t destType -ndestName] |
物理的送信先のメッセージ配信を再開します -t および -n オプションで指定された物理的送信先のメッセージ配信を再開します。これらのオプションを指定しない場合は、すべての送信先が再開されます。 |
update dst -t destType -n destName -o property1= value1 [ [ -o property2 =value2] … ] |
物理的送信先のプロパティーについては、第 15 章「物理的送信先のプロパティーのリファレンス」を参照してください。 |
purge dst -t destType -n destName | |
compact dst [-t destType -n destName] |
-t および -n オプションで指定された物理的送信先のファイルベースの持続データストアを圧縮します。これらのオプションを指定しない場合は、すべての送信先が圧縮されます。 圧縮する前に、対象の送信先を停止する必要があります。 |
list dst [-t destType] [-tmp] |
物理的送信先を一覧表示します -t オプションで指定されたタイプのすべての物理的送信先を一覧表示します。送信先タイプを指定しない場合は、キューとトピックの両方の送信先が一覧表示されます。-tmp オプションを指定した場合は、一時的送信先も一覧表示されます。 |
query dst -t destType -n destName | |
metrics dst -t destType -n destName [-m metricType] [-int interval] [-msp numSamples] |
物理的送信先のメトリックスを表示します -m オプションでは、表示するメトリックスのタイプを指定します。 ttl: 送信先で送受信されているメッセージとパケットおよびメモリー内のメッセージとパケット rts: ブローカで送受信されているメッセージとパケットのフローレート (秒単位)、およびその他のレート情報 con: メッセージコンシューマに関するメトリックス dsk: ディスク使用率 デフォルト値: ttl。 -int オプションでは、メトリックスを表示する間隔を秒単位で指定します。デフォルト値: 5。 -msp オプションでは、表示するサンプル数を指定します。デフォルト値: 無制限 (無限)。 |
表 13–6 に、永続サブスクリプションを管理するための imqcmd サブコマンドを示します。
表 13–6 永続サブスクリプション管理のためのコマンドユーティリティーサブコマンド
構文 |
説明 |
---|---|
destroy dur -c clientID -n subscriberName |
永続サブスクリプションを破棄します [マスターブローカが一時的に使用できなくなっているブローカクラスタでは実行できません。] |
purge dur -c clientID -n subscriberName | |
list dur -d topicName |
表 13–7 に、トランザクションを管理するための imqcmd サブコマンドを示します。
表 13–7 トランザクション管理のためのコマンドユーティリティーサブコマンド
構文 |
説明 |
---|---|
commit txn -n transactionID | |
rollback txn -n transactionID | |
list txn | |
query txn -n transactionID |
表 13–8 に示す追加のオプションは、imqcmd コマンドのすべてのサブコマンドに適用できます。
表 13–8 一般的なコマンドユーティリティーオプション
オプション |
説明 |
---|---|
-secure | |
-u userName |
認証のためのユーザー名 このオプションを省略すると、コマンドユーティリティーによってインタラクティブに要求されます。 |
-p password |
認証のためのパスワード [このオプションは異論が多く、最終的には削除される予定です。パスワードを省略して、ユーザーがインタラクティブにパスワードが要求されるようにするか、または -passfile オプションを使用して、パスワードが含まれるパスワードファイルを指定します。] |
-passfile path |
パスワードファイルの場所 詳細については、「パスワードファイル」を参照してください。 |
-rtm timeoutInterval |
初期タイムアウト間隔 (秒単位) これは、コマンドユーティリティーが要求を再試行するまでの、ブローカからの応答を待つ時間の初期値です。その後の各再試行では、タイムアウト間隔として、この初期間隔の倍数が使用されます。 デフォルト値: 10。 |
-rtr numRetries |
ブローカ要求がタイムアウトになったあとの再試行の回数 デフォルト値: 5。 |
-javahome path |
デフォルトの動作: システムにインストールされているランタイム、または Message Queue にバンドルされているランタイムが使用されます。 |
-f |
ユーザーの確認なしでアクションを実行します |
-s |
サイレントモード (出力の表示なし) |
-v |
バージョン情報を表示します [コマンド行に指定したその他のオプションはすべて無視されます。] , [ユーザー名とパスワードは必要ありません] |
-h | |
-H |
属性リストや例を含む、使用方法に関する詳細なヘルプを表示します, |