3. JMS

3.1. jmqcmd

名称
jmqcmd - コマンドユーティリティ
形式
jmqcmd <subcommand> <argument> [ <options> ]
jmqcmd -h
jmqcmd -H
jmqcmd -v
説明
JMS サーバの起動後に、物理的な送信先の管理や、 JMS サーバと JMS サーバのコネクションサービスの管理、 および JMS サーバのリソースの管理を行います。

管理対象は、次の通りです。() 内は、各サブコマンドの引数 (argument) になります。
各サブコマンドについては、該当する説明のページを参照してください。
サブコマンドと引数

オプション
-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-c <clientID>
クライアント ID を指定します。

-d <destinationName>
トピック名を指定します。永続サブスクリプションをリストする場合にのみ使用します。

-f
ユーザの確認なしにアクションを実行します。

-h, -help
使用法のヘルプを表示します。コマンド行ではそれ以外のことは実行されません。

-H, -Help
使用法のヘルプ、属性リスト、および例を表示します。コマンド行ではそれ以外のことは実行されません。

-int <interval>
メトリックを表示する間隔を秒単位で指定します。デフォルトは、5秒です。

-javahome <javahome>
使用する JRE を指定します。 デフォルトではインストール時に指定されたランタイムを使用します。

-m <metricType>
表示するメトリック情報のタイプを指定します。
JMS サーバ/サービスに有効な値 = {cxn, rts, ttl}
送信先に有効な値 = {con, dsk, rts, ttl}
con = 送信先のコンシューマ情報
cxn = コネクション/VM ヒープ/スレッド
dsk = 送信先のディスク使用状況
rts = 率
ttl = 合計 (デフォルト)

-msp <numSamples>
表示するメトリックサンプルの数を指定します。デフォルト値は -1 (無制限) です。

-n <argumentName>
引数の名前を指定します。
これはサブコマンドに応じて、物理的な送信先、永続サブスクリプション、コネクション ID、 またはトランザクション ID の名前になります。

-o <attribute>=<value>
引数のプロパティを指定します。
これはサブコマンドの引数に応じて、 JMS サーバの属性、サービスの属性、または送信先の属性になります。

-p <password>
管理者パスワードを指定します。この値を省略すると、管理者名の入力を要求されます。

-pst <pauseType>
送信先の一時停止タイプを指定します。
有効な値 = {PRODUCERS, CONSUMERS, ALL}
PRODUCERS = プロデューサからのメッセージを一時停止
CONSUMERS = コンシューマへのメッセージを一時停止
ALL = 両方を一時停止 (デフォルト)

-rtm <timeout>
jmqcmd のサブコマンドの初期 (再試行) タイムアウト期間を秒単位で指定します。
タイムアウトとは、jmqcmd のサブコマンドが JMS サーバへの要求を作成した後、 待機している時間の長さのことです。
それ以降、サブコマンドが再試行されるたびに、タイムアウト値として初期タイムアウト値の 倍数が使用されます。
デフォルト値は10秒です。

-rtr
jmqcmd のサブコマンドが最初にタイムアウトになった後の再試行回数を指定します。
デフォルト値は5回です。

-s
サイレントモード。出力は表示されません。

-secure
JMS サーバ上の SSL/TLS ベースの管理サービス (ssladmin) を使用します (先に ssladmin サービスを有効にしておく必要があります)。

-svn <serviceName>
サービス名を指定します。コネクションのリスト時にのみ有効です。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-tmp
一時的な送信先も表示します。

-u <userName>
管理者のユーザ名を指定します。この値を省略すると、管理者名の入力を要求されます。

-v, -version
バージョン情報を表示します。コマンド行ではそれ以外のことは実行されません。
使用例
例1: localhost のポート 9700 で実行している JMS サーバのプロパティを一覧表示する場合
> jmqcmd query bkr -u admin -p adminadmin

例2: myserver のポート 1564 で、ユーザ名が alladin、ユーザパスワードが abracadabra で実行しているJMS サーバのプロパティを一覧表示する場合
> jmqcmd query bkr -b myserver:1564 -u alladin -p abracadabra
注意事項

jmqcmd コマンドを使用して JMS サーバを管理する場合、次の点に注意してください。



3.1.1. commit txn

名称
jmqcmd commit txn - トランザクションのコミット
形式
jmqcmd commit txn -n <transaction_id>
説明
分散トランザクションをコミットします。
コミットできるのは、PREPARED 状態になっているトランザクションだけです。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <transaction_id>
トランザクション ID を指定します。
使用例
例1: デフォルトの JMS サーバ (localhost:9700) 上のトランザクションをコミットする。
> jmqcmd commit txn -n 64248349708800


関連事項
jmqcmd list txn : トランザクションのリスト
jmqcmd rollback txn : トランザクションのロールバック

3.1.2. compact dst

名称
jmqcmd compact dst - 送信先の圧縮
形式
jmqcmd compact dst [ -t <destType> -n <destName> ]
説明
ひとつ、またはすべての送信先を圧縮します。
送信先のタイプと名前が指定されていない場合は、すべての送信先が圧縮されます。

