MFT agent.properties ファイル
各 Managed File Transfer Agent には独自のプロパティー・ファイル agent.properties があります。このファイルには、エージェントがキュー・マネージャーに接続するために使用する情報が含まれている必要があります。 agent.properties ファイルには、エージェントの動作を変更するプロパティーを含めることもできます。
agent.properties ファイルは、インストーラー、 fteCreateAgent、 fteCreateBridgeAgent 、または fteCreateCDAgent コマンドによって作成されます。 これらのコマンドのいずれかを -f フラグと共に使用して、基本エージェント・キュー・マネージャー・プロパティーおよび、作成しているエージェントのタイプに関連付けられている拡張エージェント・プロパティーを変更できます。 拡張エージェント・プロパティーを変更または追加するには、テキスト・エディターでファイルを編集する必要があります。
![[UNIX、Linux、Windows、IBM i]](ngmulti.gif)
Multiplatforms では、エージェントの agent.properties ファイルは MQ_DATA_PATH/mqft/config/coordination_qmgr_name/agents/agent_name ディレクトリーにあります。
![[z/OS]](ngzos.gif)
z/OS®では、 agent.properties ファイルの場所は $BFG_CONFIG
variable/mqft/config/coordination_qmgr_name/agents/agent_nameです。
agent.properties ファイルを変更した場合は、エージェントを再起動してその変更が反映されるようにする必要があります。
環境変数は、ファイルまたはディレクトリーの場所を表すいくつかの Managed File Transfer プロパティーで使用できます。 これにより、製品の一部の実行時に使用されるファイルまたはディレクトリーの場所を、環境の変更 (プロセスを実行しているユーザーなど) に合わせて変えることができます。 詳しくは、 MFT プロパティーでの環境変数の使用を参照してください。
エージェントの基本プロパティー
| プロパティー名 | 説明 | デフォルト値 |
|---|---|---|
| agentName | エージェントの名前。 エージェントの名前は、 IBM MQ オブジェクト命名規則に準拠している必要があります。 詳しくは、 MFT オブジェクト命名規則を参照してください。 | デフォルトなし |
| agentDesc | エージェントの説明 (説明の作成を選択した場合)。 | デフォルトなし |
| agentQMgr | エージェントのキュー・マネージャーの名前。 | デフォルトなし |
| agentQMgrHost | エージェントのキュー・マネージャーのホスト名または IP アドレス。 | デフォルトなし |
| agentQMgrPort | エージェントのキュー・マネージャーとのクライアント接続で使用されるポート番号。 | 1414 |
| agentQMgrChannel | エージェントのキュー・マネージャーとの接続に使用される SVRCONN チャネル名。 | SYSTEM.DEF.SVRCONN |
| agentType | エージェントのタイプ。
|
STANDARD |
agentQMgrHost プロパティーの値を指定しない場合は、デフォルトでバインディング・モードが使用されます。
agentQMgrHost プロパティーに値を指定し、agentQMgrPort および agentQMgrChannel プロパティーには値を指定しない場合、ポート番号 1414 およびチャネル SYSTEM.DEF.SVRCONN がデフォルトで使用されます。
拡張エージェント・プロパティー
Managed File Transfer には、エージェントの構成に役立つ拡張エージェント・プロパティーも用意されています。 以下のプロパティーのいずれかを使用する場合は、agent.properties ファイルを手動で編集し、必要な拡張プロパティーを追加します。 Windows のファイル・パスを指定する場合は、区切り文字のバックスラッシュ (¥) が 2 つのバックスラッシュ (¥¥) で入力されていること、つまり、バックスラッシュ (¥) がエスケープされていることを確認してください。あるいは、単一のスラッシュ文字 (/) を区切り文字として使用することもできます。 Java プロパティー・ファイルでの文字エスケープについて詳しくは、 Oracle の資料「 Properties クラスの Javadoc」を参照してください。
- エージェント・サイズ・プロパティ
- コード・ページ・プロパティー
- コマンド・プロパティー
- 接続プロパティー
- Connect:Direct ブリッジ・プロパティー
- ファイルからメッセージへの転送とメッセージからファイルへの転送に関するエージェント・プロパティー
- 汎用エージェント・プロパティー
![[V9.1.4 2019 年 12 月]](ng914.gif)
高可用性特性- 入出力プロパティー
- マルチチャネル・サポート・プロパティー
- マルチインスタンス・プロパティー
- プロセス・コントローラー・プロパティー
- プロトコル・ブリッジ・プロパティー
- プロトコル・ブリッジ・エージェントのログ・プロパティー
- キュー・プロパティー
- リソース・モニター・プロパティー
- ルート・ディレクトリー・プロパティ
- スケジューラー・プロパティー
- セキュリティー・プロパティー
- タイムアウト・プロパティー
![[V9.1.0 2018 年 7 月]](ng910.gif)
転送リカバリー・タイムアウト・プロパティー- トレースおよびロギングのプロパティー
- 転送制限プロパティー
- ユーザー出口ルーチン・プロパティー
- IBM MQ クライアント圧縮プロパティー
- z/OS固有のプロパティー
- その他のプロパティー
SSL プロパティーについては、 MFT の SSL プロパティーを参照してください。
| プロパティー名 | 説明 | デフォルト値 |
|---|---|---|
| エージェント・サイズ・プロパティー: | ||
| agentCheckpointInterval | チェックポイントがリカバリー目的で設定される完全なデータ・フレーム単位での間隔。 これは拡張プロパティーであり、ほとんどの Managed File Transfer 構成では、その値を変更する必要はありません。 何らかの問題によって転送がリカバリー状態になる場合、転送をリカバリーできるのは、チェックポイントの境界までだけです。 したがって、この値を大きくすると (agentChunkSize、agentWindowSize、および agentFrameSize にも大きな値を設定)、エージェントが転送をリカバリーするのに必要な時間が長くなります。 転送がリカバリー状態になることがほとんどない信頼性の高い Managed File Transfer ネットワークの場合は、この値を増やすことで全体的なパフォーマンスを向上させることができます。 |
1 |
| agentChunkSize | ファイル・データのトランスポートの各転送チャンクのサイズ したがって、ソース・エージェントと宛先エージェントの間で転送される IBM MQ メッセージの最大サイズを示します。 これは拡張プロパティーであり、ほとんどの Managed File Transfer 構成では、その値を変更する必要はありません。 この値は、ソース・エージェントと宛先エージェントの間でネゴシエーションされ、 両者の値のうち大きい方が使用されます。 このプロパティーの値を変更する場合は、ソース・エージェント側と宛先エージェント側の両方で値を変更してください。 agentChunkSize は整数値です。 例えば、agentChunkSize=10240 とすると、チャンク・サイズは 10 KB に設定されます。 |
262144 バイト (256 KB 相当) |
| agentFrameSize | 転送フレームのウィンドウの数。 これは拡張プロパティーであり、ほとんどの Managed File Transfer 構成では、その値を変更する必要はありません。 待ち時間の長いネットワークでは、この値を増やすとエージェントが同時にアクティブにできるメッセージ・チャンクが増えるため、全体的なパフォーマンスの改善に役立つ可能性があります。 このプロパティーの値に agentWindowSize を乗算し、さらに agentChunkSize を乗算した値は、転送ごとのエージェントのメモリー消費量の上限を意味します。 例えば、262144 バイトのチャンク x 10 x 5 = 12.5 MB (転送ごと) となります。 注: 単一の転送で転送されるファイルのサイズが 12.5 MB より小さい場合、このプロパティーの値を増やしても、転送のパフォーマンスに与える効果はありません。 |
5 |
| agentWindowSize | 各ウィンドウのチャンクの数。 これは拡張プロパティーであり、ほとんどの Managed File Transfer 構成では、その値を変更する必要はありません。 待ち時間の長いネットワークでは、この値を増やすと、全体的なパフォーマンスの改善に役立つ可能性があります。 その理由は、エージェントが同時にアクティブにできるメッセージ・チャンクが増えて、確認応答メッセージがソース・エージェントに返信される頻度が減るためです。 このプロパティの値にagentFrameSize,を乗じ、agentChunkSize,を乗じた値が、各転送におけるエージェントのメモリ消費量の上限を示し、転送先エージェントのコマンドキュー上の 'IBM MQメッセージデータの上限を示す。 例えば、262144 バイトのチャンク x 10 x 5 = 上限 12.5 MB (転送ごと) となります。 注: 単一の転送で転送されるファイルのサイズが 12.5 MB より小さい場合、このプロパティーの値を増やしても、転送のパフォーマンスに与える効果はありません。 |
10 |
| コード・ページ・プロパティー: | ||
| agentCcsid | エージェントがそのエージェント・キュー・マネージャーに接続するときに使用するコード・ページ。 agentCcsid の値を指定する場合は、agentCcsidName の値も指定する必要があります。 JVM の既知のコード・ページを表示する方法については、 fteCreateBridgeAgent コマンドの -hsc パラメーター を参照してください。 | 1208 |
| agentCcsidName | agentCcsid の Java 表記。 agentCcsidName の値を指定する場合は、agentCcsid の値も指定する必要があります。 | UTF8 |
| コマンド・プロパティー: | ||
| maxCommandHandlerThreads | 初期構文解析および転送コマンド・メッセージの処理に使用可能なスレッド数を制御します。 アクティブである場合には、スレッドはキュー・マネージャーへの接続を必要としますが、アイドルである場合には、スレッドは接続を解放します。 | 5 |
| maxCommandOutput | コマンド出力用に保管される最大バイト数。 このプロパティーは、管理対象呼び出し用に指定されたコマンド、および、管理対象転送用の preSource、postSource、preDestination、および postDestination コマンドに適用されます。 この値によって、SYSTEM.FTE トピックの転送ログに書き込まれるコマンド出力の長さが制限されます。 | 10240 |
| maxCommandRetries | エージェントが許可するコマンド再試行の最大回数。 このプロパティーは、管理対象呼び出し用に指定されたコマンド、および、管理対象転送用の preSource、postSource、preDestination、および postDestination コマンドに適用されます。 | 9 |
| maxCommandWait | エージェントが許可する各再試行間の最大待ち時間 (秒単位)。 このプロパティーは、管理対象呼び出し用に指定されたコマンド、および、管理対象転送用の preSource、postSource、preDestination、および postDestination コマンドに適用されます。 | 60 |
| immediateShutdownTimeout | エージェントの即時シャットダウンの場合は、このプロパティーを使用して、シャットダウンを強制する前にエージェントがその転送の完了を待つ最大時間を秒単位で指定することができます。 注: このプロパティーの値をデフォルトの 10 秒未満に変更しないでください。 エージェントの即時シャットダウンには、外部プロセスをすべて終了するための十分な時間が必要です。 このプロパティーの値が低すぎる場合は、プロセスが実行されたままになる可能性があります。
このプロパティーに 0 の値が指定されると、エージェントは、未解決の転送がすべて停止するのを待ちます。 このプロパティーに無効値が指定されると、デフォルト値が使用されます。 |
10 |
| 接続プロパティー: | ||
| javaLibraryPath | バインディング・モードでキュー・マネージャーに接続する場合、 Managed File Transfer は IBM MQ Java バインディング・ライブラリーにアクセスできなければなりません。 デフォルトでは、 Managed File Transfer は、 IBM MQによって定義されたデフォルトの場所でバインディング・ライブラリーを検索します。 バインディング・ライブラリーが別の場所にある場合は、このプロパティーを使用して、バインディング・ライブラリーの場所を指定してください。 | なし |
| Connect:Direct ブリッジ・プロパティー: | ||
| cdNode | Connect:Direct ブリッジを使用する場合は必須プロパティー。 Connect:Direct ブリッジ・エージェントから宛先 Connect:Direct ノードにメッセージを転送するために使用する Connect:Direct ノードの名前。 このノードは、転送のソースまたは宛先であるリモート・ノードではなく、 Connect:Direct ブリッジの一部です。 詳しくは、 Connect:Direct ブリッジを参照してください。 |
デフォルトなし |
| cdNodeHost | Connect:Direct ブリッジ・エージェントから宛先ノード ( Connect:Direct ブリッジ・ノード) にファイルを転送するために使用する Connect:Direct ノードのホスト名または IP アドレス。 ほとんどの場合、 Connect:Direct ブリッジ・ノードは Connect:Direct ブリッジ・エージェントと同じシステム上にあります。 その場合、このプロパティーのデフォルト値 (ローカル・システムの IP アドレス) は適正です。 ご使用のシステムに複数の IP アドレスがある場合、または Connect:Direct ブリッジ・ノードが Connect:Direct ブリッジ・エージェントとは異なるシステム上にあり、それらのシステムがファイル・システムを共有する場合は、このプロパティーを使用して、 Connect:Direct ブリッジ・ノードの正しいホスト名を指定します。 cdNode プロパティーを設定しなかった場合、このプロパティーは無視されます。 |
ローカル・システムのホスト名または IP アドレス |
| cdNodePort | クライアント・アプリケーションがノードとの通信に使用する Connect:Direct ブリッジ・ノードのポート番号。 Connect:Direct 製品資料では、このポートは API ポートと呼ばれます。 cdNode プロパティーを設定しなかった場合、このプロパティーは無視されます。 |
1363 |
| cdTmpDir | ファイルが宛先 Connect:Direct ノードに転送される前に、 Connect:Direct ブリッジ・エージェントが実行されているシステム上でファイルを一時的に保管する場所。 このプロパティーは、ファイルが一時的に保管されるディレクトリーの絶対パスを指定します。 例えば、cdTmpDir を /tmp に設定すると、ファイルは /tmp ディレクトリーに一時的に置かれます。 Connect:Direct ブリッジ・エージェントと Connect:Direct ブリッジ・ノードは、同じパス名を使用して、このパラメーターで指定されたディレクトリーにアクセスできなければなりません。 Connect:Direct ブリッジのインストールを計画する際には、この点を考慮してください。 可能な場合は、 Connect:Direct ブリッジの一部である Connect:Direct ノードが配置されているシステム上にエージェントを作成します。 エージェントとノードが別個のシステム上にある場合は、ディレクトリーが共有ファイル・システム上にあり、両方のシステムから同じパス名を使用してアクセスできる必要があります。 サポートされる構成について詳しくは、 Connect:Direct ブリッジを参照してください。 cdNode プロパティーを設定しなかった場合、このプロパティーは無視されます。 このプロパティーの値には、環境変数を含めることができます。 詳しくは、 MFT プロパティーでの環境変数の使用 を参照してください。 |
Windowsでは、
|
| cdTrace | Connect:Direct ブリッジ・エージェントとその Connect:Direct ノードの間で送信されるデータをエージェントがトレースするかどうか。 このプロパティーの値は、true または false のいずれかになります。 | false |
| cdMaxConnectionRetries | 成功した接続がまだ確立されていないファイル転送について、転送が失敗するまでの Connect:Direct 接続試行の最大回数。 | -1 (試行回数は無制限) |
| cdMaxPartialWorkConnectionRetries | 前回の接続試行が成功し、転送作業が完了したファイル転送について、転送が失敗するまでの Connect:Direct 接続試行の最大回数。 | -1 (試行回数は無制限) |
| cdMaxWaitForProcessEndStats | プロセスの終了後、ファイル転送が失敗したと判断されるまでに、 Connect:Direct ノード統計情報内で Connect:Direct プロセス完了情報が使用可能になるのを待機する最大時間 (ミリ秒)。 一般に、この情報は即時に使用可能になりますが、特定の失敗条件下においては情報がパブリッシュされません。 そうした条件において、このプロパティーで指定した待機時間後にファイル転送は失敗します。 | 60000 |
| cdAppName | Connect:Direct ブリッジ・エージェントがブリッジの一部である Connect:Direct ノードに接続するために使用するアプリケーション名。 | Managed File Transfer 現行バージョン。ここで、 current version は製品のバージョン番号です。 |
| cdNodeLocalPortRange | Connect:Direct ブリッジ・エージェントと、ブリッジの一部である Connect:Direct ノードとの間のソケット接続に使用するローカル・ポートの範囲。 この値の形式は、値または範囲のコンマ区切りリストです。 デフォルトでは、オペレーティング・システムによってローカル・ポート番号が選択されます。 |
なし |
| cdNodeProtocol | Connect:Direct ブリッジ・エージェントがブリッジの一部である Connect:Direct ノードに接続するために使用するプロトコル。 有効な値は以下のとおりです。
|
TCPIP |
| cdNodeKeystore | Connect:Direct ブリッジ・エージェントと、ブリッジの一部である Connect:Direct ノードとの間のセキュア通信に使用される鍵ストアへのパス。 SSL または TLS に cdNodeProtocol プロパティーを設定しなかった場合、このプロパティーは無視されます。 このプロパティーの値には、環境変数を含めることができます。 詳しくは、 MFT プロパティーでの環境変数の使用 を参照してください。 |
なし |
| cdNodeKeystoreType | cdNodeKeystore プロパティーで指定する鍵ストアのファイル・フォーマット。 有効な値は、jks と pkcs12 です。 SSL または TLS に cdNodeProtocol プロパティーを設定しなかった場合、このプロパティーは無視されます。 |
jks |
| cdNodeKeystoreCredentialsFile | cdNodeKeystore 資格情報が含まれているファイルのパス。 このプロパティーの値には、環境変数を含めることができます。 詳しくは、 MFT プロパティーでの環境変数の使用 を参照してください。 |
|
| cdNodeTruststore | Connect:Direct ブリッジ・エージェントと、ブリッジの一部である Connect:Direct ノードとの間のセキュア通信に使用されるトラストストアへのパス。 SSL または TLS に cdNodeProtocol プロパティーを設定しなかった場合、このプロパティーは無視されます。 このプロパティーの値には、環境変数を含めることができます。 詳しくは、 MFT プロパティーでの環境変数の使用 を参照してください。 |
なし |
| cdNodeTruststoreType | cdNodeTruststore プロパティーで指定するトラストストアのファイル・フォーマット。 有効な値は、jks と pkcs12 です。 SSL または TLS に cdNodeProtocol プロパティーを設定しなかった場合、このプロパティーは無視されます。 |
jks |
| cdNodeTruststoreCredentialsFile | cdNodeTruststore 資格情報が含まれているファイルのパス。 このプロパティーの値には、環境変数を含めることができます。 詳しくは、 MFT プロパティーでの環境変数の使用 を参照してください。 |
|
| logCDProcess | output0.log ファイルで、エージェントのイベント・ログに記録する Connect:Direct プロセス・ロギングのレベル。 このプロパティーがとることのできる値は None、Failures、または All です。 | なし |
| ファイルからメッセージへの転送とメッセージからファイルへの転送に関するエージェント・プロパティー: | ||
| deleteTmpFileAfterRenameFailure | このプロパティーを値 false に設定すると、名前変更操作が失敗した場合に一時ファイルが宛先から削除されません。 この場合、転送されたデータは、宛先の一時ファイル (.part) に残ります。 このファイルは、後から手動で名前変更できます。 デフォルトでは、このプロパティーの値は true です。 このプロパティーは、メッセージからファイルへの転送とファイルからファイルへの転送の両方に適用されます。 | true |
| enableQueueInputOutput | デフォルトでは、エージェントが転送の一環としてソース・キューからデータを読み取ったり、宛先キューにデータを書き込んだりすることはできません。 この値を true に設定すると、エージェントは、ファイルからメッセージへの転送とメッセージからファイルへの転送を実行できるようになります。 このプロパティーの値は、true または false のいずれかになります。 | false |
| enableSystemQueueInputOutput | エージェントが IBM MQ システム・キューに対して読み取りまたは書き込みを行えるかどうかを指定します。 システム・キューには、SYSTEM 修飾子が接頭部として付いています。 注: システム・キューは、重要な情報を送信するために IBM MQ、 Managed File Transfer、およびその他のアプリケーションによって使用されます。 このプロパティーを変更すると、エージェントがそれらのキューにアクセスできるようになります。 このプロパティーを有効にする場合は、ユーザー・サンドボックス機能を使用して、エージェントがアクセスできるキューを制限してください。
|
false |
| enableClusterQueueInputOutput | エージェントが IBM MQ クラスター・キューに対して読み取りまたは書き込みを行えるかどうかを指定します。 注： enableQueueInputOutputプロパティに加えて、enableClusterQueueInputOutputエージェント・プロパティも指定する必要があります。
|
false |
| maxDelimiterMatchLength | ファイルからメッセージへの転送の一環として 1 つのテキスト・ファイルを複数のメッセージに分割するときに使用する Java 正規表現のマッチング項目と見なせる文字の最大数。 | 5 |
| maxInputOutputMessageLength | エージェントによってソース・キューから読み取られるメッセージ、または宛先キューに書き込まれるメッセージの最大長 (バイト単位)。 転送のソース・エージェントの maxInputOutputMessageLength プロパティーは、ソース・キューのメッセージから読み取ることができるバイト数を決定します。 転送の宛先エージェントの maxInputOutputMessageLength プロパティーは、宛先キューのメッセージに書き込むバイト数を決定します。 メッセージの長さがこのプロパティーの値を超えた場合、転送はエラーを出して失敗します。 このプロパティーは、 Managed File Transfer 内部キューには影響しません。 このプロパティの変更については、「メッセージ・サイズに関連するMQ属性と 'MFTプロパティの設定に関するガイダンス」を参照してください。 | 1048576 |
| monitorGroupRetryLimit | メッセージ・グループがまだキューに存在している場合に、モニターがメッセージからファイルへの転送を再度起動する最大回数。 メッセージからファイルへの転送が起動された回数は、グループの最初のメッセージの MQMD バックアウト・カウントで判別されます。 エージェントが再始動した場合、転送の起動回数が monitorGroupRetryLimit の値を超えている場合でも、モニターは再度転送を起動します。 この動作により、転送の起動回数が monitorGroupRetryLimit の値を超えてしまった場合、エージェントはイベント・ログにエラーを書き込みます。 このプロパティーに値 -1 が指定された場合、モニターは、起動条件が満たされなくなるまで何度でも転送を再度起動します。 |
10 |
| 汎用エージェント・プロパティー | ||
| agentStatusPublishRateLimit | ファイル転送状況に変更があった場合に、エージェントがその状況を
リパブリッシュする最大速度 (秒)。 このプロパティーの値を小さすぎる値に設定すると、 IBM MQ ネットワークのパフォーマンスに悪影響が及ぶ可能性があります。 |
30 |
| agentStatusPublishRateMin | エージェントが自身の状況をパブリッシュする最小速度 (秒単位)。 この値は、agentStatusPublishRateLimit プロパティーの値以上でなければなりません。 | 300 |
| enableMemoryAllocationChecking | 転送が受け入れられる前に、転送を実行するために使用可能なメモリーが十分にあるかどうかを Managed File Transfer Agent が検査するかどうかを決定します。 この検査は、ソース・エージェントと宛先エージェントの両方で行われます。 使用可能なメモリーが不足している場合は、転送はリジェクトされます。 転送に必要なメモリーの計算時には、転送に必要な最大メモリーが使用されます。 そのため、値は、転送で使用される実際のメモリーより大きくなる可能性があります。 この理由により、enableMemoryAllocationChecking プロパティーを true に設定すると、実行できる同時転送数が減少する可能性があります。 このプロパティーを true に設定することをお勧めするのは、 Managed File Transfer がメモリー不足エラーで失敗する問題が発生している場合のみです。 大量のメモリーを消費する可能性のある転送には、メッセージのサイズが大きい場合の、ファイルからメッセージへの転送とメッセージからファイルへの転送があります。 |
false |
| enableDetailedReplyMessages | このプロパティーを true に設定すると、管理対象転送要求応答に、転送されるファイルに関する詳細な情報を含めることができます。 詳細な情報とその形式は、転送ログの進行メッセージ (つまり <transferSet> エレメント) に公開されるものと同じです。 詳しくは、 ファイル転送ログ・メッセージ・フォーマットを参照してください。 詳細な応答情報は、管理対象転送要求で詳細な応答情報が必要であると指定した場合にのみ含められます。 この要件を指定するには、ソース・エージェントに送信される managedTransfer XML 要求メッセージの <reply> エレメントの 転送要求ごとに、複数の応答メッセージを生成できます。 その数は、転送の転送ログ進行メッセージの数値に 1 を加えたものと同じになります (最初の応答メッセージは単純な ACK 応答です)。 詳細情報は ACK 応答メッセージを除くすべてのメッセージに含まれますが、全体の転送結果は最後の詳細な応答メッセージのみに含まれます。 |
true |
| enableUserMetadataOptions | 新しい転送要求でユーザー定義メタデータの既知のキーを使用して追加の転送オプションを指定できるかどうかを決定します。 これらの既知のキーは、常に接頭部 com.ibm.wmqfte. で始まります。 enableUserMetadataOptions プロパティーが true に設定されると、この接頭部を使用するキーは、ユーザー定義の用途ではサポートされなくなります。 enableUserMetadataOptions プロパティーが true に設定されている場合に現在サポートされるキーは、以下のとおりです。
このプロパティーの値は、true または false のいずれかになります。 |
false |
| failTransferOnFirstFailure | 管理対象転送内にある転送項目が失敗するとすぐにその管理対象転送を失敗させるようにエージェントを構成できるようになります。 この機能を有効にするには、ソースエージェントとデスティネーションエージェントの両方にAPARIT03450を適用し、ソースエージェントの 'agent.propertiesファイルでfailTransferOnFirstFailureプロパティをtrueに設定する必要があります。 宛先エージェントでプロパティーを true に設定するのは任意です。 failTransferOnFirstFailure プロパティーが true に設定されると、エージェントは管理対象転送要求の処理を通常どおりに開始します。 ただし、転送項目が失敗するとすぐに、管理対象転送は失敗としてマークされ、それ以降の転送項目は処理されません。 管理対象転送が失敗する前に正常に処理された転送項目は、次のように処理されます。
failTransferOnFirstFailure プロパティーが true に設定されておらず、管理対象ファイル転送に複数のファイルが含まれていて、これらのファイルの 1 つが転送に失敗した場合 (例えば宛先ファイルがすでに存在していて、overwrite プロパティーが error に設定されている場合など)、ソース・エージェントは続行し、要求内の残りのファイルを転送しようとします。 |
false |
| itemsPerProgressMessage | エージェントが次の進行状況ログ・メッセージをパブリッシュするまでに転送されるファイルの数。 このプロパティーを使用して、転送中に進行状況ログ・メッセージが調整キュー・マネージャーにパブリッシュされる速度を制御します。 このプロパティーに設定できる最大値は 1000 です。 注: 進行状況メッセージには、最後の進行状況メッセージがパブリッシュされてから転送されたすべてのファイルに関する情報が含まれます。 この値を増やすと進行メッセージのサイズが大きくなるため、パフォーマンスに影響を与える可能性があります。
|
50 |
| maxInlineFileSize | 単一のファイル間転送またはファイルからメッセージへの転送で、初期転送要求メッセージに自動的に組み込むことのできる最大ファイル・サイズ (バイト単位)。 このプロパティーを使用すると、転送の速度を改善できますが、ファイル・サイズの設定値が大き過ぎると、このプロパティーによってパフォーマンスが低下する可能性があります。 このプロパティーに推奨される初期サイズは 100 KB ですが、ご使用のシステムに最適なファイル・サイズを見つけるまでさまざまな値を十分にテストすることをお勧めします。 この機能はデフォルトでオフになっています。また、maxInlineFileSize プロパティーを 0 に設定するとオフになります。 |
0 |
| 高可用性プロパティー: |
||
| highlyAvailable |
このプロパティーはエージェントの始動時に読み取られます。
値 |
false |
| standbyPollInterval |
このプロパティーは、指定された間隔で共有キューを開こうとするスタンバイ・インスタンスによって使用されます。 この試行は、スタンバイ・インスタンスが SYSTEM.FTE.HA.<agent name> キューを開くか、 fteStopAgent コマンドによって停止されるまで繰り返されます。 |
5 秒 |
| standbyStatusDiscardTime |
このプロパティーは、アクティブ・インスタンスがスタンバイ・インスタンスからの状況パブリケーションを待機する期間を設定します。 この時間が経過してもスタンバイ・インスタンスからパブリケーションを受信しない場合、アクティブ・インスタンスはスタンバイ・インスタンスのリストからスタンバイ・インスタンス情報を削除します。 スタンバイ・インスタンスをリストから削除する前に、アクティブ・インスタンスが長時間待機するようにするため、デフォルト値は standbyStatusPublishInterval プロパティーの 2 倍になっています。 |
600 秒 |
| standbyStatusExpiry |
このプロパティーは、エージェントのコマンド・キューに書き込むスタンバイ状況メッセージの有効期限時刻を設定します。 エージェントのアクティブ・インスタンスがこのメッセージを処理しない場合、メッセージの有効期限が切れます。 |
30 秒 |
| standbyStatusPublishInterval |
このプロパティーは、スタンバイ・インスタンスがその状態をパブリッシュする頻度を設定するために使用します。 |
300 秒 |
| 入出力プロパティー: | ||
| doNotUseTempOutputFile | デフォルトでは、エージェントは宛先の一時ファイルに 書き込み、ファイル転送が完了してから、この一時ファイルを必要なファイル名に変更します。 この値を TRUE に設定すると、最終宛先ファイルに、エージェントが直接書き込むことになります。
転送の場合、このプロパティーの値は、宛先エージェントによって定義されます。 |
false |
| enableMandatoryLocking | 通常のファイルにアクセスする場合、 Managed File Transfer は読み取り用の共有ロックと書き込み用の排他ロックを取得します。
このプロパティーは、通常の Managed File Transfer エージェントにのみ適用されます。 Managed File Transfer は、ファイル・サーバー上のファイル・ロック・メカニズムをサポートしません。 したがって、このプロパティーはプロトコル・ブリッジ・エージェントでは無効です。プロトコル・ブリッジ・エージェントは、ファイル転送時にファイル・サーバーのファイルをロックしないからです。 このプロパティーの値は、true または false のいずれかになります。 |
false |
| ioIdleThreadTimeout | スレッドがシャットダウンするまで、ファイル・システムの入出力スレッドがアイドルとなる 時間 (ミリ秒単位)。 | 10000 |
| ioQueueDepth | キューに入れられる入出力要求の最大数。 | 10 |
| ioThreadPoolSize | 有効なファイル・システムの入出力スレッドの最大数。 通常は、個々の転送は各自のファイル・システム入出力スレッドを使用しますが、
同時転送の数がこの制限を超過すると、ファイル・システムの
入出力スレッドは、この転送間で共有されます。 進行中の同時転送の数が、ioThreadPoolSize 値より多くなることがたびたび起きるようであれば、個々の転送が各自のファイル・システム入出力スレッドを持てるようにこの値を大きくすると改善が見られます。 |
10 |
| textReplacementCharacterSequence | テキスト・モード転送で、データ・バイトのいずれかが、ソース・コード・ページから
宛先コード・ページに変換されない場合、
ファイル転送の失敗がデフォルトの動作となります。 転送を正常に完了できるようにこのプロパティーを設定するには、特定の文字値を挿入します。 このプロパティー値は、単一文字です。 通常、マップ不可能な文字には疑問符 (?) が使用されます。 例えば、textReplacementCharacterSequence=? という形式を使用します。ここで、 疑問符 (?) は置換文字です。 置換文字に空白文字を使用することはできません。 |
なし |
| マルチチャネル・サポート: | ||
| agentMultipleChannelsEnabled | このプロパティーを true に設定すると、 Managed File Transfer Agent が複数の IBM MQ チャネルを介して転送データ・メッセージを送信できるようになります。 シナリオによっては、このプロパティーを設定するとパフォーマンスが改善されることがあります。 ただし、マルチチャネル・サポートを使用可能にするのは、パフォーマンス上の明白な利点がある場合のみにしてください。 複数のチャネルを介して送信されるのは、SYSTEM.FTE.DATA.destinationAgentName キューに入れられるメッセージのみです。 他のすべてのメッセージの動作は変更されません。 このプロパティーを trueに設定する場合は、以下のいずれかのトピックの IBM MQ 構成ステップも実行して、マルチチャネル・サポートを有効にする必要があります。さらに、 Managed File Transfer エージェントに必要な標準の IBM MQ 構成ステップも実行する必要があります。これについては、 初めて使用するための MFT の構成で詳しく説明されています。
このプロパティーの値は、true または false のいずれかになります。 |
false |
| agentMessageBatchSize | 複数のチャネルを指定して構成すると、ソース・エージェントはラウンドロビン・ベースで各チャネルを介して転送用のデータ・メッセージを送信します。 このプロパティーによって、各チャネルで一度に送信できるメッセージの数を制御します。 | 5 |
| マルチ・インスタンス・キュー・マネージャーのプロパティー: | ||
| agentQMgrStandby | agentQMgrによって定義されている、複数インスタンス・エージェント・キュー・マネージャーのスタンバイ・インスタンスに対して、 IBM MQ CONNAME 形式でクライアント接続するために使用されるホスト名とポート番号。 例えば、host_name(port_number)エージェントは、接続切断エラー (MQRC 2009 など) を検出すると、スタンバイ・キュー・マネージャーへの接続を試行します。 エージェントがスタンバイ・キュー・マネージャーに接続されると、スタンバイ・キュー・マネージャーが使用不可になるまでエージェントは接続されたままになります。 |
デフォルトなし |
| プロセス・コントローラーのプロパティー: | ||
| agentQMgrRetryInterval | エージェントのプロセス・コントローラーがキュー・マネージャーの使用可否を検査する間隔 (秒単位)。 | 30 |
| maxRestartCount | maxRestartInterval プロパティーの値によって指定された時間間隔内に行える再開の最大回数。 この値を超えると、エージェントのプロセス・コントローラーはエージェントの再開を中止し、その代わりに maxRestartDelay プロパティーの値に基づいたアクションを実行します。 | 4 |
| maxRestartInterval | エージェントのプロセス・コントローラーがエージェントの再開数を測定する間隔 (秒単位)。 この間隔内に行われた再開の回数が maxRestartCount プロパティーの値を超過すると、エージェントのプロセス・コントローラーはそのエージェントの再開を中止します。 エージェントのプロセス・コントローラーは、その代わりに maxRestartDelay プロパティーの値に基づいたアクションを実行します。 | 120 |
| maxRestartDelay | エージェントの再開率が maxRestartCount プロパティーおよび maxRestartInterval プロパティーの値を超過した場合にエージェントのプロセス・コントローラーがとる動作を決定します。 ゼロ以下の値を指定すると、エージェントのプロセス・コントローラーは停止します。 ゼロより大きな値を指定した場合、その秒数だけ待機した後、エージェントのプロセス・コントローラーが保持する再開履歴情報がリセットされ、エージェントが再開されます。 | -1 |
| プロトコル・ブリッジ・プロパティー | ||
| protocolBridgeCredentialConfiguration | このプロパティーの値は、protocolBridgeCredentialExitClasses によって指定された出口クラスの initialize() メソッドにストリングとして渡されます。 | null |
| protocolBridgeCredentialExitClasses | プロトコル・ブリッジ資格情報ユーザー出口ルーチンを実装するクラスのコンマ区切りリストを指定します。 詳しくは、 出口クラスを使用したファイル・サーバーの資格情報のマッピングを参照してください。 | デフォルトなし |
| protocolBridgeDataTimeout | プロトコル・ブリッジ・エージェントが、FTP サーバーへのデータ接続が確立されるのを待機する場合のタイムアウト、または既に確立されている接続上で FTP サーバーからデータを受信するのを待機する場合のタイムアウト (ミリ秒)。 このプロパティーを値 0 に設定すると、プロトコル・ブリッジ・エージェントは無期限に待機します。 タイムアウト時間に達すると、プロトコル・ブリッジ・エージェントは FTP サーバーへの既存のすべてのデータ接続を閉じて、現在の転送が再開される前に新しいデータ接続の確立を試行します。 新しいデータ接続を確立しようとしたときに失敗すると、現在の転送も失敗します。 |
0 |
| protocolBridgeLogoutBeforeDisconnect | FTP セッションをクローズし、切断する前に、プロトコル・ブリッジ・エージェントがファイル・サーバーからユーザーをログアウトするかどうかを指定します。 このプロパティーを true に設定すると、プロトコル・ブリッジ・エージェントはファイル・サーバーに FTP QUIT コマンドを発行します。 | false |
| protocolBridgePropertiesConfiguration | protocolBridgeServerPropertiesExitClasses プロパティーによって指定された出口クラスの initialize() メソッドに、ブリッジ・プロパティーの 1 つとして渡されます。 |
デフォルトなし |
| protocolBridgePropertiesExitClasses | プロトコル・ブリッジ・サーバー・プロパティー・ユーザー出口ルーチンを実装するクラスのコンマ区切りリストを指定します。 詳しくは、 ProtocolBridgePropertiesExit2: プロトコル・ファイル・サーバー・プロパティーの検索を参照してください。 | デフォルトなし |
| プロトコル・ブリッジ・エージェントのロギング・プロパティー | ||
| agentLog | プロトコル・ブリッジ・エージェントと FTP/SFTP/FTPS ファイル・サーバー間の FTP コマンドと応答のロギングを有効または無効にするキー値ペア・コンポーネントと操作。 以下に例を示します。
|
デフォルトなし |
| agentLogFileSize | キャプチャー・ファイルの最大サイズを定義します (メガバイト)。 正規のトレース・デフォルト・ファイル・サイズのデフォルトと同じです。 | 20 |
| agentLogFiles | 保持されるキャプチャー・ファイルの最大数を定義します。この数を超えると、最も古いファイルが破棄されます。 | 10 |
| agentLogFilter | デフォルトで、エージェントが接続しているすべての FTP サーバーとの通信をキャプチャーします。 以下に例を示します。
|
* |
| キュー・プロパティー: | ||
| dynamicQueuePrefix |
このプロパティーは、一時動的キューを作成するときに使用する接頭部を定義します。 | WMQFTE.* |
| modelQueueName |
このプロパティーは、一時動的キューを作成するときに使用するモジュール・キューの名前を定義します。 | SYSTEM.DEFAULT.MODEL.QUEUE |
| publicationMDUser | 調整キュー・マネージャーによってパブリッシュされるために 送信されたメッセージと関連付ける MQMD ユーザー ID。 このプロパティーを設定しない場合、MQMD ユーザー ID は、MQMD ユーザー ID の設定に関する IBM MQ 規則に基づいて設定されます。 | デフォルトなし |
| リソース・モニター・プロパティー: | ||
| monitorFilepathPlatformSeparator | $FILEPATH 変数内で、プラットフォーム固有のパス区切り文字を使用するかどうかを指定します。 値が true の場合、プラットフォーム固有のパス区切り文字が使用されます。 値が false の場合、UNIX スタイルのスラッシュ (/) パス区切り文字がすべてのプラットフォームで使用されます。 | true |
| monitorMaxResourcesInPoll | 各ポーリング間隔で起動されるモニター対象リソースの最大数を指定します。 例えば、モニター・パターンに *.txt、ポーリング間隔に 10 秒を指定し、monitorMaxResourcesInPoll プロパティーを 10 に設定すると、monitorMaxResourcesInPoll プロパティーによりエージェントはポーリング間隔ごとに最大値の 10 個のマッチングで起動するように制限されます。 マッチング・リソースが 10 個の限度を超えると、その後のポーリング間隔で起動されます。 さらに、monitorMaxResourcesInPollプロパティと、'fteCreateMonitorコマンドの一致する '-bsパラメータを組み合わせて使用することで、例えば、各ポーリング間隔を、1 つの転送のみをトリガするように制限することができる。 ゼロ以下の値を指定すると、ポーリング間隔で起動されるモニター・リソースの数は無制限になります。 |
-1 |
| monitorReportTriggerFail | モニターで検出される環境および構成で発生した障害状態をログ・メッセージとして SYSTEM.FTE トピックに報告するかどうかを指定します。 値を true にするとメッセージをログに記録します。 値を false にするとメッセージをログに記録しません。 | true |
| monitorReportTriggerNotSatisfied | トリガーが条件を満たさなかった場合、詳細情報を組み込んだログ・メッセージを SYSTEM.FTE トピックに送信するかどうかを指定します。 値を true にするとメッセージをログに記録します。 値を false にするとメッセージをログに記録しません。 | false |
| monitorReportTriggerSatisfied | トリガーが条件を満たした場合、詳細情報を組み込んだログ・メッセージを SYSTEM.FTE トピックに送信するかどうかを指定します。 値を true にするとメッセージをログに記録します。 値を false にするとメッセージをログに記録しません。 | false |
| monitorSilenceOnTriggerFailure | リソース・モニター・トリガーが連続してこの回数だけ失敗すると、障害がレポートされなくなる許容回数。 | 5 |
| monitorStopOnInternalFailure | リソース・モニターの内部 FFDC 条件が連続してこの回数だけ発生すると、モニターの状態が停止に変更される許容回数。 | 10 |
| ルート・ディレクトリー・プロパティー: | ||
| commandPath | 以下のいずれかのメソッドを使用してコマンドを呼び出すことができるパスのセットを指定します。
commandPath プロパティーの値の有効な構文については、 commandPath MFT プロパティーを参照してください。 重要: 指定された commandPaths のいずれか 1 つのコマンドは、エージェントにコマンドを送信できるリモート・クライアント・システムから効果的に呼び出すことができるため、このプロパティーを設定する際には細心の注意を払ってください。 このためデフォルトでは、commandPath を指定すると以下のようになります。
このプロパティーの値には、環境変数を含めることができます。 詳しくは、 MFT プロパティーでの環境変数の使用 を参照してください。 以下のリリースとの互換性が必要な場合は、addCommandPathToSandbox プロパティーを false に設定することにより、このデフォルト動作をオーバーライドできます。
重要: このオーバーライドにより、クライアントは事実上、任意のコマンドをエージェント・システムに転送してコマンドを呼び出すことができるため、十分に注意して使用する必要があります。
|
なし - どのコマンドも呼び出すことはできません。 |
| addCommandPathToSandbox | commandPath プロパティーで指定されたディレクトリー (およびそれらのすべてのサブディレクトリー) を以下に追加するかどうかを指定します。
これにより、以下のリリースとの互換性が得られます。
|
True |
| additionalWildcardSandboxChecking | エージェントがファイルの転送先/転送元として使用できる場所を制限するために、ユーザー・サンドボックスまたはエージェント・サンドボックスが構成されているエージェントで、ワイルドカード転送に対する追加検査を行うかどうかを指定します。 このプロパティーが true に設定されている場合、追加の検査が有効になります。 転送要求でワイルドカードのファイル・マッチング用に定義されたサンドボックスの外側にある場所の読み取りが試行されると、転送は失敗します。 1 つの転送要求内に複数の転送があり、サンドボックスの外側にある場所を読み取ろうとしたためにこれらの要求のいずれかが失敗した場合、転送全体が失敗します。 検査が失敗した場合は、エラー・メッセージに失敗の理由が示されます ( ワイルドカード転送の追加検査を参照)。 このプロパティーが省略されるか、false に設定されると、ワイルドカード転送で追加の検査は行われません。 |
なし |
| sandboxRoot | サンドボックスを使用する際に組み込むルート・パス・セットおよび除外するルート・パス・セットを指定します。 この機能については、 MFT エージェント・サンドボックスの操作 を参照してください。 パスは、プラットフォーム固有の分離文字で区切ります。 パスの接頭部に感嘆符文字 (!) 文字を付けて、パスをサンドボックスから除外することを示してください。 この機能は、組み込んだルート・パスの下の 1 つのサブディレクトリーを除外する場合に便利です。 sandboxRoot プロパティーは、プロトコル・ブリッジ・エージェントではサポートされません。 sandboxRoot プロパティーと userSandboxes プロパティーを一緒に指定することはできません。 このプロパティーの値には、環境変数を含めることができます。 詳しくは、 MFT プロパティーでの環境変数の使用 を参照してください。 |
なし - サンドボックスなし |
| transferRoot | エージェントに指定された相対パスのデフォルトのルート・ディレクトリー。 このプロパティーの値には、環境変数を含めることができます。 詳しくは、 MFT プロパティーでの環境変数の使用 を参照してください。 |
エージェント・プロセスを開始したユーザーのホーム・ディレクトリー。 |
| transferRootHLQ | エージェントに指定された非完全修飾データ・セットのデフォルトの HLQ (ユーザー ID) | エージェント・プロセスを開始したユーザーのユーザー名。 |
| userSandboxes | 転送を要求するユーザーの MQMD ユーザー名に基づいて、ファイルの転送元や転送先として使用できるファイル・システムの領域を制限します。 詳しくは、 MFT ユーザー・サンドボックスの操作を参照してください。 userSandboxes プロパティーは、プロトコル・ブリッジ・エージェントではサポートされません。 sandboxRoot プロパティーと userSandboxes プロパティーを一緒に指定することはできません。 |
false |
| スケジューラー・プロパティー: | ||
| maxSchedulerRunDelay | エージェントがスケジュール済み転送の検査を待機する最大間隔 (分単位)。 このプロパティーを使用可能にするには、正整数を指定します。 このプロパティーを使用する理由について詳しくは、 スケジュール済みファイル転送が実行されないか遅延した場合の対処法を参照してください。 スケジュール済み転送の実行予定時刻にエージェントがコマンド・キューからコマンドを読み取っている場合があるので、スケジュール済み転送の開始前に追加の遅延が発生する可能性があります。 この場合、スケジューラーはそのコマンドが完了した直後に実行します。 |
-1 |
| セキュリティー・プロパティー: | ||
| agentQMgrAuthenticationCredentialsFile | MQ 接続の資格情報が含まれているファイルへのパス。 |
|
| authorityChecking | MFT エージェント・アクションでのユーザー権限の制限 で説明されているセキュリティー機能を有効にするかどうかを指定します。 inquire 許可は、すべてのエージェント権限キューに対する必須権限です。 |
false |
| logAuthorityChecks | output0.log ファイルで、エージェントのイベント・ログに記録する権限検査ロギングのレベル。 このプロパティーがとることのできる値は None、Failures、または All です。 | なし |
| userIdForClientConnect | IBM MQへのクライアント接続を介してフローされるユーザー ID。 java が指定されている場合、JVM によって報告されるユーザー名は、 IBM MQ 接続要求の一部として渡されます。 このプロパティーがとることのできる値は None または java です。 | なし |
| タイムアウト・プロパティー: | ||
| maxTransferNegotiationTime | 宛先エージェントがネゴシエーションを完了するまで転送が待機する最大時間 (ミリ秒)。 この時間内にネゴシエーションが完了しない場合、転送は再同期状態に置かれ、別の転送が使用可能な場合はその転送を実行できます。 ソース・エージェントまたは宛先エージェントに大きな負荷がかかるシナリオの場合、エージェントが時間内でネゴシエーション要求に対応するには、デフォルト値では小さすぎる可能性があります。 その可能性が特に高いのは、ソース・エージェントに多数のリソース・モニターが定義されている場合、あるいはソース・エージェントのリソース・モニターが大量のファイルを含むディレクトリーをモニターしている場合です。 その一方、数多くの転送要求がエージェントに送信される場合にも、この事態が起こる可能性があります。 そのようなシナリオでは、このプロパティーの値を 200,000 以上に設定しなければならない場合があります。 |
30 000 |
| recoverableTransferRetryInterval | リカバリー可能な転送エラーを検出してから転送の再開を試みるまでの待機時間 (ミリ秒)。 | 60 000 |
| senderTransferRetryInterval | 宛先で既に最大転送数が実行されているために、拒否された転送が再試行されるまで待機する時間 (ミリ秒)。 最小値は 1000 です。 | 30 000 |
| transferAckTimeout | 相手側からの確認応答またはデータを転送が待機して再試行を実行するまでのタイムアウト (ミリ秒単位)。 これは拡張プロパティーであり、ほとんどの Managed File Transfer 構成では、その値を変更する必要はありません。 確認応答は、完全なデータ・ウィンドウが受信されると、常に受信側エージェントから送信側エージェントへ送信されます。 処理能力が制限されている、または信頼性のないネットワークの場合、および agentWindowSize と agentChunkSize の設定値が大きい場合、デフォルト値では十分な長さでない可能性があります。 この場合、エージェント間でデータが不要に再転送されることがあります。 したがって、この値を大きくすることが有効で、ネットワーク速度が遅いために転送がリカバリー・モードになる可能性を減らすことができます。 |
60 000 |
| transferAckTimeoutRetries | エージェントが転送を中止してリカバリー状態に 移行するまで行う、応答のない転送に対する確認応答の最大試行回数。 | 5 |
| xmlConfigReloadInterval | ランタイム中にエージェントが XML 構成ファイルを再ロードする間隔 (秒単位)。 ランタイム中にエージェントが XML 構成ファイルを再ロードしないようにするには、このプロパティーを -1 に設定してください。 このプロパティーによって、以下の XML 構成ファイルが影響を受けます。
|
30 |
| トレースおよびロギング・プロパティー: | ||
| javaCoreTriggerFile | エージェントがモニターするファイルの場所への絶対パス。 指定された場所にファイルが存在する場合、エージェントの開始によって Javacore が起動されます。 エージェントが開始した後、この場所でファイルを更新すると、エージェントは再度 Javacore ファイルを起動します。 別スレッドがこのファイルを 30 秒ごとにポーリングし、ファイルの作成や更新が行われたかどうかを検査します。 前回のポーリング以降にファイルが作成されたか更新された場合、エージェントは以下のディレクトリーのいずれかに Javacore ファイルを生成します。
このプロパティーを指定すると、エージェントは始動時に以下のメッセージを出力します。
このプロパティーの値には、環境変数を含めることができます。 詳しくは、 MFT プロパティーでの環境変数の使用 を参照してください。 |
なし |
| トレース | エージェントの開始時に使用するトレース仕様。 これは、クラスまたはパッケージ (あるいはその両方)、等号文字、およびトレース・レベルのコンマ区切りリストです。 例えば、エージェントの始動時に
com.ibm.wmqfte.agent.Agent クラスと com.ibm.wmqfte.commandhandler パッケージ内のクラスをトレースするには、以下の項目を agent.properties ファイルに追加します。コロン区切りのリストで、複数のトレース仕様を指定できます。 例えば、
特殊トレース仕様
=all は、エージェントと、エージェント・キュー・マネージャーとのすべての通信を処理する Java Message Queuing Interface (JMQI) をトレースするために使用されます。 これを有効にするには、以下のエントリーを
agent.properties ファイルに追加します。IBM サポート担当員が特に指定しない限り、トレース仕様
com.ibm.wmqfte=all を以下のように使用します。 |
なし |
| outputLogFiles | 保持する output.log ファイルの合計数。 この値は、エージェント自体に加えて、エージェントのプロセス・コントローラーにも適用されます。 | 5 |
| outputLogSize | 出力が次のファイルで折り返す前の各 output.log ファイルの最大サイズ (MB 単位)。 この値は、エージェント自体に加えて、エージェントのプロセス・コントローラーにも適用されます。 | 1 |
| outputLogEncoding | エージェントが output.log ファイルを書き込む際に使用する文字エンコード。 | エージェントが実行されているプラットフォームのデフォルトの文字エンコード。 |
| traceFiles | 保持するトレース・ファイルの合計数。 この値は、エージェント自体に加えて、エージェントのプロセス・コントローラーにも適用されます。 | 5 |
| traceSize | トレースが次のファイルで折り返す前の各トレース・ファイルの最大サイズ (MB 単位)。 この値は、エージェント自体に加えて、エージェントのプロセス・コントローラーにも適用されます。 | 20 |
| traceMaxBytes | トレース・ファイルに出力されるメッセージ・データ量の制限。 | 4096 バイト |
| logTransferRecovery | このプロパティーの値を true に設定すると、転送がリカバリー状態になるたびに、診断イベントがエージェントのイベント・ログである output0.log ファイルに報告されます。 | IBM MQ 9.0.0.0 以降の場合、デフォルト値は true です。 |
| logCapture | このエージェントに送信された転送要求メッセージと、エージェントが調整キュー・マネージャーにパブリッシュしたログ・メッセージをキャプチャーします。 キャプチャーされるこれらのメッセージは、転送の問題をデバッグする際に役立ちます。 キャプチャーされたメッセージは、capture?.log という名前のエージェント・ログ・ディレクトリーにあるファイルに保管されます。 ? は数値です。 数値 0 を含むファイルには、キャプチャーされた最新のメッセージが保持されます。 |
false |
| logCaptureFileSize | キャプチャー・ファイルの最大サイズを定義します (メガバイト)。 | 10 |
| logCaptureFiles | 保持されるキャプチャー・ファイルの最大数を定義します。この数を超えると、最も古いファイルが破棄されます。 | 10 |
| logCaptureFilter | エージェントがメッセージのトピック名の突き合わせに使用する Java 正規表現。 この正規表現に一致したメッセージのみキャプチャーされます。 | .* (match all) |
| resourceMonitorLog |
リソース・モニターと、ロギングをオンまたはオフにする操作のキーと値のペア。 指定できる値は以下のとおりです。
以下に例を示します。
リソース・モニター・ログは、 resmoneventN.log という名前のファイルに書き込まれます。ここで、 N は数値を表します。例えば、 resmonevent0.log です。
重要: エージェントのすべてのリソース・モニターは、同じログ・ファイルに書き込みます。 詳しくは、 MFT リソース・モニターのロギング を参照してください。 |
info |
| resourceMonitorLogFileSize |
キャプチャー・ファイルの最大サイズを定義します (メガバイト)。 |
20 |
| resourceMonitorLogFiles |
保持されるキャプチャー・ファイルの最大数を定義します。この数を超えると、最も古いファイルが破棄されます。 |
10 |
| 転送制限プロパティー: | ||
| maxDestinationTransfers | 宛先エージェントが時点を問わず常に一度に処理できる並行転送の最大数。 ここで指定する合計値でカウントされるのは、エージェントに実行依頼されるそれぞれの転送要求です。要求を満たすために転送されるファイルの数は無関係です。 つまり、1 個のファイルを転送する転送要求も、10 個のファイルを転送する転送要求も、同じようにカウントされる、ということです。 宛先エージェントが maxDestinationTransfers プロパティーで指定された制限に達すると、エージェント・キューが転送します。 エージェント・プロパティー値の合計 (maxSourceTransfers + maxDestinationTransfers + maxQueuedTransfers) が状態格納キュー (SYSTEM.FTE.STATE.agent name) の MAXDEPTH 設定の値を超えると、エージェントは開始しません。 |
25 ( Connect:Direct 以外のすべてのエージェントの場合) 5 ( Connect:Direct ブリッジ・エージェントの場合) |
| maxFilesForTransfer | 1 つの管理対象転送に許可される転送項目の最大数。 管理対象転送に含まれる項目数が maxFilesForTransfer の値を上回る場合、管理対象転送は失敗し、それ以降の転送項目は処理されません。 このプロパティーを設定すると、ユーザーが UNIX システムのルート・ディレクトリー「/」の転送を誤って指定した場合など、誤った転送要求により大量のファイルが転送されてしまうのを防ぐことができます。 |
5000 |
| maxSourceTransfers | ソース・エージェントが時点を問わず常に一度に処理できる並行転送の最大数。 ここで指定する合計値でカウントされるのは、エージェントに実行依頼されるそれぞれの転送要求です。要求を満たすために転送されるファイルの数は無関係です。 つまり、1 個のファイルを転送する転送要求も、10 個のファイルを転送する転送要求も、同じようにカウントされる、ということです。 宛先エージェントが maxSourceTransfers プロパティーで指定された制限に達すると、ソース・エージェント・キューが転送します。 エージェント・プロパティー値の合計 (maxSourceTransfers + maxDestinationTransfers + maxQueuedTransfers) が状態格納キュー (SYSTEM.FTE.STATE.agent name) の MAXDEPTH 設定の値を超えると、エージェントは開始しません。 |
25 ( Connect:Direct ブリッジ・エージェント以外のすべてのエージェントの場合) 5 ( Connect:Direct ブリッジ・エージェントの場合) |
| maxQueuedTransfers | エージェントが新しい転送要求を拒否するまでに、ソース・エージェントがキューに入れることができる保留中の転送の最大数。 このプロパティーを設定して、maxDestinationTransfers や maxSourceTransfers が制限に達した場合、あるいは制限を超えた場合でも、その時点で作成した新規の転送要求が受け入れられ、キューに入れられ、後で実行されるようにすることができます。 キューに入れられた転送要求が処理される順序は、その優先順位とキューに入れられている期間の係数です。 古くて、優先順位が高い保留中の転送が最初に選択されます。 長期間キューに入れられている、優先順位が低い転送は、より新しくて優先順位が高い転送に優先して選択されます。 エージェント・プロパティー値の合計 (maxSourceTransfers + maxDestinationTransfers + maxQueuedTransfers) が状態格納キュー (SYSTEM.FTE.STATE.agent name) の MAXDEPTH 設定の値を超えると、エージェントは開始しません。 |
1000 |
| 転送リカバリー・タイムアウト・プロパティー: |
||
| transferRecoveryTimeout |
停止したファイル転送のリカバリーをソース・エージェントが試行し続ける時間 (秒単位) を設定します。 このプロパティーを設定しない場合のエージェントのデフォルトの動作は、転送が正常にリカバリーされるまで試行し続ける動作です。 転送リカバリー・タイムアウト・プロパティーには、以下の値を設定できます。
|
-1 |
| ユーザー出口ルーチン・プロパティー: | ||
| agentForceConsistentPathDelimiters | 転送出口に対して指定するソース・ファイル情報と宛先ファイル情報のパス区切り文字を強制的に UNIX スタイルのスラッシュ (/) にします。有効なオプションは、true と false です。 | false |
| destinationTransferEndExitClasses | 宛先転送ユーザー出口ルーチンを実装するクラスのコンマ区切りリストを指定します。 | デフォルトなし |
| destinationTransferStartExitClasses | 宛先転送開始ユーザー出口ルーチンを実装するクラスのコンマ区切りリストを指定します。 | デフォルトなし |
| exitClassPath | ユーザー出口ルーチンのクラスパスの役割を果たす、プラットフォーム固有のディレクトリーの文字区切りリストを指定します。 エージェントの出口ディレクトリーは、このクラスパスにある項目の前に検索されます。 |
エージェントのexitsディレクトリー |
| exitNativeLibraryPath | ユーザー出口ルーチンのネイティブ・ライブラリー・パスの役割を果たす、プラットフォーム固有のディレクトリーの文字区切りリストを指定します。 | エージェントのexitsディレクトリー |
| ioMaxRecordLength | レコード単位ファイルのサポート可能な最大レコード長 (バイト単位)。 Managed File Transfer は、任意のレコード長を持つレコード単位ファイルへの書き込みをサポートできます。 しかし、レコード長が大きいとメモリー不足エラーになる可能性があるので、このエラーが発生しないように、最大レコード長はデフォルトで 64 K に制限されます。 レコード単位ファイルから読み取る場合は、レコード全体が単一の転送チャンクに収まらなければならないので、レコード長は転送チャンク・サイズによりさらに制限されます。 このプロパティーは入出力ユーザー出口のレコード単位ファイル専用です。 |
64 KB |
| monitorExitClasses | モニター出口ルーチンを実装するクラスのコンマ区切りリストを指定します。 詳しくは、 MFT リソース・モニター・ユーザー出口を参照してください。 | デフォルトなし |
| protocolBridgeCredentialExitClasses | プロトコル・ブリッジ資格情報ユーザー出口ルーチンを実装するクラスのコンマ区切りリストを指定します。 詳しくは、 出口クラスを使用したファイル・サーバーの資格情報のマッピングを参照してください。 | デフォルトなし |
| sourceTransferEndExitClasses | ソース転送終了出口ルーチンを実装するクラスのコンマ区切りリストを指定します。 | デフォルトなし |
| sourceTransferStartExitClasses | ソース転送開始出口ルーチンを実装するクラスのコンマ区切りリストを指定します。 | デフォルトなし |
| IOExitClasses | 入出力ユーザー出口ルーチンを実装するクラスのコンマ区切りリストを指定します。 IOExit インターフェースを実装するクラスのみリストします。つまり、IOExitResourcePath や IOExitChannel などの他の入出力ユーザー出口インターフェースを実装するクラスはリストしないでください。 詳しくは、 MFT 転送入出力ユーザー出口の使用を参照してください。 | デフォルトなし |
| IBM MQ クライアント圧縮: | ||
| agentDataCompression | このプロパティーは、クライアント接続でのみサポートされます。 リモート IBM MQ サーバーとネゴシエーションするための、ファイル・データ転送用の圧縮タイプのコンマ区切りリスト。 これらの圧縮タイプについては、 メッセージ・データ圧縮リストのトピックを参照してください。 これらの値は、妥当性検査後に、エージェントのクライアント・チャネルに (指定されている順序で) プロパティーとしてパススルーされます。 その後、 IBM MQ クライアントは、このクライアント・チャネルとリモート・サーバー・チャネルの間のネゴシエーションを処理して、2 つのチャネルの圧縮プロパティー間で一致する最低限の共通分母を検出します。 一致項目が見つからない場合は、MQCOMPRESS_NONE が常に選択されます。 |
MQCOMPRESS_NONE |
| agentHeaderCompression | このプロパティーは、クライアント接続でのみサポートされます。 リモート IBM MQ サーバーとネゴシエーションするための、ヘッダー・データ転送用の圧縮タイプのコンマ区切りリスト。 受け入れられる値は MQCOMPRESS_NONE または MQCOMPRESS_SYSTEM です。 これらの圧縮タイプに関する情報は、以下のトピックに記載されている：HdrCompList[2] (MQLONG)。 これらの値は、妥当性検査後に、エージェントのクライアント・チャネルに (指定されている順序で) プロパティーとしてパススルーされます。 その後、 IBM MQ クライアントは、このクライアント・チャネルとリモート・サーバー・チャネルの間のネゴシエーションを処理して、2 つのチャネルの圧縮プロパティー間で一致する最低限の共通分母を検出します。 一致項目が見つからない場合は、MQCOMPRESS_NONE が常に選択されます。 |
MQCOMPRESS_NONE |
| z/OS固有: |
||
| adminGroup |
セキュリティー・マネージャー・グループ。 このグループのメンバーは以下を実行できます。
|
なし |
| bpxwdynAllocAdditionalOptions |
Managed File Transfer は、BPXWDYN テキスト・インターフェースを使用して、 z/OS データ・セットを作成し、オープンします。 BPXWDYN がデータ・セット割り振りに使用される場合、 Managed File Transfer はデフォルトで、可能であればデータ・デバイスがマウントされるようにします (ディスク・ベースのデータ・セットの場合は必要ありませんが、テープ・データ・セットの場合は必須です)。 このオプションは特定の環境でサポートされない場合があるので、このプロパティーを使用してこの動作を変更します。 また、データ・セットへの転送時に、コマンド行で BPXWDYN のオプションを指定することもできます。これらのオプションは、このプロパティーで指定したオプションに追加されます。 agent.properties ファイルで bpxwdynAllocAdditionalOptions プロパティーを使用する場合は、一部の BPXWDYN オプションを指定してはなりません。 これらのプロパティーのリストについては、 MFT で使用してはならない BPXWDYN プロパティーを参照してください。 |
デフォルトは以下のとおりです。
|
| armELEMTYPE |
オプションのプロパティー。 エージェントを自動リスタート・マネージャー (ARM) で再始動するように構成する場合は、関連付けられた ARM ポリシー内で指定された ARM ELEMTYPE パラメーター値をこのプロパティーに設定します。 エージェントの場合、ELEMTYPE は SYSBFGAG に設定します。 |
設定なし |
| armELEMENT |
オプションのプロパティー。 エージェントを自動リスタート・マネージャー (ARM) で再始動するように構成する場合は、関連付けられた ARM ポリシー内で指定された ARM ELEMENT パラメーター値をこのプロパティーに設定します。 ELEMENT 値には、エージェント名に対応する値を設定できます。 |
設定なし |
| その他のプロパティー: | ||
| legacyXMLMessageMQMDFormat |
エージェントによって生成される Managed File Transfer XML メッセージ (例えば、ログおよび転送の進行状況メッセージ) が、ブランクの MQMD 形式フィールドとともにキューに送信されるようになりました。 以前のバージョンの製品では、MQMD 形式フィールドを MQSTR (テキスト・メッセージ・ストリング) に設定していました。 このプロパティーを true に設定すると、エージェントによって生成された Managed File Transfer XML メッセージを、MQSTR の MQMD 形式フィールドとともにキューに送信できます。
注: コマンドに対するエージェント応答メッセージは、対応するコマンド要求と一致するメッセージ形式で送信されます。
MQMD 形式フィールドが MQSTR に設定されている場合、データ変換が有効になっている MQ ネットワーク内にチャネルが存在すると、 Managed File Transfer コマンド XML メッセージが破損する可能性があります。 |
false |
![[V9.1.0.5 2020 年 4 月]](ng9105.gif) adjustScheduleTimeForDaylightSaving |
企業が以下のようにスケジュール転送を作成して、毎日スケジュールされた転送を実行しているとします。
例えば、スケジュールされた転送が 1:00 AM に設定されている場合、時計が進むと転送は 2:00 AM に実行され、時計が戻ると転送は 1:00 AM に戻ります。 |
true |
![[UNIX、Linux、Windows]](ngulw.gif)
このファイルの場所と許可については、 ![[Windows]](ngwin.gif)
On ![[UNIX]](ngunix.gif)