fteCreateMonitor(「MFTリソースモニターを作成する)

目的

Managed File Transfer エージェントを使用して新規リソース・モニターを作成して開始するには、 fteCreateMonitor コマンドを使用します。 例えば、次のようにリソース・モニターを使用できます。まず、外部アプリケーションで、既知のディレクトリーに 1 つ以上のファイルを配置します。 そして、処理の完了時に外部アプリケーションによって、モニター対象ディレクトリーにトリガー・ファイルを配置します。 そうすると、トリガー・ファイルが検出されて、定義されたファイルの転送が開始し、既知のディレクトリーのファイルが宛先エージェントにコピーされます。

-oxパラメーターおよび-ixパラメーターを使用して、リソース・モニター構成を XML ファイルにエクスポートおよびインポートできます。 fteCreateMonitor コマンドでこのファイルをインポートすると、fteCreateMonitor コマンドで XML ファイルをエクスポートするときに指定したリソース・モニターと同じパラメーターで新規リソース・モニターが作成されます。 さらに、-f パラメーターと-cパラメーターを使用して、モニター構成を動的に上書きすることができます。

特殊文字

特殊文字が含まれているパラメーター値を使用する場合には、予期しない形で特殊文字がコマンド・シェルで解釈されないように注意してください。 例えば、スペース、引用符 (単一または二重)、円記号 (¥)、またはスラッシュ文字などの文字を含む完全修飾ファイル・パスおよび名前は、コマンド自体に直接渡されるのではなく、コマンド・シェルによって解釈される可能性があります。 コマンド・シェルによって文字が解釈されないようにするには、パラメーター全体を二重または単一引用符で囲むか、コマンド・シェルのエスケープ・シーケンスを使用して特殊文字をエスケープします。 Windowsでファイル・パスを指定する場合、セパレーター文字のバックスラッシュ(∕)は必ずダブル・バックスラッシュ(∕)、つまりエスケープされたバックスラッシュ(∕)で入力してください。 または、フォワード・スラッシュ（/）1文字をセパレーターとして使用することもできます。"

パラメーター

-ix xml_filename

オプション。 リソース・モニター構成を XML ファイルからインポートします。

-ox xml_filename

オプション。 このパラメーターは、-maパラメーターおよび-mnパラメーターと一緒に指定する必要があり、-fパラメーターと一緒に使用できます。 リソース・モニター構成を XML ファイルにエクスポートします。

-mn モニター名

必須。 このモニターに割り当てる名前。 モニター名は、モニター・エージェントに対して固有である必要があります。 ただし、モニターを削除してから、同じ名前のモニターを作成できます。

リソース・モニター名の最大長は 256 文字です。 リソース・モニター名は、大/小文字を区別しません。 小文字または大/小文字混合で入力されたリソース・モニター名は大文字に変換されます。 リソース・モニター名には、 アスタリスク (*)、パーセント (%)、または疑問符 (?) を使用できません。

-ma monitoring_agent_name

必須。 リソース・モニターを実行するエージェントの名前。 このモニター・エージェントは、トリガー対象のモニター・タスクのソース・エージェントである必要があります。

-mm monitoring_agent_qmgr_name

モニター・エージェントの接続先キュー・マネージャーの名前。 モニター・エージェントとソース・エージェントが同一である必要があるため、このキュー・マネージャーはソース・エージェントのキュー・マネージャーでもあります。

注: fteCreateMonitor コマンドは、 Managed File Transfer トポロジーのコマンド・キュー・マネージャーに接続します。 コマンド・キュー・マネージャーがモニター・エージェントのエージェント・キュー・マネージャーでもある場合、このパラメーターはオプションです。 それ以外の場合、このパラメーターは必須です。

-f

オプション。 このパラメーターは、リソース・モニター構成を上書きする場合に使用します。 例えば、選択するリソース・モニター名がリソース・モニター・エージェントに既に存在していて、削除してモニターを同じ名前で再作成するのではなく、それを更新する場合です。 このパラメーターを使用すると、エージェントによってモニター・プロセスが再開されます。

-c

オプション。 このパラメーターにより、更新されるリソース・モニターのヒストリーがクリアされ、リソース・モニターでトリガー条件が再検査されます。 このパラメーターは、-fパラメーターと一緒にのみ使用できます。

-md directory_path