永続ストアとして、ファイルストアを使用している場合のみ、必要に応じてディスクを圧縮できます。
なお、ディスク利用率の監視については、 jmqcmd metrics dstを参照してください。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。
使用例
例1: キューのディスクを圧縮する
> jmqcmd compact dst -t q -n MyQueue -u admin -p adminadmin
Compacting the destination where:

------------------------------------
Destination Name    Destination Type
------------------------------------
MyQueue             Queue

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to compact this destination? (y/n)[n] y

Successfully compacted the destination.
関連事項
jmqcmd pause dst : 送信先の停止
jmqcmd resume dst : 送信先の再開
注意事項
圧縮する前に、あらかじめ送信先を停止しておく必要があります。
送信先の停止については、 jmqcmd pause dstを参照してください。

3.1.3. destroy dur

名称
jmqcmd destroy dur - 永続サブスクリプションの削除
形式
jmqcmd destroy dur -n <subscrName> -c <client_id>
説明
永続サブスクリプションを削除します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <subscrName>
永続サブスクリプションの名前を指定します。

-c <clientID>
クライアント識別子を指定します。
使用例
例1: 永続サブスクリプションを削除する
> jmqcmd destroy dur -n myDurable -c myClientID -u admin -p adminadmin
Destroying the durable subscription where:

-------------------------------
Durable Sub. Name    Client ID
-------------------------------
myDurable            myClientID

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to destroy this durable subscription? (y/n)[n] y

Successfully destroyed the durable subscription.

list dur サブコマンドから返される情報を使用して、破棄する必要がある 永続サブスクリプションを識別することができます。
サブスクリプションを識別するには、サブスクリプションの名前とクライアント ID を使用します。
関連事項
jmqcmd list dur : 永続サブスクリプションのリスト
jmqcmd purge dur : 永続サブスクリプションのメッセージのパージ

3.1.4. list cxn

名称
jmqcmd list cxn - コネクションのリスト
形式
jmqcmd list cxn [ -svn <serviceName> ] [ -b <hostName:port> ]
説明
指定したサービス名のすべてのコネクションを一覧表示します。
サービス名を指定しない場合は、すべてのサービスのコネクションが一覧表示されます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-svn <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

使用例
例1: jms サービスのコネクションを表示する
> jmqcmd list cxn -svn jms -u admin -p adminadmin
Listing all the connections on the service where:

------------
Service Name
------------
jms

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

-----------------------------------------------------------------------
Connection ID        User   Service  Producers  Consumers  Host
-----------------------------------------------------------------------
9132317659027325184  guest  jms      0          1          169.254.4.11

Successfully listed connections.
関連事項
jmqcmd query cxn : コネクションの情報照会

3.1.5. list dst

名称
jmqcmd list dst - 送信先のリスト
形式
jmqcmd list dst [ -t <destType> ] [ -tmp ]
説明
JMS サーバの送信先をリストします。

送信先の現在の属性値、送信先に関連付けられているプロデューサ またはコンシューマの数、送信先内のメッセージの数とサイズなどの メッセージングメトリックスに関する情報を取得できます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-tmp
一時的な送信先も表示します。

使用例
例1: JMS サーバ上のすべての送信先を表示する
> jmqcmd list dst -u admin -p adminadmin
Listing all the destinations on the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

-----------------------------------------------------------------------------------------------------
   Name     Type    State      Producers        Consumers                      Msgs
                            Total  Wildcard  Total  Wildcard  Count  Remote  UnAck  InDelay  Avg Size
-----------------------------------------------------------------------------------------------------
MyQueue     Queue  PAUSED   0      -         0      -         0      0       0      0        0.0
MyTopic     Topic  RUNNING  0      0         2      0         10     0       0      0        132.0

Successfully listed destinations.

例2: 一時送信先を含めたキューを表示する
> jmqcmd list dst -t q -tmp -u admin -p adminadmin
Listing all the queue destinations on the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

--------------------------------------------------------------------------------------------------------------------------------------------------
                       Name                               Type          State   Producers    Consumers                      Msgs
                                                                                           Active  Backup  Count  Remote  UnAck  InDelay  Avg Size
--------------------------------------------------------------------------------------------------------------------------------------------------
MyQueue                                             Queue              PAUSED   0          0       0       0      0       0      0        0.0
temporary_destination://queue/169.254.4.11/51116/1  Queue (temporary)  RUNNING  0          1       0       0      0       0      0        0.0
temporary_destination://queue/169.254.4.11/51376/1  Queue (temporary)  RUNNING  0          1       0       0      0       0      0        0.0

Successfully listed destinations.
関連事項
jmqcmd query dst : 送信先情報の表示

3.1.6. list dur

