fteListAgents(調整キューマネージャの 'MFTエージェントをリストアップ)

fteListAgents コマンドを使用して、特定の調整キュー・マネージャーに登録されているすべての Managed File Transfer エージェントをリストします。

目的

fteListAgents コマンドは、調整キュー・マネージャーに接続できる任意のシステムから実行できます。 標準出力装置 (STDOUT) に、各エージェントの以下の詳細が送信されます。
  • エージェント名
  • エージェント・ キュー・マネージャー
  • エージェントがプロトコル・ブリッジ・エージェントの場合、エージェント名には以下が付加されます。( bridge )
  • エージェントが Connect:Direct® ブリッジ・エージェントの場合、エージェント名には以下が付加されます。(Connect:Direct bridge)
  • エージェント状況

このコマンドは、coordination.properties ファイルを使用して、調整キュー・マネージャーに接続します。 詳しくは、 MFT coordination.properties ファイルを参照してください。

デフォルト・セットとは異なる構成オプションのセットを使用する場合にのみ、このコマンドにオプションの-pパラメーターを指定してください。 詳しくは、 構成オプションを参照してください。

エージェントが fteListAgents コマンドによってリストされない場合は、以下のトピックの診断フローチャートを使用して、問題を見つけて修正してください。 MFT エージェントが fteListAgents コマンドによってリストされない場合の対処方法

エージェントの状況情報

このコマンドで生成されるエージェント状況情報は、エージェントが SYSTEM.FTE トピックにパブリッシュする状況メッセージから生成されます。 これらのメッセージについては、トピック「 MFT エージェント状況メッセージ・フォーマット」で説明されています。 fteListAgents コマンドで生成される状況情報を調べれば、最後の状況メッセージがパブリッシュされた時点でのエージェントの状況を確認できます。

これらの状況メッセージの頻度は、agentStatusPublishRateLimitプロパティーの値によって異なります。 このプロパティーの詳細については、 MFT agent.properties ファイルのトピックを参照してください。

Status Ageが括弧で囲まれている場合、これは値が負であることを示します。 この状態は、エージェントが実行されているマシンのシステム時刻が、調整キュー・マネージャーのマシンのシステム時刻より進んでいる場合に発生します。

Syntax

fteListAgents

Read syntax diagramSkip visual syntax diagram fteListAgents -pconfiguration_options-mquseriduser_id-mqpasswordpassword-t-vpattern

パラメーター

-p configuration_options
オプション。 このパラメーターは、エージェントをリストする要求を発行するために使用される構成オプションのセットを決定します。 このパラメーターの入力には、デフォルト調整キュー・マネージャー以外の名前を使用します。 これで、コマンドは、デフォルト以外の調整キュー・マネージャーと関連付けられたプロパティー・ファイルのセットを使用します。
このパラメーターを指定しない場合、デフォルトの調整キュー・マネージャーに基づいた構成オプションのセットが使用されます。
-mquserid ユーザー ID
オプション。 調整キュー・マネージャーで認証するユーザー ID を指定します。
-mqpassword パスワード
オプション。 調整キュー・マネージャーで認証するパスワードを指定します。 -mquseridパラメーターも指定する必要があります。 -mquseridを指定し、-mqpasswordを指定しない場合は、関連付けられたパスワードの入力を求めるプロンプトが出されます。 パスワードは表示されません。
-v
オプション。 冗長モードを指定します。 詳細モードでは、各エージェントの現在の管理対象転送の数を示す追加出力が次の形式で生成されます。Source/Destinationここで、
  • Sourceエージェントのソース転送とキューに入れられた転送の現在の数です。
  • Destination宛先転送の現在の数です。
現在の転送情報は、 MFTエージェントステータスメッセージフォーマットのトピックで説明されているエージェントステータス公開から取得される。 その結果、この転送情報は、agentStatusPublishRateLimitエージェント・プロパティ値(デフォルトは 30 秒)の設定の範囲内でのみ正確である。
-t
オプション。 簡潔モードを指定します。 IBM® MQ 9.1以降、出力にはデフォルトでStatus Age列が含まれます。 Status Age情報を表示しない場合は、-tパラメーターを指定してコマンドを発行し、列を非表示にすることができます。 詳しくは、 エージェントが UNKNOWN 状態として表示された場合の対処法を参照してください。
パターン (Pattern)
オプション。 Managed File Transfer エージェントのリストをフィルタリングするために使用するパターン。 このパターンはエージェント名に対して突き合わせられます。 アスタリスク (*) 文字はワイルドカードとして解釈されます。 これは、ゼロ文字を含むあらゆる値と一致します。
[AIX][Linux] AIX® and Linux® システム上で、アスタリスク(*)や数字記号(#)のような特殊文字をリテラルとして扱いたい場合は、引用符(' ')または二重引用符(" " )でエスケープする必要がある。 これらの文字をエスケープしないと、特定の AIX または Linux システムでの意味に従って解釈されます。

このパラメーターを指定しない場合、調整キュー・マネージャーに登録されているすべてのエージェントがリストされます。

- ? または -h
オプション。 コマンド構文を表示します。

この例では、構成オプションで詳細が指定されているキュー・マネージャーに登録されているすべてのエージェントのうち、名前が B で始まるものがリストされます。
fteListAgents "B*" 
この例では、調整キュー・マネージャー QM_EUROPE (デフォルト以外の調整キュー・マネージャー) に登録されているエージェントのリストを冗長モードで表示します。
fteListAgents -p QM_EUROPE -v
このコマンドの出力は次のようになります。
Agent Name:      Queue Manager Name:     Transfers:               Status:
                                         (Source/Destination)
BERLIN           QM_BERLIN               7/0                      RUNNING
LONDON           QM_LONDON               0/0                      RUNNING
MADRID           QM_MADRID               0/1                      UNREACHABLE
可能なエージェント ステータス値とその意味については、「 MFT エージェント ステータス値 」のトピックを参照してください。
この例では、調整キュー・マネージャーに登録されているエージェントで、かつ、名前が BRIDGE で始まるすべてのエージェントが冗長モードでリストされます。
fteListAgents -v  "BRIDGE*"
このコマンドの出力は次のようになります。
C:\Program Files\IBM\WMQFTE\bin>fteListAgents -v
5724-H72 Copyright IBM Corp. 2008, 2025.  ALL RIGHTS RESERVED
Agent Name:                            Queue Manager Name:     Transfers:    Status:
                                                               (Source/Destination)
BRIDGE_FTP ( bridge )                  QM_JUPITER              0/0           STOPPED
BRIDGE_CD1 (Connect:Direct bridge)     QM_JUPITER              0/0           STOPPED
[MQ 9.2.0 Jul 2020] IBM MQ 9.1.4 から、コマンドの出力は、そのエージェントが高可用性である場合、エージェント名で と表示されます。 HA 設定する必要があります highlyAvailable=エージェントを高可用性モードで起動するには、 agent.properties ファイルで true を設定します。 実行中のスタンバイ・インスタンスがない場合でも、HA が表示されることに注意してください。
5724-H72 Copyright IBM Corp. 2008, 2025.  ALL RIGHTS RESERVED
Command executed at 2019-05-15 13:21:08 IDT
Coordination queue manager time 2019-05-15 07:51:08 UTC
Agent Name:            Queue Manager Name:     Status:     Status Age:
IMQFT02 ( bridge )(HA) MFTQM                   STOPPED         8:51:17
SRC (HA)               MFTQM                   READY           0:04:50
DEST                   MFTQM                   READY           0:05:50

戻りコード

0
コマンドは正常に完了しました。
1
コマンドは失敗しました。