オプション。 モニターするディレクトリー・パスの絶対名。 -ixパラメーターまたは-oxパラメーターを使用する場合を除き、-mdパラメーターまたは-mqパラメーターのいずれかを指定する必要があります。

-mq queue_name

オプション。 モニターするキューの名前。 このキューは、モニター・エージェントのキュー・マネージャーに存在していなければなりません。 -ixパラメーターまたは-oxパラメーターを使用する場合を除き、-mdパラメーターまたは-mqパラメーターのいずれかを指定する必要があります。

-mt task_definition_file_name

必須。 トリガー条件が満たされたときに実行する、タスク定義を含む XML 文書の名前。 詳しくは、 転送定義ファイルの使用を参照してください。 転送定義 XML 文書へのパスは、fteCreateMonitor コマンドの実行元のローカル・ファイル・システムにある必要があります。 ファイルのパスを指定しない場合、コマンドは現行作業ディレクトリーでファイルを探します。 -ixパラメーターまたは-oxパラメーターを使用する場合を除き、-mtは必須パラメーターです。

fteCreateTransfer コマンド で-gtパラメーターを使用して、ファイル転送要求を含むテンプレート XML 文書を生成できます。 モニターは、転送テンプレートをタスク定義として使用します。

fteCreateMonitor コマンドを実行するときに、転送リカバリー・タイムアウトの -rt パラメーターを -gt パラメーターとともに使用することもできます。 停止した転送のリカバリーをソース・エージェントが試行し続ける時間を秒単位で設定できます。 モニターが使用する転送定義とともにリカバリー・タイムアウト・パラメーターが XML 文書に組み込まれます。 このパラメータの設定方法の詳細については、fteCreateTransferコマンドを参照してください。

z/OS®では、 z/OS UNIX System Services上の UNIX ファイルにタスク定義文書を保管する必要があります。 タスク定義文書は、z/OS 順次ファイルおよび PDS メンバーに保管することはできません。

IBM iでは、タスク定義文書を統合ファイル・システムに保管する必要があります。

-rl number_of_recursion_levels

オプション。 モニター対象のルート・ディレクトリーからの、再帰的にモニターする階層。つまり、掘り下げるサブディレクトリーの階層数。 例えば、C:/wmqfte/monitor をモニター対象ルート・ディレクトリーとした場合の、次のようなディレクトリー構造を例として説明します。

C:/wmqfte/monitor
C:/wmqfte/monitor/reports
C:/wmqfte/monitor/reports/2009
C:/wmqfte/monitor/reports/2009/April

-rl 2を指定した場合、Managed File Transferは、C:/wmqfte/monitor/reports/2009ディレクトリーとその兄弟ディレクトリーのみを検索します。 C:/wmqfte/monitor/reports/2009/April ディレクトリーは無視されます。 デフォルトでは、再帰は行われないように設定されています。

-pi interval_period

オプション。 ディレクトリを監視する間隔。 ポーリング間隔は、正整数値でなければなりません。 -piのデフォルト値は 1 です。

-pu units

オプション。 モニター・ポーリング間隔の時間単位。 -pu パラメーターを指定した場合には、-pi パラメーターも指定する必要があります。 -puのデフォルト値は 分です。 以下のいずれかのオプションを指定します。

seconds

minutes

hours

days

-tr

オプション。 定義したタスクが実行されるためにはトリガー条件が満たされなければならないことを指定します。 ソース・エージェントに従って条件が満たされない場合、モニター・タスク (例えば、ファイル転送) は開始されません。 トリガー条件は、2 つのオプションの部分、つまり、条件とパターンで構成されており、コンマで区切ります。 以下のいずれかのフォーマットを指定します。