名称
jmqcmd list dur - 永続サブスクリプションのリスト
形式
jmqcmd list dur -d <destinationName>
説明
トピックの永続サブスクリプションをリストします。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-d <destinationName>
トピック名を指定します。
使用例
例1: トピック MyTopic の永続サブスクリプションを一覧表示する
> jmqcmd list dur -d MyTopic
Username: admin
Password:
Listing all subscriptions on the topic 'MyTopic'
on the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

-----------------------------------------------------------------------
Subscription Name   Client ID   Durable   Messages   Subscription State
-----------------------------------------------------------------------
subscription        client1     true      10         INACTIVE
subscription        client2     true      0          ACTIVE

Successfully listed subscriptions.

トピックの永続サブスクリプションごとに、永続サブスクリプションの名前、 ユーザのクライアント ID、このトピックのキューに入っているメッセージの数、 および永続サブスクリプションの状態 (アクティブまたは非アクティブ) を返します。

関連事項
jmqcmd destroy dur : 永続サブスクリプションの削除
jmqcmd purge dur : 永続サブスクリプションのメッセージのパージ

3.1.7. list svc

名称
jmqcmd list svc - サービスのリスト
形式
jmqcmd list svc [ -b <hostName:port> ]
説明
JMS サーバのサービスをリストします。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

使用例
例1: JMS サーバの使用可能なコネクションサービスを一覧表示する
> jmqcmd list svc -u admin -p adminadmin
Listing all the services on the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

----------------------------------------------
Service Name    Port Number      Service State
----------------------------------------------
admin           9702 (static)    RUNNING
httpjms         -                UNKNOWN
httpsjms        -                UNKNOWN
jms             9701 (static)    RUNNING
jmsdirect       -                RUNNING
mqdirect2       -                RUNNING
ssladmin        9704 (static)    UNKNOWN
ssljms          9703 (static)    UNKNOWN
wsjms           7670 (static)    UNKNOWN
wssjms          7671 (static)    UNKNOWN

Successfully listed services.
関連事項
jmqcmd query svc : サービスの情報照会

3.1.8. list txn

名称
jmqcmd list txn - トランザクションのリスト
形式
jmqcmd list txn
説明
JMS サーバのトランザクションを一覧表示します。
トランザクションごとに、トランザクション ID、状態、ユーザ名、メッセージまたは通知の数、および作成時間を返します。
使用例
例1: JMS サーバのすべてのトランザクションを一覧表示する
> jmqcmd list txn -u admin -p adminadmin
Listing all the transactions on the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Transactions that are owned by this broker
-------------------------------------------------------------------------------
Transaction ID        State     User name   # Msgs/# Acks   Creation time
-------------------------------------------------------------------------------
9132317662286262785   STARTED   guest       0/1             2022/08/10 19:46:08

   Transactions that involve remote brokers
   --------------------------------------------------
   Transaction ID   State   User name   Creation time
   --------------------------------------------------

Transactions that are owned by a remote broker
-----------------------------------------------
Transaction ID   State   # Acks   Remote broker
-----------------------------------------------

Successfully listed transactions.
トランザクションごとに、list サブコマンドは、トランザクション ID、状態、ユーザ名、メッセージまたは通知の数、および作成時間を返します。
関連事項
jmqcmd query txn : トランザクションの情報照会
jmqcmd commit txn : トランザクションのコミット
jmqcmd rollback txn : トランザクションのロールバック

3.1.9. metrics bkr

名称
jmqcmd metrics bkr - JMS サーバのメトリックス表示
形式
jmqcmd metrics bkr [ -b <hostName:port> ] [ -m <metricType> ] [ -int <interval> ] [ -msp <numSamples> ]
説明
デフォルトの JMS サーバ、または指定したホストとポートの JMS サーバに対して、JMS サーバのメトリックスを表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-m <metricType>
表示するメトリック情報のタイプを指定します。指定できるのは、以下の3つです。
ttl
JMS サーバとの間のメッセージと、パケットのフローに関するメトリックスを表示します。 (デフォルトのメトリックスタイプ)
rts
JMS サーバとの間のメッセージと、パケットのフローレートに関するメトリックスを表示します。 (秒単位)
cxn
コネクション、仮想メモリーヒープ、およびスレッドを表示します。

-int <interval>
メトリックを表示する間隔を秒単位で指定します。デフォルトは、5秒です。

-msp <numSamples>
表示するメトリックサンプルの数を指定します。デフォルト値は -1 (無制限) です。
使用例
例1: JMS サーバに入力するメッセージフローと JMS サーバから出力されるメッセージのフローレートを 10 秒間隔で取得する
> jmqcmd metrics bkr -m rts -int 10 -u admin -p adminadmin
Displaying broker metrics where:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

--------------------------------------------------------
 Msgs/sec    Msg Bytes/sec    Pkts/sec    Pkt Bytes/sec
 In   Out     In      Out     In   Out     In      Out
--------------------------------------------------------
 0     0      0        0      0     0      0        0
< 1   < 1     27      62     < 1   < 1     38      72
< 1   < 1     27      63     < 1   < 1     38      72
関連事項
jmqcmd metrics svc : コネクションサービスのメトリックス
jmqcmd metrics dst : 送信先のメトリックス

