名前
imqcmd - メッセージブローカの管理
形式
(1)サブコマンドの実行
imqcmd サブコマンド "オプション"
(2)ヘルプの表示
imqcmd {-help|-h|-Help|-H}
(3)バージョン情報の表示
imqcmd {-version|-v}
機能説明
メッセージブローカの定義変更、物理格納先の作成、定義変更、削除などを行います。
以下のサブコマンドがあります。
サブコマンド | 説明 |
---|---|
物理格納先を作成します。 | |
コネクションを削除します。 | |
物理格納先を削除します。 | |
永続サブスクリプションを削除します。 | |
ブローカのコネクションをリストします。 | |
ブローカの物理格納先をリストします。 | |
トピックの永続サブスクリプションをリストします。 | |
ブローカのサービスをリストします。 | |
ブローカのすべてのサービスを一時停止します。 | |
1つまたはすべての物理格納先を一時停止します。 | |
1つのサービスを一時停止します。 | |
物理格納先を削除しないで、物理格納先のすべてのメッセージを破棄します。 | |
永続サブスクリプションを削除しないで、永続サブスクリプションのすべてのメッセージを破棄します。 | |
ブローカの情報を照会し表示します。 | |
コネクション情報を照会し表示します。 | |
物理格納先の情報を照会し表示します。 | |
サービスの情報を照会し表示します。 | |
ブローカでのコネクションの新規受け入れを停止します。 | |
ブローカを再起動します。 | |
ブローカのすべてのサービスを再開します。 | |
1つまたはすべての物理格納先を再開します。 | |
1つのサービスを再開します。 | |
ブローカを停止します。 | |
ブローカでのコネクションの新規受け入れを開始します。 | |
ブローカの属性を更新します。 | |
物理格納先の属性を更新します。 | |
サービスの属性を更新します。 |
オプション
オプション名 | 簡略名 | 説明 |
---|---|---|
-b |
| メッセージブローカのホスト名とポート番号を「ホスト名:ポート番号」の形式で指定します。 |
-c |
| クライアントIDを指定します。 |
-d |
| 永続サブスクリプションに対する操作の場合、トピック名を指定します。 |
-f |
| ユーザの確認なしでアクションを実行します。 |
-help | -h | 使用法のヘルプを表示します。 |
-Help | -H | 使用法のヘルプ、属性リスト、および例を表示します。 |
-javahome |
| 使用する代替のJava 2互換ランタイムを指定します。 |
-n |
| 引数の名前(例、サービス名、物理格納先名、永続サブスクリプション名、トランザクションID、またはコネクションID)を指定します。 |
-o |
| 引数プロパティ(例、送信先プロパティ)を指定します。 |
-pst |
| 物理格納先一時停止タイプを指定します。
|
-rtm |
| 管理受信タイムアウトを秒単位で指定します。デフォルトは 「10」です。 |
-rtr |
| 管理再試行の数を指定します。デフォルトは「5」です。 |
-s |
| サイレントモード。出力は表示されません。 |
-svn |
| サービス名を指定します。接続を表示する場合にだけ使用します。 |
-t |
| 物理格納先のタイプを、q(キューの場合)またはt(トピックの場合)で指定します。 |
-time |
| 停止までの秒数を指定します。メッセージブローカの停止時だけ使用します。 |
-tmp |
| 一時物理格納先も表示します。 |
-u |
| 管理者ユーザ名を指定します。 |
-version | -v | バージョン情報を表示します。 |
サブコマンド
物理格納先を作成します。
物理格納先タイプには、q(キューの場合)、またはt(トピックの場合)のいずれかを設定してください。物理格納先名には、スペースを含まない英数字、下線文字(_)、ドル記号($)だけを使用でき、英字、下線(_)、またはドル記号($)文字で始める必要があります。文字列「mq.」で始めることはできません。
物理格納先のプロパティ詳細については、「9.7.7 物理格納先の生成または更新に関するプロパティ」を参照してください。
コネクションを削除します。
物理格納先を削除します。デッドメッセージキューを削除することはできません。
永続サブスクリプションを削除します。
注意
list durサブコマンドを使用して、削除対象のDurableSubscriptionの状態が「INACTIVE」になっていることを確認してから、本コマンドを実行してください。
メッセージブローカのコネクションをリストします。
指定した接続サービスに対する、メッセージブローカ上のすべての接続を一覧表示します。接続サービスを指定しない場合は、すべての接続が一覧表示されます。
注意
メッセージブローカのコネクションを切断中に本コマンドを実行した場合、切断処理中のコネクションのユーザ名にIJMQで始まるメッセージが出力されます。ユーザ名にIJMQで始まるメッセージが出力された場合、各メッセージのユーザの対処を参照して、対処を行ってください。
imqcmd list cxnコマンドを使用して参照する方法について説明します。
以下に、表示例と表示するコネクションの情報を示します。
表示例
imqcmd list cxn Listing all the connections on the broker specified by: --------------------------------------- Host(※1) Primary Port --------------------------------------- localhost 7676 ------------------------------------------------------------------------------- Connection ID User Service Producers Consumers Host(※2) ------------------------------------------------------------------------------- 504153610318406656 guest jms 0 0 127.0.0.1 504153611584544512 admin admin 1 1 127.0.0.1 |
表示するコネクションの情報
表示する項目 | 内容 |
---|---|
Host (※1) | メッセージブローカの起動しているホスト名です。 |
Primary Port | メッセージブローカの起動しているポート番号です。 |
Connection ID | メッセージブローカに接続時に一意に設定されるIDです。 |
User | 接続しているユーザ名です。 |
Service | 接続しているサービス名です。
|
Producers | 接続しているプロデューサの数です。 |
Consumers | 接続しているコンシューマの数です。 |
Host (※2) | 接続しているクライアントのIPアドレスです。 |
物理格納先を一覧表示します。
-tオプションで指定したタイプのすべての物理格納先を一覧表示します。物理格納先タイプを指定しない場合は、キューとトピックの両方の物理格納先が一覧表示されます。-tmpオプションを指定した場合は、一時物理格納先も一覧表示されます。
imqcmd list dstコマンドを使用して参照する方法について説明します。
以下に、表示例と表示する物理格納先の情報を示します。
表示例
imqcmd list dst Listing all the destinations on the broker specified by: ------------------------------------------ Host Primary Port ------------------------------------------ localhost 7676 ------------------------------------------------------------------------------- Name Type State Producers Consumers Msgs Total Count UnAck Avg Size ------------------------------------------------------------------------------- mq.sys.dmq Queue RUNNING 0 0 0 0 0.0 topic Topic RUNNING 0 0 0 0 0.0 |
imqcmd list dst -t q ------------------------------------------ Host Primary Port ------------------------------------------ localhost 7676 ------------------------------------------------------------------------------- Name Type State Producers Consumers Msgs Active Backup Count UnAck Avg Size ------------------------------------------------------------------------------- mq.sys.dmq Queue RUNNING 0 0 0 0 0 0.0 |
表示する物理格納先の情報
表示する項目 | 内容 |
---|---|
Host | メッセージブローカの起動しているホスト名です。 |
Primary Port | メッセージブローカの起動しているポート番号です。 |
Name | 表示対象となる物理格納先名です。 |
Type | 物理格納先タイプです。
|
State | 物理格納先の状態を示します。
|
Producers | 物理格納先に接続しているプロデューサ数です。 |
Consumers - Total | 物理格納先に接続しているコンシューマ数です。 |
Consumers - Active | 物理格納先からメッセージを受信可能なコンシューマ数です。 |
Consumers - Backup | 物理格納先からメッセージを受信待機しているコンシューマ数です。 |
Msgs - Count | 物理格納先に蓄積しているメッセージ数です。 |
Msgs - UnAck | トランザクション処理中の送受信メッセージ数と接続コンシューマに配信処理中のメッセージ数の総和 |
Msgs - Avg Size | 物理格納先に蓄積しているメッセージの平均サイズです。 |
トピックの永続サブスクリプションをリストします。
imqcmd list durコマンドを使用して参照する方法について説明します。
以下に、表示例と表示するDurableSubscriptionの情報を示します。
表示例
imqcmd list dur -d topic Listing all durable subscriptions on the topic 'topic' on the broker specified by: ------------------------------------------ Host Primary Port ------------------------------------------ localhost 7676 ------------------------------------------------------------------------------- Durable Sub. Name Client ID Number of Messages Durable Sub. State ------------------------------------------------------------------------------- a a_cid 0 ACTIVE a cid 0 INACTIVE |
表示するDurableSubscriptionの情報
表示する項目 | 内容 |
---|---|
Host | メッセージブローカの起動しているホスト名です。 |
Primary Port | メッセージブローカの起動しているポート番号です。 |
Durable Sub. Name | DurableSubscriptionの識別名です。 |
Client ID | コネクションごとに設定されるIDとなります。重複することはできません。 |
Number of Messages | JMSクライアントに配信待ちのメッセージ数です。 |
Durable Sub. State | DurableSubscriptionの状態を示します。
|
メッセージブローカのサービスをリストします。
imqcmd list svcコマンドを使用して参照する方法について説明します。
以下に、表示例と表示するサービスの情報を示します。
表示例
imqcmd list svc Listing all the services on the broker specified by: ------------------------------------------ Host Primary Port ------------------------------------------ localhost 7676 ------------------------------------------------------------------------------- Service Name Port Number Service State ------------------------------------------------------------------------------- admin 49462 (dynamic) RUNNING httpjms - UNKNOWN httpsjms - UNKNOWN jms 44444 (static) RUNNING ssladmin dynamic UNKNOWN ssljms dynamic UNKNOWN |
表示するサービスの情報
表示する項目 | 内容 |
---|---|
Host | メッセージブローカの起動しているホスト名です。 |
Primary Port | メッセージブローカの起動しているポート番号です。 |
Service Name | 表示対象となるサービス名です。
|
Port Number | サービスが使用しているポート番号です。
|
Service State | サービスの状態を示します。
|
メッセージブローカのすべてのサービスを一時停止します。
メッセージブローカを停止すると、メッセージブローカの接続サービススレッドが中断されるため、メッセージブローカは接続ポートでの待機を止めます。その結果、メッセージブローカはそれ以上、新しい接続の受け入れ、メッセージの受信は行いません。
ただし、メッセージブローカを停止してもadmin接続サービスは中断されないため、メッセージブローカへのメッセージを制限するために必要な管理タスクは実行できます。
注意
メッセージブローカがすでに一時停止状態の場合もコマンドは正常復帰します。
1つまたはすべての物理格納先を一時停止します。
一時停止する物理格納先を指定しない場合、すべての物理格納先が一時停止されます。
-pstオプションでは、一時停止するメッセージ配信のタイプを指定します(デフォルトは「ALL」です)。
CONSUMERS: Consumerへの配信を一時停止します。
PRODUCERS: Producerからの受信を一時停止します。
ALL: すべてのメッセージ処理を一時停止します。
注意
指定された物理格納先がすでに一時停止状態の場合もコマンドは正常復帰します。
1つのサービスを一時停止します。admin接続サービスは一時停止できません。
注意
指定されたサービスがすでに一時停止状態の場合もコマンドは正常復帰します。
物理格納先を削除しないで、物理格納先のすべてのメッセージを破棄します。
永続サブスクリプションを削除しないで、永続サブスクリプションのすべてのメッセージを破棄します。
メッセージブローカのプロパティ情報を表示します。
imqcmd query bkrコマンドを使用して参照する方法について説明します。
以下に、表示例と表示するメッセージブローカの情報を示します。
表示例
imqcmd query bkr Querying the broker specified by: ------------------------------------------ Host Primary Port (※1) ------------------------------------------ localhost 7676 Version 4.1 Instance Name imqbroker Broker ID Primary Port (※2) 7676 Broker is Embedded false Instance Configuration/Data Root Directory /var/opt/FJSVisjee/domains/interstage/imq Current Number of Messages in System 0 Current Total Message Bytes in System 0 Current Number of Messages in Dead Message Queue 0 Current Total Message Bytes in Dead Message Queue 0 Log Dead Messages false Truncate Message Body in Dead Message Queue false Max Number of Messages in System unlimited (-1) Max Total Message Bytes in System unlimited (-1) Max Message Size 70m Auto Create Queues true Auto Create Topics true Auto Created Queue Max Number of Active Consumers unlimited (-1) Auto Created Queue Max Number of Backup Consumers 0 Cluster ID Cluster is Highly Available false Cluster Broker List (active) mq://127.0.0.1:7676/ Cluster Broker List (configured) Cluster Master Broker Cluster URL Log Level INFO Log Rollover Interval (seconds) 604800 Log Rollover Size (bytes) 268435456 |
表示するメッセージブローカの情報
表示する項目 | 内容 |
---|---|
Host | メッセージブローカの起動しているホスト名を表示します。 |
Primary Port (※1) | メッセージブローカの起動しているポート番号を表示します。 |
Version | メッセージブローカのバージョンを表示します。 |
Instance Name | メッセージブローカのインスタンス名を表示します。 |
Broker ID | 未サポートの項目です。 |
Primary Port (※2) | ポートマッパー機能の代表ポートを表示します。 |
Broker is Embedded | 未サポートの項目です。 |
Instance Configuration/Data Root Directory | メッセージブローカの資材格納先を表示します。 |
Current Number of Messages in System | メッセージブローカに蓄積されているメッセージ数を表示します。 |
Current Total Message Bytes in System | メッセージブローカに蓄積されているメッセージサイズを表示します。 |
Current Number of Messages in Dead Message Queue | デッドメッセージキューに蓄積されているメッセージ数を表示します。 |
Current Total Message Bytes in Dead Message Queue | デッドメッセージキューに蓄積されているメッセージサイズを表示します。 |
Log Dead Messages | デッドメッセージのログ出力設定を表示します。
|
Truncate Message Body in Dead Message Queue | デッドメッセージの蓄積方法を表示します。
|
Max Number of Messages in System | メッセージブローカが蓄積可能なメッセージの最大数を表示します。 |
Max Total Message Bytes in System | メッセージブローカが蓄積可能なメッセージの最大サイズを表示します。 |
Max Message Size | メッセージブローカが蓄積可能な単一メッセージの最大サイズを表示します。 |
Auto Create Queues | Queueの物理格納先自動生成が可能かどうかを表示します。
|
Auto Create Topics | Topicの物理格納先自動生成が可能かどうかを表示します。
|
Auto Created Queue Max Number of Active Consumers | 自動生成されたQueueの接続可能なコンシューマ最大数を表示します。 |
Auto Created Queue Max Number of Backup Consumers | 自動生成されたQueueの接続待機可能なコンシューマ最大数を表示します。 |
Cluster ID | 未サポートの項目です。 |
Cluster is Highly Available | 未サポートの項目です。 |
Cluster Broker List (active) | 未サポートの項目です。 |
Cluster Broker List (configured) | 未サポートの項目です。 |
Cluster Master Broker | 未サポートの項目です。 |
Cluster URL | 未サポートの項目です。 |
Log Level | 未サポートの項目です。 |
Log Rollover Interval | 出力を新しいログファイルにローテーションーする期間を表示します。 |
Log Rollover Size | 出力を新しいログファイルにローテーションーするファイルサイズを表示します。 |
コネクション情報を照会し表示します。
imqcmd query cxnコマンドを使用して参照する方法について説明します。
以下に、表示例と表示するコネクションの情報を示します。
表示例
imqcmd query svc -n 2965370868928146944 Querying the connection where: ---------------------------- Connection ID (※1) ---------------------------- 2965370868928146944 On the broker specified by: ------------------------------------------ Host Primary Port (※2) ------------------------------------------ localhost 7676 Connection ID (※3) 2965370868928146944 User admin Service admin Producers 1 Consumers 1 Host (※4) 127.0.0.1 Port 50508 Client ID Client Platform Message Queue/4.1 (JMS; Linux 2.6.18-53.el5 i386) |
表示するコネクションの情報
表示する項目 | 内容 |
---|---|
Connection ID (※1) | コマンド実行時に指定されたコネクションIDを表示します。 |
Host | メッセージブローカの起動しているホスト名を表示します。 |
Primary Port (※2) | メッセージブローカの起動しているポート番号を表示します。 |
Connection ID (※3) | 詳細情報を表示するコネクションIDを表示します。 |
User | コネクションを使用しているユーザ名を表示します。 |
Service | コネクションを使用しているサービス名を表示します。
|
Producers | 本コネクションが接続しているプロデューサ数を表示します。 |
Consumers | 本コネクションが接続しているコンシューマ数を表示します。 |
Host (※4) | コネクションを接続したホストのIPアドレスを表示します。 |
Port | サービスが実際に使用するポート番号を表示します。 |
Client ID | コネクションに設定されているクライアントIDを表示します。 |
Client Platform | コネクションに接続しているクライアントの製品およびプラットホームを表示します。 |
物理格納先の情報を照会し表示します。
imqcmd query dstコマンドを使用して参照する方法について説明します。
以下に、表示例と表示する物理格納先の情報の情報を示します。
表示例
imqcmd query dst -t q -n q1 Querying the destination where: --------------------------------------------------------------- Destination Name (※1) Destination Type (※2) --------------------------------------------------------------- q1 Queue On the broker specified by: ------------------------------------------ Host Primary Port ------------------------------------------ localhost 7676 Destination Name (※3) q1 Destination Type (※4) Queue Destination State RUNNING Created Administratively true Current Number of Messages Actual 0 Held in Transaction 0 Current Message Bytes Actual 0 Held in Transaction 0 Current Number of Producers 0 Current Number of Active Consumers 0 Current Number of Backup Consumers 0 Max Number of Messages unlimited (-1) Max Total Message Bytes unlimited (-1) Max Bytes per Message unlimited (-1) Max Number of Producers 100 Max Number of Active Consumers unlimited (-1) Max Number of Backup Consumers 0 Limit Behavior REJECT_NEWEST Consumer Flow Limit 1000 Is Local Destination false Local Delivery is Preferred false Use Dead Message Queue true |
表示する物理格納先の情報
表示する項目 | 内容 |
---|---|
Destination Name (※1) | コマンド実行時に指定した物理格納先名を表示します。 |
Destination Type (※2) | コマンド実行時に指定した物理格納先タイプを表示します。 |
Host | メッセージブローカの起動しているホスト名を表示します。 |
Primary Port | メッセージブローカの起動しているポート番号を表示します。 |
Destination Name (※3) | 物理格納先名を表示します。 |
Destination Type (※4) | 物理格納先タイプを表示します。
|
Destination State | 物理格納先の状態を表示します。
|
Created Administratively | 未サポート項目です。 |
Current Number of Messages - Actual | 物理格納先に蓄積しているメッセージ数を表示します。 |
Current Number of Messages - Held in Transaction | トランザクション処理中のメッセージ数を表示します。 |
Current Message Bytes - Actual | 物理格納先に蓄積しているメッセージサイズを表示します。 |
Current Message Bytes - Held in Transaction | トランザクション処理中のメッセージサイズを表示します。 |
Current Number of Producers | 物理格納先に接続しているプロデューサ数を表示します。 |
Current Number of Active Consumers | 物理格納先に接続している受信処理中のコンシューマ数を表示します。 |
Current Number of Backup Consumers | 物理格納先に接続している受信待機中のコンシューマ数を表示します。 |
Max Number of Messages | 物理格納先に蓄積可能なメッセージの最大数を表示します。 |
Max Total Message Bytes | 物理格納先に蓄積可能なメッセージの最大サイズを表示します。 |
Max Bytes per Message | 物理格納先に蓄積可能な単一メッセージの最大サイズを表示します。 |
Max Number of Producers | 物理格納先に接続可能なプロデューサの最大数を表示します。 |
Max Number of Active Consumers | 物理格納先からメッセージを受信できるコンシューマの最大数を表示します。 |
Max Number of Backup Consumers | 物理格納先からメッセージを受信待機できるコンシューマの最大数を表示します。 |
Limit Behavior | メッセージを蓄積できない場合の応答方法を表示します。
|
Consumer Flow Limit | 1つのコンシューマに事前配信されるメッセージの最大数を表示します。 |
Is Local Destination | 未サポート項目です。 |
Local Delivery is Preferred | 未サポート項目です。 |
Use Dead Message Queue | デッドメッセージキューを使用するかどうかを表示します。
|
接続サービスのプロパティ情報を表示します。
imqcmd query svcコマンドを使用して参照する方法について説明します。
以下に、表示例と表示するサービスの情報を示します。
表示例
imqcmd query svc -n admin Querying the service where: ---------------------------- Service Name (※1) --------------------------- admin On the broker specified by: ------------------------------------------ Host Primary Port ------------------------------------------ localhost 7676 Service Name (※2) admin Service State RUNNING Port Number 49914 (dynamic) Current Number of Allocated Threads 2 Current Number of Connections 1 Min Number of Threads 4 Max Number of Threads 10 |
表示するサービスの情報
表示する項目 | 内容 |
---|---|
Service Name (※1) | コマンド実行時に指定されたサービス名を表示します。
|
Host | メッセージブローカの起動しているホスト名を表示します。 |
Primary Port | メッセージブローカの起動しているポート番号を表示します。 |
Service Name (※2) | サービス名を表示します。
|
Service State | サービスの状態を表示します。
|
Port Number | サービスが実際に使用するポート番号を表示します。
|
Current Number of Allocated Threads | 現在使用されているスレッド数を表示します。 |
Current Number of Connections | 現在接続されているコネクション数を表示します。 |
Min Number of Threads | 初期起動時に作成されるスレッド数を表示します。 |
Max Number of Threads | 作成可能な最大スレッド数を表示します。 |
メッセージブローカでのコネクションの新規受け入れを停止します。
admin接続サービス用のコネクション新規受け入れは停止できません。
注意
メッセージブローカでのコネクション新規受け入れがすでに停止状態の場合もコマンドは正常復帰します。
メッセージブローカを再起動します。
メッセージブローカのすべてのサービスを再開します。メッセージブローカを再開すると、メッセージブローカはポートでの待機を再開します。
注意
メッセージブローカのすべてのサービスが一時停止状態ではない場合もコマンドは正常復帰します。
1つまたはすべての物理格納先を再開します。
再開する物理格納先を指定しない場合、すべての物理格納先が再開されます。
注意
指定された物理格納先が一時停止状態ではない場合もコマンドは正常復帰します。
1つのサービスを再開します。admin接続サービスは再開できません。
注意
指定されたサービスが一時停止状態ではない場合もコマンドは正常復帰します。
メッセージブローカを停止します。
メッセージブローカでのコネクションの新規受け入れを開始します。
注意
メッセージブローカでのコネクション新規受け入れがすでに開始状態の場合もコマンドは正常復帰します。
メッセージブローカの属性を更新します。メッセージブローカのプロパティ詳細については、「9.7 メッセージブローカのオプションプロパティ」を参照してください。
本コマンドを使用して更新したサービスの属性は、メッセージブローカを再起動した場合でも引き続き適用されます。
物理格納先の属性を更新します。物理格納先のプロパティ詳細については、「9.7.7 物理格納先の生成または更新に関するプロパティ」を参照してください。
本コマンドを使用して更新したサービスの属性は、メッセージブローカを再起動した場合でも引き続き適用されます。
サービスの属性を更新します。接続サービスのプロパティ詳細については、「9.7.1 接続サービスに関するプロパティ」を参照してください。
本コマンドを使用して更新したサービスの属性は、メッセージブローカを再起動した場合でも引き続き適用されます。
戻り値
0: 正常終了
0以外: 異常終了
注意事項
コマンド実行時にメッセージブローカに接続可能なユーザ情報を指定する必要があります。指定するユーザはadminグループに所属している必要があります。
本コマンドは管理者権限を持つユーザで実行してください。
使用例
メッセージブローカに物理格納先を作成する場合、以下のように実行します。
問い合わせにしたがって、メッセージブローカに接続可能なadminグループに所属するユーザ名とパスワードを入力します。
>imqcmd -b localhost:37676 create dst -t q -n test Destination Name test Destination Type Queue On the broker specified by: ------------------------- Host Primary Port ------------------------- localhost 37676 Successfully created the destination. |
注1) 指定したユーザ名に対応するパスワードを入力します。表示されません。
メッセージブローカを停止する場合、以下のように実行します。
問い合わせにしたがって、メッセージブローカに接続可能なadminグループに所属するユーザ名とパスワードを入力します。
メッセージブローカを停止してもよいか確認が行われます。メッセージブローカを停止してもよい場合は「y」を入力します。
>imqcmd -b localhost:37676 shutdown bkr ------------------------- Host Primary Port ------------------------- localhost 37676 Are you sure you want to shutdown this broker? (y/n)[n] y Waiting for broker at localhost:37676 to shutdown... Successfully shutdown the broker. |
注1) 指定したユーザ名に対応するパスワードを入力します。表示されません。