• condition,pattern
  

  ここで condition は以下のいずれかの値になります。

  match

  条件を満たしたトリガーごとに、定義されているタスクが実行されます。 match はデフォルト値です。

  例えば、match が *.go で、ファイル LONDON.goおよび MANCHESTER.go がある場合、タスクが LONDON.go に対して実行され、別のタスクが MANCHESTER.go に対して実行されます。

  前のポーリングと同じトリガー・ファイルが存在する (つまり、ファイルが変更されていない) 場合、このファイルはトリガー条件を満たしません。 つまり、一致するトリガー・ファイルは、新しいファイルでなければならず、しかも最後のポーリング時と定義済みのタスクの実行時の間に変更されたファイルでなければなりません。

  noMatch

  モニター対象ディレクトリー内のファイルが 1 つもパターンに一致しないかどうか。 つまり、 モニター対象ディレクトリー内のいかなる ファイルも存在しない場合に、この条件は満たされます。 モニター作成時にトリガー条件に一致するファイルがない場合、モニターは即座に開始します。しかし、ファイル・マッチングが検出されてその後除去されるまで再開されません。

  noSizeChange=n

  ディレクトリー内のファイルの中で、パターンに一致して、かつファイル・サイズが n ポーリング間隔の間変化しなかったものが 1 つ以上存在するかどうか。 n の値は正整数です。

  ファイル・サイズ>=サイズ

  ディレクトリー内のファイルの中で、パターンに一致して、かつファイル・サイズが size 以上であるものが 1 ファイル以上存在するかどうか。 size の値は、整数とオプションのサイズ単位 (B、KB、MB、または GB) を組み合わせて指定します。 例: fileSize">"=10KB。 サイズ単位を指定しなければ、バイト単位がデフォルトで使用されます。 すべてのオペレーティング・システムにおいて、この例で示すように、コマンド行で filesize オプションを指定した場合は、より大記号 (>) は二重引用符で囲まなければなりません。

  このパターンは、ワイルドカードまたは Java 正規表現フォーマットのファイル・パターン・マッチング・シーケンスです。 パターンのデフォルト値は *、つまり、任意のファイルとの一致で、デフォルト・フォーマットはワイルドカード・フォーマットです。 -ptを使用して、パターンのフォーマットを指定します。

  例えば、モニター対象のディレクトリーに .go という接尾部のファイルが存在すると、以下のトリガー条件が満たされます。

  -tr match,*.go 

  モニター対象ディレクトリー内に接尾部 .stop を持つファイルがない場合に、次のトリガー条件が満たされます。

  -tr noMatch,*.stop 

  condition,pattern は、-mdパラメーターも指定する場合にのみ指定できます。

• condition
  

  ここで condition は以下のいずれかの値になります。

  queueNotEmpty

  モニターされるキューは空ではありません。 つまり、モニター対象キューに 何らかの IBM MQ メッセージがある場合、条件は満たされます。 キュー上のすべてのメッセージに対して単一のタスクが実行されます。

  completeGroups

  モニターされるキューには、完全なグループがあります。 つまり、モニター対象キュー上の いずれか の IBM MQ メッセージ・グループが完了すると、条件は満たされます。 キュー上の、それぞれの完全グループに、個別のタスクが実行されます。

  グループ内にない 1 つのメッセージがキュー上に置かれると、このメッセージは完全なグループとして扱われ、 この単一メッセージに対してタスクが実行されます。

  conditionは、-mqパラメーターも指定する場合にのみ指定できます。

作成するモニターごとに、-tr パラメーターを 1 回のみ指定できます。

-tc

オプション。 トリガーされるファイルに、転送要求を生成するための 1 つ以上のファイル・パスが含まれていることを示します。 トリガー・ファイルの内容のデフォルト形式は、行ごとに 1 ファイルのエントリーです。 source file path または source file path,destination file path のいずれかとしてファイル・パスを指定します。 このパラメーターは、ディレクトリー・モニター・トリガー match および noSizeChange にのみ使用可能です。

-tcr pattern

オプション。 トリガー・ファイルを構文解析するための置換正規表現を指定します。 -tcr パラメーターを指定した場合には、-tc パラメーターも指定する必要があります。

各行のエントリーを 1 つか 2 つのキャプチャー・グループで完全に解析するようにパターンを設計します。 グループ 1 でソース・ファイル・パスを定義し、オプションのグループ 2 で宛先ファイル・パスを定義します。 これはデフォルトの動作であり、-tccパラメーターを使用して変更できます。

詳細と例については、 トリガー・ファイルの使用を参照してください。

-tcc

オプション。 正規表現キャプチャー・グループの順序を定義します。

srcDest

デフォルト値で、グループ 1 がソース・ファイル・パスで、グループ 2 が宛先ファイル・パス。

destSrc

srcDest の逆。 グループ 1 が宛先ファイル・パスで、グループ 2 がソース・ファイル・パスです。 destSrc の正規表現には、2 つのキャプチャー・グループがあるようにします。