3.1.10. metrics dst

名称
jmqcmd metrics dst - 送信先のメトリックス表示
形式
jmqcmd metrics dst -t <destType> -n <destName> [ -m <metricType> ] [ -int <interval> ] [ -msp <numSamples> ]
説明
送信先のメトリックスを表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。

-m <metricType>
表示するメトリックス情報のタイプを指定します。指定できるのは、以下の 4 つです。

ttl
送信先との間でやり取りされメモリーに常駐しているメッセージと パケットに関するメトリックスを表示します。
(デフォルトのメトリックスタイプ)
rts
送信先との間のメッセージとパケットのフローレート (秒単位) に関するメトリックスと、 その他のレート情報を表示します。
con
コンシューマ関連のメトリックスを表示します。
dsk
ディスク使用量のメトリックスを表示します。

-int <interval>
メトリックスを表示する間隔を秒単位で指定します。デフォルトは、5秒です。

-msp <numSamples>
表示するメトリックサンプルの数を指定します。デフォルト値は -1 (無制限) です。
使用例
例1: 送信先に関するメッセージメトリックス情報を取得する
> jmqcmd metrics dst -t q -n MyQueue -m ttl -u admin -p adminadmin
Displaying destination metrics where:

------------------------------------
Destination Name    Destination Type
------------------------------------
MyQueue             Queue

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

-----------------------------------------------------------------------------
  Msgs     Msg Bytes        Msg Count         Total Msg Bytes (k)     Largest
In   Out   In     Out   Current  Peak  Avg  Current   Peak     Avg    Msg (k)
-----------------------------------------------------------------------------
120  21   15840  2772     99      99   35     12       12       4       < 1
120  22   15840  2904     98      99   35     12       12       4       < 1
関連事項
jmqcmd metrics bkr : JMS サーバのメトリックス
jmqcmd metrics svc : コネクションサービスのメトリックス

3.1.11. metrics svc

名称
jmqcmd metrics svc - サービスのメトリック表示
形式
jmqcmd metrics svc -n <serviceName> [ -b <hostName:port> ] [ -m <metricType> ] [ -int <interval> ] [ -msp <numSamples> ]
説明
サービスのメトリックスを表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-m <metricType>
表示するメトリック情報のタイプを指定します。指定できるのは、以下の3つです。
ttl
指定したサービスを使って JMS サーバとの間で入出力されているメッセージと、 パケットのフローに関するメトリックスを表示します。 (デフォルトのメトリックスタイプ)
rts
指定したサービスを使って JMS サーバとの間で入出力されているメッセージと、 パケットのフローレートに関するメトリックスを表示します。 (秒単位)
cxn
コネクション、仮想メモリーヒープ、およびスレッドを表示します。

-int <interval>
メトリックを表示する間隔を秒単位で指定します。デフォルトは、5秒です。

-msp <numSamples>
表示するメトリックサンプルの数を指定します。デフォルト値は -1 (無制限) です。
使用例
例1: jms コネクションサービスによって処理されたメッセージとパケットの累計数を取得する
> jmqcmd metrics svc -n jms -m ttl -u admin -p adminadmin
Displaying service metrics where:

------------
Service Name
------------
jms

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

----------------------------------------------
  Msgs     Msg Bytes      Pkts     Pkt Bytes
In   Out   In     Out   In   Out   In     Out
----------------------------------------------
260  30   34320  4320   827  474  85381  72921
360  30   47520  4320   936  584  99734  85035
関連事項
jmqcmd metrics bkr : JMS サーバのメトリックス
jmqcmd metrics dst : 送信先のメトリックス

3.1.12. pause bkr

名称
jmqcmd pause bkr - JMS サーバのサービスの一時停止
形式
jmqcmd pause bkr [ -b <hostName:port> ]
説明
JMS サーバのすべてのサービスを一時停止します。

JMS サーバを停止すると、JMS サーバのコネクションサービス (jms、ssljms) が中断されるため、JMS サーバはコネクションポートでの待機をやめます。
その結果、JMS サーバはそれ以上、新しいコネクションの受け入れ、メッセージの受信、メッセージの配信は行いません。

ただし、JMS サーバを停止しても管理コネクションサービス (admin、ssladmin) は中断されないため、JMS サーバへのメッセージを制限するために必要な管理タスクは実行できます。
たとえば、特定の送信先にメッセージが集中した場合には、 JMS サーバを停止し、問題の修復に役立つ、メッセージの送信元の追跡、送信先のサイズの制限、または送信先の破棄などの操作を行うことができます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost
使用例
例1: JMS サーバを一時停止する
> jmqcmd pause bkr -u admin -p adminadmin
Pausing the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to pause this broker? (y/n)[n] y

Successfully paused the broker.
関連事項
jmqcmd pause svc : 個々のコネクションサービスの停止
jmqcmd resume bkr : JMS サーバのサービスの再開

