fteCreateBridgeAgent(「MFTプロトコルブリッジエージェントの作成と設定)
fteCreateBridgeAgent コマンドは、 Managed File Transfer プロトコル・ブリッジ・エージェントとその関連構成を作成します。 プロトコル・ブリッジ・エージェントは、ファイルを送受信するファイル・サーバーごとに作成します。
![[AIX、Linux、Windows]](../ngalw.gif)
AIX®, Linux®, and Windows システムで、 サーバーのインストールイメージを使用している場合、コマンドを実行するには、次の2つの条件を両方とも満たす必要があります。 IBM® MQ - IBM MQ の管理者になる。
- mqm グループのメンバーである (システムに mqm グループが定義されている場合)。
![[z/OS]](../ngzos.gif)
z/OS® システムでは、コマンドを実行するには、これらの条件のうち少なくとも1つを満たす必要があります- mqm グループのメンバーである (システムに mqm グループが定義されている場合)。
- BFG_GROUP_NAME環境変数で指定されたグループのメンバーになる（グループが指定されている場合）。
- コマンドを実行する際に、BFG_GROUP_NAME環境変数に値が設定されていない。
目的
- SYSTEM.FTE.AUTHADM1。agent_name
- SYSTEM.FTE.AUTHAGT1.エージェント名
- SYSTEM.FTE.AUTHMON1.エージェント名
- SYSTEM.FTE.AUTHOPS1.agent_name (SYSTEM.FTE.AUTHOPS1. agent_name)
- SYSTEM.FTE.AUTHSCH1.エージェント名
- SYSTEM.FTE.AUTHTRN1。agent_name
- SYSTEM.FTE.COMMAND エージェント名
- SYSTEM.FTE.DATA。agent_name
- SYSTEM.FTE.EVENT。agent_name
- SYSTEM.FTE.REPLY エージェント名
- SYSTEM.FTE.STATE エージェント名
- SYSTEM.FTE.HA。agent_name
エージェントを後で削除する場合は、 このコマンドはまた、エージェントが使用するキューをクリアし、続いて削除するために実行する必要がある MQSC コマンドも提供します。 MQSC コマンドは、MQ_DATA_PATH\mqft\config\coordination_qmgr_name\agents\agent_name\agent_name_delete.mqsc にあるファイルに含まれています。
fteCreateBridgeAgent コマンドは、ディレクトリー MQ_DATA_PATH\mqft\config\coordination_qmgr_name\agents\agent_nameに ProtocolBridgeProperties.xml XML ファイルを作成します。
ProtocolBridgeCredentials.xml ファイルは、ユーザーが手動で作成する必要があります。このファイルは fteCreateBridgeAgent コマンドでは作成されなくなりました。
ProtocolBridgeCredentials.xml ファイルには、プロトコル・ブリッジ・エージェントがプロトコル・サーバーに対する権限を自分に与えるために使用するユーザー名および資格情報を定義でき、ProtocolBridgeProperties.xml ファイルには、複数のプロトコル・ファイル・サーバーを定義できるため、複数のエンドポイントに転送可能になります。
MQ_INSTALLATION_PATH/mqft/samples/credentials/ ディレクトリー内にサンプルの ProtocolBridgeCredentials.xml があります。 詳細は、「プロトコルブリッジ認証ファイル形式 」および 「プロトコルブリッジプロパティファイル形式」 を参照してください。
- -ベー
- -ブッツ
- -bm
- -bsl
- -ブフ
- -バッツ
デフォルト・サーバーを指定しない場合、ProtocolBridgeProperties.xml ファイルには項目がありません。転送が実行される前に、手動で少なくとも 1 つのサーバーを追加する必要があります。
Managed File Transfer には、プロトコル・ブリッジ・エージェントの構成に役立つ拡張エージェント・プロパティーが用意されています。 プロトコル・ブリッジに関連するプロパティーは、先頭が protocol になっています。 これらのプロパティーについては、 『agent.properties ファイル』で説明しています。 プロトコル・ブリッジで予期しない動作が発生した場合は、それらの protocol プロパティーがシステムで正しく設定されていることを確認してください。
BFGMQ1007I: The coordination queue manager cannot be contacted or has refused a connection attempt.
The WebSphere MQ reason code was 2058. The agent's presence will not be published.
AIX および Linux Managed File Transfer コマンドでは、ソケット・ファイルを使用して、同じホスト・マシン上で実行されているエージェント・プロセスと通信します。
これらのソケット・ファイルは、エージェントのログ・ディレクトリーに作成され、エージェントが停止すると削除されます。 IBM MQ Managed File Transfer インストール済み環境では、このソケット・ファイルは <MQ_DATA_PATH>/mqft/logs/<COORDINATION_QM_NAME>/agents/<AGENT_NAME>/logs/<AGENT_NAME>@<AGENT_QM_NAME> というファイル・パスで作成されます。ここで、MQ_DATA_PATH はデフォルトで /var/mqm です。
再配布可能エージェントの場合、このソケット・ファイルはディレクトリー <RE_DISTRIBUTABLE_DIRECTORY>/mqft/logs/<COORDINATION_QM_NAME>/agents/<AGENT_NAME>/logs/<AGENT_NAME>@<AGENT_QM_NAME>の下に作成されます。
例えば、エージェント名が SRCAGENT、エージェント・キュー・マネージャー名が SRCAGENTQM、調整キュー・マネージャー名が COORDQM、再配布可能エージェントがディレクトリー /home/myuser/mqmft-redistから実行されている場合、このソケット・ファイルの絶対パスは /home/myuser/mqmft-redist/mqft/logs/COORDQM/agents/SRCAGENT/logs/SRCAGENT@SRCAGENTQM です。
これは、85 文字の合計ファイル・パス長です。
これらのオペレーティング・システムで許可されるソケット・ファイルの最大パス長は 107 文字です。 したがって、エージェントの作成時には、ソケット・ファイル・パスが 107 文字を超えないように注意してください。 これは、エージェントのログ・ディレクトリーを任意のディレクトリー・ロケーションに配置できる再配布可能エージェントでは特に重要です。 fteCreateEnvironment 構成ディレクトリの設定に関する詳細は、コマンドを参照してください。
BFGNV0159E: FFDC を使用してソケット・ファイルにバインドしようとして失敗しました。
特殊文字
特殊文字が含まれているパラメーター値を使用する場合には、予期しない形で特殊文字がコマンド・シェルで解釈されないように注意してください。 例えば、スペース、引用符 (単一または二重)、円記号 (¥)、またはスラッシュ文字などの文字を含む完全修飾ファイル・パスおよび名前は、コマンド自体に直接渡されるのではなく、コマンド・シェルによって解釈される可能性があります。 コマンド・シェルによって文字が解釈されないようにするには、パラメーター全体を二重または単一引用符で囲むか、コマンド・シェルのエスケープ・シーケンスを使用して特殊文字をエスケープします。 Windowsでファイル・パスを指定する場合、セパレーター文字のバックスラッシュ(∕)は必ずダブル・バックスラッシュ(∕)、つまりエスケープされたバックスラッシュ(∕)で入力してください。 または、フォワード・スラッシュ（/）1文字をセパレーターとして使用することもできます。"
Syntax
パラメーター
- --agentName agent_name
- 必須。 作成するエージェントの名前。 エージェント名は管理可能ドメイン内で固有でなければなりません。
- -agentQMgr agent_qmgr_name
- 必須。 エージェントのキュー・マネージャーの名前。
- -bt protocol_file_server_type
- オプション。 デフォルトのプロトコル・ファイル・サーバーを定義することを指定します。 以下のいずれかのオプションを指定します。
- FTP
- 標準 FTP サーバー
- SFTP
- SSH FTP サーバー
- FTPS
- SSL または TLS を使用して保護された FTP サーバー
- -bh server_host_name
- -btパラメーターを使用してデフォルトのプロトコル・ファイル・サーバーも指定する場合にのみ必要です。 プロトコル・ファイル・サーバーの IP ホスト名または IP アドレス。
- -btz server_time_zone
- -btパラメーターも指定する場合にのみ必要です (FTP および FTPS サーバーのみ)。 プロトコル・ファイル・サーバーのタイム・ゾーン。 タイム・ゾーンは地域/ロケーション形式で指定します。 例えば、Europe/London のように指定します。
- -bm server_platform
- -btパラメーターを使用してデフォルトのプロトコル・ファイル・サーバーも指定する場合にのみ必要です。 プロトコル・ファイル・サーバーのプラットフォーム・タイプ。 以下のいずれかのオプションを指定します。
- UNIX
- 汎用 UNIX および Linux プラットフォーム
- WINDOWS
- 汎用 Windows プラットフォーム
- OS400
- IBM iプラットフォーム注: ブリッジ・エージェントが IBM iを実行する FTP サーバーと通信する場合は、 bm パラメーターを OS400 に設定し、 blf パラメーターを OS400IFS に設定する必要があります。
- -bsl server_locale
- -btパラメーターも指定する場合にのみ必要です (FTP および FTPS サーバーのみ)。 プロトコル・ファイル・サーバーのロケール。
xx_XXの形式でロケールを指定します。 例えば、en_GB のように指定します。- xx は、ISO 言語コードです。 有効な値の一覧については、「言語名称の表記のためのコード」 を参照してください
- XX は、ISO 国別コードです。 有効な値の一覧については、「国名とコード要素 」を参照してください
- -bfe server_file_encoding
- -btパラメーターを使用してデフォルトのプロトコル・ファイル・サーバーも指定する場合にのみ必要です。 プロトコル・ファイル・サーバーに保管されるファイルの文字エンコード方式。 例: UTF-8。
- -bts truststore_file
- -btパラメーターを指定する場合は必須です (FTPS サーバーのみ)。 FTPS サーバーによって提示される証明書を妥当性検査するためのトラストストアへのパスを指定します。
- -bp server_port
- オプション。 プロトコル・ファイル・サーバーが接続される IP ポート。 このパラメーターは、プロトコル・ファイル・サーバーがそのプロトコル用のデフォルト・ポートを使用しない場合のみ指定します。 このパラメーターを指定しない場合、 Managed File Transfer はファイル・サーバーのプロトコル・タイプのデフォルト・ポートを使用します。
- -blw
- オプション。 書き込み機能が制限されるようにプロトコル・ファイル・サーバーを定義します。 デフォルトで、プロトコル・ブリッジ・エージェントは、プロトコル・ファイル・サーバーには、ファイルの削除、ファイルの名前変更、および書き込み付加用のファイルのオープンが許可されていることを想定しています。 このパラメーターは、プロトコル・ファイル・サーバーにこれらのファイル・アクションが許可されていないことを示すために指定します。 代わりに、ファイル・サーバーにはファイルの読み書きだけが許可されます。 このパラメーターを指定した場合、転送が中断されたときはそれらの転送はリカバリーできなくなる可能性があり、結果的に実行中のファイル転送が失敗することがあります。
- -blf server_listing_format
- オプション (FTP サーバーおよび FTPS サーバーの場合のみ)。 デフォルトのプロトコル・ファイル・サーバーからリストで返されるファイル情報のサーバー・リスト形式を定義します。 オプションは以下のとおりです。
- UNIX
- 汎用 UNIX および Linux プラットフォーム
- WINDOWS
- 汎用 Windows プラットフォーム
- OS400IFS
- IBM i プラットフォーム上のルート・ファイル・システム注:
- ブリッジ・エージェントがIBM iを実行する FTP サーバーと通信する場合は、bmパラメーターをOS400 に設定し、blfパラメーターを OS400IFS に設定する必要があります。
- Managed File Transfer を使用して、ルート (/) ファイル・システムでのみファイルを送受信できます。 その他のファイル・システムではできません。
- 選択する形式を識別するには、FTP クライアント・プログラムを使用し、ディレクトリーをリスト表示し、最適な形式を選択します。 例えば、
![[UNIX]](../ngunix.gif)
UNIX は、以下のタイプのリストを表示します。-rwxr-xr-x 2 userid groupId 4096 2009-07-23 09:36 filename![[Windows]](../ngwin.gif)
Windows 次のようなリストを表示します437,909 filename![[IBM i]](../ngibmi.gif)
IBM i 次のようなリストを表示しますOS400IFS -rwxrwsrwx 3 USERID 0 8192 Mar 7 08:33 filenameデフォルトは UNIX です。これは、ほとんどのサーバーで使用される形式です。
- -agentQMgrHost agent_qmgr_host
- オプション。 エージェントのキュー・マネージャーのホスト名または IP アドレス。
- -agentQMgrPort agent_qmgr_port
- オプション。 エージェントのキュー・マネージャーとのクライアント接続で使用されるポート番号。
- -agentQMgrChannel agent_qmgr_channel
- オプション。 エージェントのキュー・マネージャーとの接続に使用されるチャネル名。
- -agentDesc agent_description
- オプション。 エージェントの説明。これは、 IBM MQ Explorerに表示されます。
- -ac または -authorityChecking
- オプション。 このパラメーターは、権限検査を有効にします。 このパラメーターを指定すると、 エージェントは、要求を実行依頼しているユーザーにその要求アクションの実行権限があることを検査します。 詳しくは、 MFT エージェント・アクションでのユーザー権限の制限を参照してください。
- - s service_name
- オプション (Windows のみ)。 エージェントを Windows サービスとして実行するように指示します。 service_name を指定しない場合、サービスの名前は
mqmftAgentAGENTQMGRになります。ここで、AGENT はエージェント名、QMGR はエージェント・キュー・マネージャー名です。 - - su user_name
- オプション (Windows のみ)。 エージェントが Windows サービスとして実行される場合、このパラメーターは、サービスが実行されるアカウントの名前を指定しま
す。 Windowsドメイン・ユーザー・アカウントを使用してエージェントを実行するには、
DomainName\UserNameの形式で値を指定します。 ローカル組み込みドメインのアカウントを使用してサービスを実行するには、UserNameの形式で値を指定します。 - - sp パスワード
- オプション (Windows のみ)。 -suパラメーターによって設定されたユーザー・アカウントのパスワード。
- - sjオプション
- オプション (Windows のみ)。 エージェントが Windows サービスとして開始される場合は、JVM に渡されるオプションのリストを -D または -X の形式で定義します。 オプションは、番号記号 (#) またはセミコロン (;) 文字を使用して区切られます。 # またはセミコロン (;) 文字を組み込む必要がある場合は、それらを単一引用符で囲みます。
- - slオプション
- オプション (Windows のみ)。 Windows サービスのログ・レベルを設定します。 有効なオプションは、 error、 info、 warn、 debugです。 デフォルトは info です。 このオプションは、Windows サービスに関して問題が発生した場合に便利です。 これを debug に設定すると、より詳細な情報がサービス・ログ・ファイルに記録されます。
- -n
- オプション (Windows のみ)。 エージェントを通常のプロセスとして実行するように指示します。 これは、-sオプションと同時に指定することはできません。 -sパラメーターと-nパラメーターのどちらも指定されていない場合、エージェントは通常のWindowsプロセスとして構成されます。
- -p configuration_options
- オプション。 このパラメーターは、エージェントを作成するために使用される構成オプションのセットを決定します。 慣例として、このパラメーターの入力には、デフォルト調整キュー・マネージャー以外の名前を使用します。 これで、fteCreateBridgeAgent コマンドは、デフォルト以外の調整キュー・マネージャーと関連付けられたプロパティー・ファイルのセットを使用します。
- -f
- オプション。 コマンドに強制的に既存の構成を上書きさせます。
- -htz
- オプション。 -btzパラメーターの入力として使用できる、サポートされる時間帯のリストを表示します。
- -hcs
- オプション。 -bfeパラメーターの入力として使用できる、サポートされる文字セットのリストを表示します。
- -mquserid ユーザー ID
- オプション。 コマンド・キュー・マネージャーで認証するユーザー ID を指定します。
- -mqpassword パスワード
- オプション。 調整キュー・マネージャーで認証するパスワードを指定します。
- -mqpassword パラメーターを指定する場合は、 -mquserid パラメーターも指定する必要があります。 -mquseridを指定し、 -mqpasswordを指定しない場合は、関連付けられたパスワードを入力するように求めるプロンプトが出されますが、これは表示されません。
![[MQ 9.3.0 Jun 2022]](../ng930cd.gif)
![[MQ 9.3.0 Jun 2022]](../ng930.gif)
IBM MQ 9.3 以降、コマンドは MQCSP認証を使用するようデフォルト設定され、認証対象のユーザーIDとパスワードをMQCSP構造のキューマネージャに送信します。 - -ノルプウ
- オプション。 12 文字を超えるパスワードをサポートしないキュー・マネージャーにコマンドが接続する場合は、このパラメーターを指定します。
- -credentialsFile file_path
- オプション。 IBM MQ 認証の詳細が追加される既存または新規の資格情報ファイルの絶対ファイル・パス。
- -userid username
- オプション。 資格情報の詳細を関連付けるために使用するユーザー ID。 ユーザー ID を指定しない場合、資格情報の詳細はすべてのユーザーに適用されます。 -credentialsFileパラメーターも指定する必要があります。
- - ? または -h
- オプション。 コマンド構文を表示します。
- -x
- オプション。 高可用性モードで実行するエージェント構成を作成します。
例
以下の例では、エージェント・キュー・マネージャー QM_ACCOUNTS を使用して新規のプロトコル・ブリッジ・エージェント ACCOUNTS1 が作成され、このエージェントはデフォルトの調整キュー・マネージャーを使用します。 ACCOUNTS1 は、FTP サーバー accountshost.ibm.com に接続します。 この FTP サーバーは、タイム・ゾーン Europe/Berlin、ロケール de_DE、ファイル・エンコード方式 UTF-8 を使用して、Windows 上で稼働します。 再接続の再試行回数は 4 回です。fteCreateBridgeAgent -agentName ACCOUNTS1 -agentQMgr QM_ACCOUNTS -bt FTP
-bh accountshost.ibm.com -bm WINDOWS -btz Europe/Berlin -bsl de_DE -bfe UTF8
-agentQMgrHost myhost.ibm.com -agentQMgrPort 1415 -agentQMgrChannel CHANNEL1
fteCreateBridgeAgent -agentName ACCOUNTS2 -agentQMgr QM_ACCOUNTSfteCreateTransfer -rt -1 -sa SRC -sm MFTQM -da OS400FTP -dm MFTQM -dce 37 -sce 1252
-t text -de overwrite -df "<your-domain>:/home/mft/text/uploadwcp.log"
"C:\temp\os400\Text\uploadwcp.log"fteCreateTransfer -rt -1 -da SRC -dm MFTQM -sa OS400FTP -sm MFTQM -sce 37 -dce 1252
-t text -de overwrite -df "C:\temp\os400\Text\downloadwcp.log"
"<your-domain>:/home/mft/text/uploadwcp.log"追加のカスタマイズ
- bt パラメーター (および必要な追加パラメーター) を使用した場合、ProtocolBridgeProperties.xml ファイルにデフォルトのサーバー名が表示されます。
FTPサーバーを追加したり、資格情報ファイルの場所を変更したりする場合は、 ProtocolBridgeProperties.xmlファイルを使用したプロトコル・ファイル・サーバーのプロパティの定義を参照してください。
戻りコード
- 0
- コマンドは正常に完了しました。
- 1
- コマンドは失敗しました。
プロトコル・ブリッジ・エージェントを開始するには、fteStartAgent コマンドを使用します。 詳細については、 fteStartAgent （MFTエージェントの起動 ）を参照してください。 z/OS の「MFT エージェントの起動 」も参照してください。