-tcc パラメーターを指定した場合には、-tcr パラメーターも指定する必要があります。

-x exclude_pattern

オプション。 トリガー・パターン・マッチングから除外されるファイルを指定します。 トリガー・パターンは、-trパラメーターによって指定されます。

このパターンは、ワイルドカードまたは Java 正規表現フォーマットのファイル・パターン・マッチング・シーケンスです。 デフォルト・フォーマットはワイルドカード・フォーマットです。 -ptパラメーターを使用して、パターンのフォーマットを指定します。

-mmd monitor_metadata

オプション。 モニターの出口点に渡されるユーザー定義のメタデータを示します。 パラメーターには、名前ペアをコンマ区切りで 1 つ以上含められます。 それぞれの名前ペアの構成は、name=value になります。 1 つのコマンドで-mmdパラメーターを複数回使用することができます。

-pt pattern_type

オプション。 -trパラメーターおよび-xパラメーターによって使用されるパターンのタイプ。 有効な値は以下のとおりです。

ワイルドカード

パターンがワイルドカード・パターンとして評価されます。 アスタリスク (*) はゼロ個以上の文字と一致し、疑問符 (?) はちょうど 1 つの文字と一致します。 これはデフォルトです。

正規表現

パターンが Java 正規表現として評価されます。 詳しくは、 MFT で使用される正規表現を参照してください。

-bs matches_per_task

オプション。 単一タスクに含めるトリガー・マッチングの最大数。 例えば、matches_per_task に値 5 が指定されているときに、1 回のポーリング間隔で 9 個のトリガー・マッチングが発生すると、2 つのタスクが実行されます。 最初のタスクがトリガー 1 から 5 に対応し、2 番目のタスクがトリガー 6 から 9 に対応します。 matches_per_task のデフォルト値は 1 です。

-bsパラメーターは、-mtパラメーターに指定するタスク定義 XML が managedTransfer である場合にのみサポートされます。 managedCall は、-bsパラメーターではサポートされません。

-mquserid ユーザー ID

オプション。 コマンド・キュー・マネージャーで認証するユーザー ID を指定します。

-mqpassword パスワード

オプション。 調整キュー・マネージャーで認証するパスワードを指定します。

-mqpassword パラメーターを指定する場合は、 -mquserid パラメーターも指定する必要があります。 -mquseridを指定し、 -mqpasswordを指定しない場合は、関連付けられたパスワードを入力するように求めるプロンプトが出されますが、これは表示されません。

IBM MQ 9.3 以降、このコマンドはデフォルトで MQCSP 認証を使用するようになり、認証されるユーザー ID とパスワードを MQCSP 構造でキュー・マネージャーに送信します。

-ノルプウ

オプション。 12 文字を超えるパスワードをサポートしないキュー・マネージャーにコマンドが接続する場合は、このパラメーターを指定します。

-nolpw パラメーターを指定する場合は、 -mquserid パラメーターも指定する必要があります。 -mquserid および -nolpwを指定し、 -mqpasswordを指定しない場合は、関連付けられたパスワードを入力するように求めるプロンプトが出されますが、これは表示されません。

注: -nolpw オプションを指定し、パスワードが 12 文字より長い場合、コマンドは失敗し、エラー・メッセージ BFGCL0829Eが表示されます。

-dv default_variables

オプション。 キューをモニターする際に変数置換に使用できるデフォルト変数のコンマ区切りリスト。 値は、キー値ペアの形式です。 以下に例を示します。

-dv size=medium,color=blue

変数置換について詳しくは、 変数置換を使用した MFT タスクのカスタマイズを参照してください。 -dvパラメーターは、-mqパラメーターも指定した場合にのみ指定できます。

- ? または -h

オプション。 コマンド構文を表示します。

-p configuration_options

オプション。 このパラメーターは、転送を取り消すために使用する構成オプションのセットを決定します。 慣例として、このパラメーターの入力には、デフォルト調整キュー・マネージャー以外の名前を使用します。 これで、コマンドは、デフォルト以外の調整キュー・マネージャーと関連付けられたプロパティー・ファイルのセットを使用します。

このパラメーターを指定しない場合、デフォルトの調整キュー・マネージャーに基づいた構成オプションのセットが使用されます。

戻りコード