3.1.13. pause dst

名称
jmqcmd pause dst - 送信先の一時停止
形式
jmqcmd pause dst [ -t <destType> -n <destName> ] [ -pst <pauseType> ]
説明
ひとつ、またはすべての送信先を一時停止します。
送信先のタイプと名前が指定されていない場合は、すべての送信先が一時停止されます。

本サブコマンドで、プロデューサから送信先、送信先からコンシューマ、または その両方のメッセージの配信を制御するために、送信先を停止できます。
特に、メッセージのプロデュースがコンシュームよりかなり高速な場合に、送信先が メッセージによって過負荷にならないように、送信先へのメッセージフローを停止できます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。

-pst <pauseType>
送信先の一時停止タイプを指定します。
有効な値 = {PRODUCERS, CONSUMERS, ALL}
PRODUCERS = プロデューサからのメッセージを一時停止
CONSUMERS = コンシューマへのメッセージを一時停止
ALL = 両方を一時停止 (デフォルト)
使用例
例1: キューの送信先のプロデューサからのメッセージを停止する
> jmqcmd pause dst -n MyQueue -t q -pst PRODUCERS -u admin -p adminadmin
Pausing the destination where:

------------------------------------
Destination Name    Destination Type
------------------------------------
MyQueue             Queue

Using the following attribute:

Pause Type    PRODUCERS

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to pause this destination? (y/n)[n] y

Successfully paused the destination.

例2: トピックの送信先のコンシューマへのメッセージを停止する
> jmqcmd pause dst -n MyTopic -t t -pst CONSUMERS -u admin -p adminadmin
Pausing the destination where:

------------------------------------
Destination Name    Destination Type
------------------------------------
MyTopic             Topic

Using the following attribute:

Pause Type    CONSUMERS

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to pause this destination? (y/n)[n] y

Successfully paused the destination.
関連事項
jmqcmd resume dst : 送信先の再開

3.1.14. pause svc

名称
jmqcmd pause svc - サービスの一時停止
形式
jmqcmd pause svc -n <serviceName> [ -b <hostName:port> ]
説明
1 つのサービスを一時停止します。ただし、admin サービス、ssladmin サービスは停止できません。

サービスを停止すると、次のような結果になります。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost
使用例
例1: デフォルトの JMS サーバの jms コネクションサービスを停止する
> jmqcmd pause svc -n jms -u admin -p adminadmin
Pausing the service where:

------------
Service Name
------------
jms

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to pause this service? (y/n)[n] y

Successfully paused the service.
関連事項
jmqcmd resume svc : サービスの再開

3.1.15. purge dst

名称
jmqcmd purge dst - 送信先のメッセージのパージ
形式
jmqcmd purge dst -t <destType> -n <destName> [ -mid <messageID> ]
説明
送信先を削除しないで、送信先上のメッセージをパージします。

-mid オプションでメッセージ ID を指定すると、該当する 1 件のメッセージをパージします。省略すると、送信先のすべてのメッセージをパージします。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。

-mid <messageID>
メッセージ ID を指定します。1 件のメッセージをパージする場合にのみ使用します。
使用例
例1: キューをパージする
> jmqcmd purge dst -n MyQueue -t q -u admin -p adminadmin
Purging the destination where:

------------------------------------
Destination Name    Destination Type
------------------------------------
MyQueue             Queue

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to purge this destination? (y/n)[n] y

Successfully purged the destination.

例2: トピックをパージする
> jmqcmd purge dst -n MyTopic -t t -u admin -p adminadmin
Purging the destination where:

------------------------------------
Destination Name    Destination Type
------------------------------------
MyTopic             Topic

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to purge this destination? (y/n)[n] y

Successfully purged the destination.

3.1.16. purge dur

名称
jmqcmd purge dur - 永続サブスクリプションのメッセージのパージ
形式
jmqcmd purge dur -n <subscrName> -c <client_id>
説明
永続サブスクリプションを削除しないで、永続サブスクリプションのすべてのメッセージをパージします。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <subscrName>
永続サブスクリプションの名前を指定します。

-c <clientID>
クライアント ID を指定します。
使用例
例1: 永続サブスクリプションをパージする
> jmqcmd purge dur -n myDurable -c myClientID -u admin -p adminadmin
Purging the durable subscription where:

-------------------------------
Durable Sub. Name    Client ID
-------------------------------
myDurable            myClientID

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to purge this durable subscription? (y/n)[n] y

Successfully purged the durable subscription.

list dur サブコマンドから返される情報を使用して、メッセージをパージする必要がある 永続サブスクリプションを識別することができます。
サブスクリプションを識別するには、サブスクリプションの名前とクライアント ID を使用します。
関連事項
jmqcmd list dur : 永続サブスクリプションのリスト
jmqcmd destroy dur : 永続サブスクリプションの削除

3.1.17. query bkr

