runmqras (IBM MQ 診断情報の収集)

目的

runmqras コマンドは、マシンからの診断情報を 1 つのアーカイブに収集するために使われます。 このコマンドを使用して、アプリケーションまたは IBM MQ の障害に関する情報を収集することができます。これは、問題を報告するときに IBM に実行依頼するためのものである可能性があります。

runmqras コマンドを実行するには、 Java 7以降の Java runtime environment (JRE) が必要です。 IBM MQ JRE コンポーネント ( Linux®の場合) またはフィーチャー ( Windowsの場合) がインストールされていない場合、 runmqras はシステム・パスで代替 JRE を検索し、それを使用しようとします。

一般的な問題診断の開始点として、追加のセクションを要求せずに実行することが可能です。ただし、コマンド行で追加の sections を要求することもできます。

このような追加の sections は、診断対象の問題の種類に応じて、より詳細な情報を収集します。 IBM サポート担当員がデフォルト以外のセクションを必要とする場合は、そのことをお知らせします。

runmqras コマンドは、デフォルトで環境変数情報を取得します。 これは、 Linux および AIX®に適用されます。

runmqras コマンドは、デフォルトでキュー・マネージャーのデータ・ディレクトリーのリストを取得します。 これは、Multiplatforms に適用されます。 データ・ディレクトリーの下の userdata ディレクトリーは除外されます。

キーワードおよびパラメーター

オプションであると記述されていない限り、パラメーターはすべて必須です。

あらゆる場合において、QMgrName は、このコマンドを適用するキュー・マネージャーの名前です。

-inputfile InputFile名

XML 入力ファイルの完全修飾名

-custominputfile CustomInputFileName

追加の XML 入力ファイルの完全修飾名

-zipfile ZipFile名前

結果として生成されるアーカイブのファイル名を指定します。

runmqras は、アーカイブ・ファイルの名前にホスト名を付加します。 例えば、次のコマンドを実行したとします。

runmqras -zipFile diagnostics.zip

結果のアーカイブ・ファイルは、diagnostics-hostname.zip という名前になります。

デフォルトでは、アーカイブ・ファイルの名前は runmqras-hostname.zip です。ここで、hostname は、runmqras がファイル名に付加するホスト名です。

-outputdir パス

結果として生成される出力ファイルが置かれるディレクトリー。

デフォルトでは、出力ディレクトリーは作業ディレクトリーと同じです。

-workdirectory パス

ツールの処理中に実行されるコマンドからの出力を保管するために使用されるディレクトリー。 これを指定する場合、そのディレクトリーがまだ存在しないか、または空である必要があります (前者の場合にはそれが作成されます)。

パスを指定しない場合、名前の先頭が runmqras で、接尾部に日時が付いているディレクトリーが使用されます。

• AIX and Linuxの場合、このディレクトリーは /tmpの下にあります。
• Windowsの場合、このディレクトリーは %temp%の下にあります。

-section SectionA,SectionB

より具体的な情報を収集する対象を示すセクション (オプション)。 セクション間の区切り文字として、スペースを入れずにコンマを使用する必要があります。 以下に例を示します。

runmqras -qmlist ESBSTGAPPQMVH2 -section defs,trace,cluster -caseno TEST123

デフォルトでは、ドキュメンテーションの一般的なセクションを収集しますが、特定の問題タイプに関するより具体的な情報を収集することもできます。例えば trace というセクション名を指定すると、トレース・ディレクトリーのすべての内容を収集できます。

デフォルトのコレクションを収集しないようにするには、セクション名として nodefault を指定します。

IBM サポートは通常、使用するセクションを提供します。 使用可能なセクションの例は、次のとおりです。

すべて

可能な限りすべての情報を収集します。その中には、すべてのトレース・ファイルと、さまざまなタイプの問題に関する診断情報が含まれます。 このオプションは特定の状況でのみ使用してください。このオプションは一般用途向けではありません。

default

IBM MQ ログ、FDC ファイル、基本構成、および状況。

注: セクション名 nodefaultを使用しない限り、常に収集されます。 現在の環境 ( Linux上の env.stdout 、 AIX と IBM i、および Windows上の set.stdout に保存されている) および現在のユーザー制限 ( Linux と AIX上の mqconfig.stdout に保存されている) に関する一部の情報は、 runmqras コマンドによって変更される可能性があります。 必要に応じて、ご使用の環境で env、 set、または mqconfig コマンドを手動で実行して、実際の値を確認します。

IBM MQ Applianceでは、 mqtrace: ファイル・システムに存在するキュー・マネージャー・トレース・ファイル以外のファイルは、 default セクションに取り込まれるようになりました。

注: mqtrace: ファイル・システムに存在するキュー・マネージャー・トレース・ファイルを取得する必要がある場合は、引き続き trace セクションを指定する必要があります。

nodefault

デフォルトの収集が行われなくなりますが、明示的に要求した他のセクションは収集されます。

トレース

すべてのトレース・ファイルの情報と、デフォルトの情報を収集します。

注: トレースを有効にしません。

defs

キュー・マネージャー定義と状況情報を収集します。

クラスター

クラスター構成とキュー情報を収集します。

dap

トランザクションと持続性についての情報を収集します。

kernel

キュー・マネージャーのカーネル情報を収集します。