名称
jmqcmd query bkr - JMS サーバの情報照会
形式
jmqcmd query bkr [ -b <hostName:port> ]
説明
JMS サーバの現在のプロパティ設定を一覧表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost
使用例
例1: JMS サーバの情報を表示する
> jmqcmd query bkr -u admin -p adminadmin
Querying the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Version                                              11.10.0000
Instance Name                                        jmqbroker
Broker ID                                            jmqbroker
Primary Port                                         9700
Broker is Embedded                                   true
Instance Configuration/Data Root Directory           C:\WebOTX\domains\domain1\jmq

Current Number of Messages in System                 10
Current Total Message Bytes in System                1320

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                                   false
Auto Create Topics                                   false
Auto Created Queue Max Number of Active Consumers    unlimited (-1)
Auto Created Queue Max Number of Backup Consumers    0
Auto Created Destination useDMQ                      false

Cluster ID
Cluster is Highly Available                          false
Cluster Broker List (active)                         mq://169.254.4.11:9700/
Cluster Broker List (configured)
Cluster Master Broker
Cluster URL

Log Level
Log Rollover Interval (seconds)                      unlimited (-1)
Log Rollover Size (bytes)

Successfully queried the broker.

3.1.18. query cxn

名称
jmqcmd query cxn - コネクションの情報照会
形式
jmqcmd query cxn -n <connectionID> [ -b <hostName:port> ]
説明
コネクションの情報を照会し、表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <connectionID>
コネクション ID を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost
使用例
例1: 指定したコネクションに関する情報を表示する
> jmqcmd query cxn -n 9132317659027325184 -u admin -p adminadmin
Querying the connection where:

-------------------
Connection ID
-------------------
9132317659027325184

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Connection ID      9132317659027325184
User               guest
Service            jms
Producers          0
Consumers          1
Host               169.254.4.11
Port               51325
Client ID          client2
Client Platform    JMQ/11.10.0000 (JMS; Windows Server 2022 10.0 amd64)

Successfully queried the connection.
関連事項
jmqcmd list cxn : コネクションのリスト

3.1.19. query dst

名称
jmqcmd query dst - 送信先の情報照会
形式
jmqcmd query dst -t <destType> -n <destName>
説明
送信先の情報を照会し表示します。送信先の現在の属性値に関する情報を取得することができます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。

使用例
例1: キューの送信先に関する情報を表示する
> jmqcmd query dst -t q -n MyQueue -u admin -p adminadmin
Querying the destination where:

------------------------------------
Destination Name    Destination Type
------------------------------------
MyQueue             Queue

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Destination Name                      MyQueue
Destination Type                      Queue
Destination State                     PRODUCERS_PAUSED
Created Administratively              true

Current Number of Messages
    Actual                            0
    Remote                            0
    In Delay Delivery                 0
    Held in Transaction               0
Current Message Bytes
    Actual                            0
    Remote                            0
    In Delay Delivery                 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                false
XML schema validation enabled         false
XML schema URI List                   -
Reload XML schema on failure          false

Successfully queried the destination.
関連事項
jmqcmd list dst : 送信先のリスト

3.1.20. query svc

名称
jmqcmd query svc - サービスの情報照会
形式
jmqcmd query svc -n <serviceName> [ -b <hostName:port> ]
説明
サービスの情報を照会し表示します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost
使用例
例1: JMS サーバ上の jms サービスの情報を表示する
> jmqcmd query svc -n jms -u admin -p adminadmin
Querying the service where:

------------
Service Name
------------
jms

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Service Name                           jms
Service State                          PAUSED
Port Number                            9701 (static)

Current Number of Allocated Threads    8
Current Number of Connections          1

Min Number of Threads                  10
Max Number of Threads                  1000

Successfully queried the service.
関連事項
jmqcmd update svc : サービスの属性更新

3.1.21. query txn

名称
jmqcmd query txn - トランザクションの情報照会
形式
jmqcmd query txn -n <transaction_id>
説明
トランザクションの情報を照会し表示します。

query サブコマンドを使用すると、list サブコマンドと同じ情報のほかに、 クライアント ID、コネクション識別子、分散トランザクション ID (XID) などの多数の追加された値を確認できます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <transaction_id>
トランザクション ID を指定します。
使用例
例1: デフォルトの JMS サーバ (localhost:9700) 上のトランザクションの情報を表示する
> jmqcmd query txn -n 9132317662338839041 -u admin -p adminadmin
Querying the transaction where:

-------------------
Transaction ID
-------------------
9132317662338839041

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Client ID
Connection ID (created transaction)        9132317662338830848
Connection string (created transaction)    guest@169.254.4.11:51511->jms:9701
Creation time                              2022/08/10 19:49:34
Number of acknowledgements                 1
Number of messages                         0
State                                      STARTED
Transaction ID                             9132317662338839041
User name                                  guest
XID

Successfully queried the transaction.
トランザクション ID は、 list txnサブコマンドなどを利用して取得することができます。
関連事項
jmqcmd list txn : トランザクションのリスト
jmqcmd commit txn : トランザクションのコミット
jmqcmd rollback txn : トランザクションのロールバック

3.1.22. resume bkr

名称
jmqcmd resume bkr - JMS サーバのサービスの再開
形式
jmqcmd resume bkr [ -b <hostName:port> ]
説明
JMS サーバのすべてのサービスを再開します。
JMS サーバを再開すると、 JMS サーバのサービスが再び有効になり、JMS サーバはポートでの待機を再開します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost
使用例
例1: JMS サーバを再開する
> jmqcmd resume bkr -u admin -p adminadmin
Resuming the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to resume this broker? (y/n)[n] y

Successfully resumed the broker.
関連事項
jmqcmd pause bkr : JMS サーバのサービスの一時停止

3.1.23. resume dst

名称
jmqcmd resume dst - 送信先の再開
形式
jmqcmd resume dst [ -t <destType> -n <destName> ]
説明
ひとつ、またはすべての送信先を再開します。
送信先のタイプと名前が指定されていない場合は、すべての送信先が再開されます。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-t <destType>
送信先のタイプを指定します。 有効な値 = {q, t}
q = キュー
t = トピック

-n <destName>
送信先の名前を指定します。
使用例
例1: キューを再開する
> jmqcmd resume dst -t q -n MyQueue -u admin -p adminadmin
Resuming the destination where:

------------------------------------
Destination Name    Destination Type
------------------------------------
MyQueue             Queue

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to resume this destination? (y/n)[n] y

Successfully resumed the destination.
関連事項
jmqcmd pause dst : 送信先の一時停止

3.1.24. resume svc

名称
jmqcmd resume svc - サービスの再開
形式
jmqcmd resume svc -n <serviceName> [ -b <hostName:port> ]
説明
1 つのサービスを再開します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost
使用例
例1: デフォルトの JMS サーバの jms コネクションサービスを再開する
> jmqcmd resume svc -n jms -u admin -p adminadmin
Resuming the service where:

------------
Service Name
------------
jms

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to resume this service? (y/n)[n] y

Successfully resumed the service.
関連事項
jmqcmd pause svc : サービスの停止

3.1.25. rollback txn

名称
jmqcmd rollback txn - トランザクションのロールバック
形式
jmqcmd rollback txn -n <transaction_id>
説明
分散トランザクションをロールバックします。 ロールバックできるのは、PREPARED 状態になっているトランザクションだけです。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <transaction_id>
トランザクション ID を指定します。
使用例
例1: デフォルトの JMS サーバ (localhost:9700) 上のトランザクションをロールバックする
> jmqcmd rollback txn -n 64248349708800


関連事項
jmqcmd list txn : トランザクションのリスト
jmqcmd commit txn : トランザクションのコミット

3.1.26. update svc

名称
jmqcmd update svc - サービスの属性更新
形式
jmqcmd update svc -n <serviceName> [ -b <hostName:port> ] -o <attribute>=<value> [ -o <attribute>=<value> ] ...
説明
サービスの属性を更新します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqcmdオプションを参照してください。

-n <serviceName>
サービス名を指定します。

-b <hostName:port>
JMS サーバのホスト名とポート番号を指定します。デフォルトは、localhost:9700 です。
ポートだけを指定する場合 : -b :7878
ホスト名だけを指定する場合 : -b somehost

-o <attribute>=<value>
サービスのプロパティを指定します。
このコマンドで更新されるサービスのプロパティは、次のとおりです。

サービスのプロパティ
プロパティ 説明
maxThreads サービスに割り当てられるスレッドの最大数
minThreads サービスに割り当てられるスレッドの最小数
port サービスに割り当てられるポート番号。
値 0 は、ポートマッパーによって動的に割り当てられることを示す。
使用例
例1: jms サービスに割り当てられたスレッドの最少数を 20 に設定する
> jmqcmd update svc -n jms -o minThreads=20 -u admin -p adminadmin
Updating the service that has the name:

jms

with the following updated attributes:

minThreads    20

On the broker specified by:

-------------------------
Host         Primary Port
-------------------------
localhost    9700

Are you sure you want to update this service? (y/n)[n] y

Successfully updated the service.
関連事項
jmqcmd query svc : サービスの情報照会

3.2. jmqdbmgr

名称
jmqdbmgr - データベースマネージャ
形式
jmqdbmgr <subcommand> <argument> [ <options> ]
jmqdbmgr -h|-help
jmqdbmgr -v|-version
説明
永続ストアとして JDBC ストアを利用する場合のデータベーススキーマの作成、および、管理を行います。