logger

リカバリー・ロギング情報を収集します。

トピック

トピック・ツリー情報を収集します。

QMGR

すべてのキュー・マネージャー・ファイル (キュー、ログ、および構成ファイル) を収集します。

リーク

IBM MQ プロセス・リソース使用情報を収集します。

このセクションは、 Linux、および AIXに適用されます。

mft

fteRas コマンドによって取得したデータを収集します。

注: -section mft は、デフォルトの調整キュー・マネージャー・トポロジーの情報のみを収集します。

mqweb

mqweb サーバーのトレースおよび構成データを収集します。

詳しくは、 IBM MQ runmqras コマンドを使用したデータの収集に関する IBM 技術情報の「 Choosing sections to gather」を参照してください。

-qmlist QMA[,QMB]

runmqras コマンドの実行対象となるキュー・マネージャーの名前リスト。

このパラメーターは、クライアント製品には適用されません。直接出力の要求元となるキュー・マネージャーが存在しないためです。

コンマ区切りリストを指定することで、各キュー・マネージャーに対する反復実行を、リスト上の特定のキュー・マネージャーに限定することができます。 デフォルトでは、すべてのキュー・マネージャーに対してコマンドが反復実行されます。

-noqmdata

IBM MQ 9.2.0 Fix Pack 3およびIBM MQ 9.2.4からのContinuous Deliveryの場合以降のLong Term Supportの場合、-noqmdataを設定すると、インストール・レベルの診断のみがキャプチャーされ、キュー・マネージャー固有の診断はスキップされます。

-qmlistパラメーターと-noqmdataパラメーターを一緒に使用することはできません。 両方のパラメーターが指定されている場合、以下のエラーが戻されます。

引数エラー: -noqmdata または -qmlist のどちらか一方のみを指定することができます。

-timeout secs

個々のコマンドに適用されるデフォルトのタイムアウト。この時間が経つと、コマンドは完了の待機を停止します。

デフォルトでは、タイムアウトとして 10 秒が使用されます。 値ゼロは、無制限に待機することを意味します。

-demo

デモンストレーション・モードで実行します。この場合、コマンドは処理されず、ファイルは収集されません。

デモンストレーション・モードで実行することにより、どんなコマンドが処理されることになっていたか、どんなファイルが収集されることになっていたかを正確に確認できます。 出力 .zip ファイルに含まれる console.log ファイルは、コマンドが通常の方法で実行された場合に何が処理/収集されることになっていたかを正確に示します。

-v

出力 .zip ファイルに含められる console.log ファイルに記録する情報の量を拡張します。

-ftp ibm|カスタム

収集されるアーカイブを、基本的な FTP を介してリモート宛先に送信できるようにします。

処理の終了時に、結果のアーカイブは基本 FTP を介して IBMに直接送信することも、任意のサイトに送信することもできます。

ibm オプションを選択すると、 IBM ECuRep サーバーにアーカイブを配信するために匿名 FTP が使用されます。 このプロセスは、FTP を使って手動でファイルを提出する場合と同じです。

なお、ibm オプションを選択する場合には、pmrno オプションも指定する必要があり、他のすべての FTP* オプションは無視されます。

重要: Long Term Support from IBM MQ 9.2.0 Fix Pack 3 および Continuous Delivery from IBM MQ 9.2.4の場合、 -ftp IBM オプションは使用できなくなりました。 このオプションを選択すると、次のメッセージが生成されます。

The FTP IBM option will no longer work as the IBM FTP servers have been disabled

-ftpserver サーバー

FTP カスタム・オプションを使用する場合の接続先となる FTP サーバー名。

-ftpusernameuserid

FTP カスタム・オプションを使用する場合に FTP サーバーにログインするためのユーザー ID。

-ftppasswordpassword

FTP カスタム・オプションを使用する場合に FTP サーバーにログインするためのパスワード。

-ftpdirectorypath

結果として生成される .zip ファイルの格納場所となる FTP サーバー上のディレクトリー (FTP カスタム・オプションを使用する場合にこれが使用されます)。

-pmrno12345,678,9AB

文書を関連付ける対象の有効な IBM PMR 番号 (問題レコード番号)。

このオプションを使用して、出力の接頭部として PMR 番号を付けてください。これにより、IBM に情報を送ると、その問題記録が情報に自動的に関連付けられます。

注: Salesforce ケース番号を指定する場合は、 -pmrno パラメーターではなく、 -caseno パラメーターを使用してください。

-casenoパラメーターと-pmrnoパラメーターの両方を一緒に指定することは許可されていません。

-caseno caseNo

有効な Salesforce ケース番号。

このオプションを使用して、出力の接頭部として PMR 番号を付けてください。これにより、IBM に情報を送ると、その問題記録が情報に自動的に関連付けられます。

注: PMR 番号を指定する場合は、 -caseno パラメーターではなく、 -pmrno パラメーターを使用してください。

-casenoパラメーターと-pmrnoパラメーターの両方を一緒に指定することは許可されていません。

-application アプリケーション

有効なアプリケーションについての情報を収集します。

-help

簡単なヘルプを表示します。

-sub

xml で置換されるキーワードを示します。

戻りコード

ゼロ以外の戻りコードは、失敗を示します。