インストール直後は、ファイルストアを利用する設定になっていますので、JDBC ストアを利用する場合は、あらかじめ設定が必要になります。 設定の詳細については、[ リファレンス > 設定 > JMS > その他の設定項目・設定方法 > JDBCストアを利用するための設定」 を参照してください。
サブコマンドと引数
create tbl
テーブルを作成します。
delete tbl
テーブルを削除します。
recreate tbl
テーブルを削除してから作成します。
オプション
-h, -help
使用法のヘルプを表示します。コマンド行ではそれ以外のことは実行されません。

-otxdomain <domainName>
WebOTX のドメイン名を指定し、対応するプロパティの設定に使用します。このオプションが指定された場合、-url オプションの値は無視します。

-otxdomainroot <domainRoot>
WebOTX のドメインルートディレクトリを指定します。ドメインディレクトリを既定値 (${AS_INSTALL}/domains) から変更している場合には、ドメイン名を含めた絶対パスの指定が必要です。このオプションが指定された場合、-otxdomain オプション、-url オプションの値は無視します。

-t <JDBC store type>
JDBCストアのタイプを指定します。 <JDBC store type> は oracle, postgresql のいずれかです。

-url <JDBC URL>
JDBC URLを指定します。このオプションで接続先を指定する場合は、${AS_INSTALL}/jmq/lib/ext に、対象データベースのJDBCドライバのjarファイルを格納する必要があります。

-p <password>
データベースのパスワードを指定します。

-u <userName>
データベースのユーザ名を指定します。

-v, -version
バージョン情報を表示します。コマンド行ではそれ以外のことは実行されません。

3.2.1. create tbl

名称
jmqdbmgr create tbl - テーブルの作成
形式
jmqdbmgr create tbl [ <options> ]
説明
既存のデータベースシステムに、JMS サーバの永続ストアのスキーマを作成します。
このコマンドは、外部データベースシステムで使用します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqdbmgrオプションを参照してください。

-otxdomain <domainName>
WebOTX のドメイン名を指定し、対応するプロパティの設定に使用します。このオプションが指定された場合、-url オプションの値は無視します。

-t <JDBC store type>
JDBCストアのタイプを指定します。 <JDBC store type> は oracle, postgresql のいずれかです。

-url <JDBC URL>
JDBC URLを指定します。このオプションで接続先を指定する場合は、${AS_INSTALL}/jmq/lib/ext に、対象データベースのJDBCドライバのjarファイルを格納する必要があります。

-p <password>
データベースのパスワードを指定します。

-u <userName>
データベースのユーザ名を指定します。

使用例
例1: domain1 の JMS サービス MO の設定を利用して、データベースを作成する
> jmqdbmgr create tbl -otxdomain domain1
関連事項
jmqdbmgr delete tbl : テーブルの削除
jmqdbmgr recreate tbl : テーブルの再作成

3.2.2. delete tbl

名称
jmqdbmgr delete tbl - テーブルの削除
形式
jmqdbmgr delete tbl [ <options> ]
説明
現在の永続ストアのデータベース内に存在する JMS サーバのデータベーステーブルを削除します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqdbmgrオプションを参照してください。

-otxdomain <domainName>
WebOTX のドメイン名を指定し、対応するプロパティの設定に使用します。このオプションが指定された場合、-url オプションの値は無視します。

-t <JDBC store type>
JDBCストアのタイプを指定します。 <JDBC store type> は oracle, postgresql, sqlserver, other のいずれかです。

-url <JDBC URL>
JDBC URLを指定します。このオプションで接続先を指定する場合は、${AS_INSTALL}/jmq/lib/ext に、対象データベースのJDBCドライバのjarファイルを格納する必要があります。

-p <password>
データベースのパスワードを指定します。

-u <userName>
データベースのユーザ名を指定します。

使用例
例1: domain1 の JMS サービス MO の設定を利用して、データベースを削除する
> jmqdbmgr delete tbl -otxdomain domain1
関連事項
jmqdbmgr create tbl : テーブルの作成
jmqdbmgr recreate tbl : テーブルの再作成

3.2.3. recreate tbl

名称
jmqdbmgr recreate tbl - テーブルの再作成
形式
jmqdbmgr recreate tbl [ <options> ]
説明
現在の永続ストアのデータベース内に存在する JMS サーバのデータベーステーブルを 削除した後、JMS サーバの永続ストアのスキーマを作成し直します。
オプション
* ここでは、本サブコマンドで必要となるオプションのみを説明しています。
  すべてのオプションについては、 jmqdbmgrオプションを参照してください。

-otxdomain <domainName>
WebOTX のドメイン名を指定し、対応するプロパティの設定に使用します。このオプションが指定された場合、-url オプションの値は無視します。

-t <JDBC store type>
JDBCストアのタイプを指定します。 <JDBC store type> は oracle, postgresql のいずれかです。

-url <JDBC URL>
JDBC URLを指定します。このオプションで接続先を指定する場合は、${AS_INSTALL}/jmq/lib/ext に、対象データベースのJDBCドライバのjarファイルを格納する必要があります。

-p <password>
データベースのパスワードを指定します。

-u <userName>
データベースのユーザ名を指定します。

使用例
例1: domain1 の JMS サービス MO の設定を利用して、データベースを再作成する
> jmqdbmgr recreate tbl -otxdomain domain1
関連事項
jmqdbmgr create tbl : テーブルの作成
jmqdbmgr delete tbl : テーブルの削除