fteCreateCDAgent(「Connect:Directブリッジエージェントを作成する)

fteCreateCDAgent コマンドは、 Managed File Transfer Agent、および Connect:Direct® ブリッジのための関連する構成を作成します。

重要:
[AIX、Linux、Windows] AIX®, Linux®, and Windows システムで、 サーバーのインストールイメージを使用している場合、コマンドを実行するには、次の2つの条件を両方とも満たす必要があります。 IBM® MQ
  • IBM MQ の管理者になる。
  • mqm グループのメンバーである (システムに mqm グループが定義されている場合)。
そうでない場合は、エラーメッセージが表示されます。BFGCL0502E: You are not authorized to perform the requested operationこの制限は、 Redistributable Managed File Transfer Agent アーカイブを使用している場合は適用されません。
[z/OS] z/OS® システムでは、コマンドを実行するには、これらの条件のうち少なくとも1つを満たす必要があります
  • mqm グループのメンバーである (システムに mqm グループが定義されている場合)。
  • BFG_GROUP_NAME環境変数で指定されたグループのメンバーになる（グループが指定されている場合）。
  • コマンドを実行する際に、BFG_GROUP_NAME環境変数に値が設定されていない。

目的

fteCreateCDAgent コマンドを使用して、 Connect:Direct ブリッジ・エージェントを作成します。 このタイプのエージェントは、 Connect:Direct ノードとの間のファイル転送専用です。 詳しくは、 Connect:Direct ブリッジを参照してください。 Connect:Direct ブリッジでサポートされているオペレーティングシステムのバージョンについては、 IBM MQ のシステム要件のウェブページをご覧ください。

このコマンドは MQSC コマンドを提供します。これをエージェントのキュー・マネージャーに対して実行し、以下のエージェント・キューを作成する必要があります。
  • 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 エージェント名

これらのキューは、内部システム・キューであるため、エージェントを削除しない限り、メッセージの変更、削除、または読み取りを行うことはできません。 実行する MQSC コマンドは、MQ_DATA_PATH\mqft\config\coordination_qmgr_name\agents\agent_name\agent_name_create.mqsc にあるファイルでも提供されます。

エージェントを後で削除する場合は、 このコマンドはまた、エージェントに属するキューをクリアし、続いて削除するために実行する 必要がある MQSC コマンドも提供します。 MQSC コマンドは、MQ_DATA_PATH\mqft\config\coordination_qmgr_name\agents\agent_name\agent_name_delete.mqsc にあるファイルに含まれています。

Managed File Transfer には、エージェントの構成に役立つ拡張エージェント・プロパティーが用意されています。 これらのプロパティーについては、MFT agent.properties ファイルを参照してください。

fteCreateCDAgent コマンドは、エージェントのプロパティー・ディレクトリーに 2 つの XML ファイルを作成します。 ConnectDirectNodeProperties.xml、 これは、転送内のリモート・ノードに関する情報を定義するために使用され、ConnectDirectProcessDefinitions.xmlは、転送によって開始されるユーザー定義のConnect:Directプロセスを指定するために使用されます。

Connect:Direct ブリッジ・エージェントが Connect:Direct ノードへの接続に使用するユーザー名とパスワードを定義するには、手動で ConnectDirectCredentials.xml ファイルを作成する必要があります。 XML ファイルのサンプルは MQ_INSTALLATION_PATH/mqft/samples/credentials/にあります。 詳細および例については、 Connect:Direct の認証ファイル形式を参照してください。

重要:

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 構成ディレクトリの設定に関する詳細は、コマンドを参照してください。

エージェントを開始した場合、またはエージェントに接続する他のコマンドを実行した場合に、パスの長さが 107 文字を超えると、以下のメッセージを受け取ります。
BFGNV0159E: FFDC を使用してソケット・ファイルにバインドしようとして失敗しました。

特殊文字

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

fteCreateCDAgent

Read syntax diagramSkip visual syntax diagramfteCreateCDAgent-agentName agent_name-agentQMgr agent_qmgr_name-cdNodecd_node_name -agentQMgrHostagent_qmgr_host-agentQMgrPortagent_qmgr_port-agentQMgrChannelagent_qmgr_channel-agentDescagent_description-ac-authorityChecking-pconfiguration_options-f-cdNodeHostcd_node_host-cdNodePortcd_node_port-cdTmpDircd_tmp_dir-sservice_name-suuser_name-sppassword-sjoptions-sloptions-n-mquseriduser_id-nolpw-mqpasswordpassword-nolpw-credentialsFilefile_path-useridusername

パラメーター

--agentName agent_name
必須。 作成するエージェントの名前。 エージェント名は、その調整キュー・マネージャーに対して固有である必要があります。
エージェントの命名について詳しくは、 オブジェクトの命名規則を参照してください。
-agentQMgr agent_qmgr_name
必須。 エージェントのキュー・マネージャーの名前。
--cdNode cd_node_name
必須。 このエージェントから宛先 Connect:Direct ノードにメッセージを転送するために使用する Connect:Direct ノードの名前。 このパラメーターの値はロギングに使用され、接続先のノードを Connect:Direct ブリッジ・エージェントに指定するためには使用されません。 -cdNodeHostおよび-cdNodePortの値は、Connect:Directブリッジの一部であるConnect:Directノードを指定します。
-agentQMgrHost agent_qmgr_host
オプション。 エージェントのキュー・マネージャーのホスト名または IP アドレス。
-agentQMgrPort agent_qmgr_port
オプション。 エージェントのキュー・マネージャーとのクライアント接続で使用されるポート番号。
-agentQMgrChannel agent_qmgr_channel
オプション。 エージェントのキュー・マネージャーとの接続に使用されるチャネル名。
-agentDesc agent_description
オプション。 エージェントの説明。 IBM MQ Explorerに表示されます。
-ac または -authorityChecking
オプション。 このパラメーターは、権限検査を有効にします。 このパラメーターを指定すると、 エージェントは、要求を実行依頼しているユーザーにその要求アクションの実行権限があることを検査します。 詳しくは、 MFT エージェント・アクションでのユーザー権限の制限を参照してください。
-p configuration_options
オプション。 このパラメーターは、エージェントを作成するために使用される構成オプションのセットを決定します。 慣例として、このパラメーターの入力には、デフォルト調整キュー・マネージャー以外の名前を使用します。 その後、 fteCreateCDAgent コマンドは、このデフォルト以外の調整キュー・マネージャーに関連付けられたプロパティー・ファイルのセットを使用します。

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

-f
オプション。 コマンドに強制的に、既存の一致しないパラメーターを上書きさせます。 このパラメーターを指定しても、既存の Windows サービス・エージェントが強制的に置換されることはありません。
--cdNodeHost cd_node_host_name
オプション。 -cdNodeパラメーターで指定された、Connect:Directノードが配置されているシステムのホスト名または IP アドレス。 -cdNodeHostパラメーターを指定しない場合は、ローカル・システムのホスト名または IP アドレスのデフォルトが使用されます。
ほとんどの場合、 Connect:Direct ノードは Connect:Direct ブリッジ・エージェントと同じシステム上にあります。 その場合、このプロパティーのデフォルト値 (ローカル・システムの IP アドレス) は適正です。 システムに複数の IP アドレスがある場合、または Connect:Direct ノードが Connect:Direct ブリッジ・エージェントとは異なるシステム上にあり、それらのシステムがファイル・システムを共有する場合は、このプロパティーを使用して、 Connect:Direct ノードの正しいホスト名を指定します。
--cdNodePort cd_node_port_name
オプション。 -cdNodeパラメーターで指定されたノードと通信するためにクライアント・アプリケーションが使用するConnect:Directノードのポート番号。 Connect:Direct 製品資料では、このポートは API ポートと呼ばれます。 -cdNodePortパラメーターを指定しない場合は、デフォルトのポート番号 1363 が想定されます。
--cdTmpDir cd_tmp_directory
オプション。 宛先 Connect:Direct ノードに転送される前に、このエージェントがファイルを一時的に保管するために使用するディレクトリー。 このパラメーターは、ファイルが一時的に保管されるディレクトリーの絶対パスを指定します。 例えば、cdTmpDirが/tmpに設定されている場合、ファイルは一時的に/tmpディレクトリーに配置されます。 -cdTmpDirパラメーターを指定しない場合、ファイルは一時的にcdbridge-agent_nameという名前のディレクトリーに保管されます。 このデフォルト・ディレクトリーは、java.io.tmpdirプロパティーの値によって定義された場所に作成されます。

Connect:Direct ブリッジ・エージェントと Connect:Direct ブリッジ・ノードは、同じパス名を使用して、このパラメーターで指定されたディレクトリーにアクセスできなければなりません。 Connect:Direct ブリッジのインストールを計画する際には、この点を考慮してください。 可能な場合は、 Connect:Direct ブリッジの一部である Connect:Direct ノードが配置されているシステム上にエージェントを作成します。 エージェントとノードが別個のシステム上にある場合は、ディレクトリーが共有ファイル・システム上にあり、両方のシステムから同じパス名を使用してアクセスできる必要があります。 サポートされる構成について詳しくは、 Connect:Direct ブリッジを参照してください。

注: fteCleanAgent コマンドを実行すると、このディレクトリー内のすべてのファイルが削除されます。
[Windows]- s service_name
オプション (Windows のみ)。 エージェントを Windows サービスとして実行するように指示し、Windows 管理者ユーザー ID からコマンドを実行する必要があります。 service_name を指定しない場合、サービスの名前はmqmftAgentAGENTQMGRになります。ここで、エージェントはエージェント名、QMGR はエージェント・キュー・マネージャー名です。
[Windows]- su user_name
オプション (Windows のみ)。 エージェントが Windows サービスとして実行される場合、このパラメーターは、サービスが実行されるアカウントの名前を指定しま す。 Windowsドメイン・ユーザー・アカウントを使用してエージェントを実行するには、DomainName\UserNameの形式で値を指定します。 ローカル組み込みドメインのアカウントを使用してサービスを実行するには、UserNameの形式で値を指定します。
[Windows]- sp パスワード
オプション (Windows のみ)。
[Windows]- sjオプション
オプション (Windows のみ)。 エージェントが Windows サービスとして開始される場合は、JVM に渡されるオプションのリストを -D または -X の形式で定義します。 オプションは、番号記号 (#) またはセミコロン (;) 文字を使用して区切られます。 # またはセミコロン (;) 文字を組み込む必要がある場合は、それらを単一引用符で囲みます。
[Windows]- slオプション
オプション (Windows のみ)。 Windows サービスのログ・レベルを設定します。 有効なオプションは、 error、 info、 warn、 debugです。 デフォルトは info です。 このオプションは、Windows サービスに関して問題が発生した場合に便利です。 これを debug に設定すると、より詳細な情報がサービス・ログ・ファイルに記録されます。
[Windows]-n
オプション (Windows のみ)。 エージェントを通常のプロセスとして実行するように指示します。 これは、-sオプションと同時に指定することはできません。 -sパラメーターと-nパラメーターのどちらも指定されていない場合、エージェントは通常のWindowsプロセスとして構成されます。
-mquserid ユーザー ID
オプション。 コマンド・キュー・マネージャーで認証するユーザー ID を指定します。
-mqpassword パスワード
オプション。 調整キュー・マネージャーで認証するパスワードを指定します。
-mqpassword パラメーターを指定する場合は、 -mquserid パラメーターも指定する必要があります。 -mquseridを指定し、 -mqpasswordを指定しない場合は、関連付けられたパスワードを入力するように求めるプロンプトが出されますが、これは表示されません。

[MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022] IBM MQ 9.3 以降、コマンドはデフォルトで MQCSP認証を使用し、認証対象のユーザーIDとパスワードをMQCSP構造のキューマネージャに送信します。

[MQ 9.3.0 Jun 2022][MQ 9.3.0 Jun 2022]-ノルプウ
オプション。 12 文字を超えるパスワードをサポートしないキュー・マネージャーにコマンドが接続する場合は、このパラメーターを指定します。
-nolpw パラメーターを指定する場合は、 -mquserid パラメーターも指定する必要があります。 -mquserid および -nolpwを指定し、 -mqpasswordを指定しない場合は、関連付けられたパスワードを入力するように求めるプロンプトが出されますが、これは表示されません。
注: -nolpw オプションを指定し、パスワードが 12 文字より長い場合、コマンドは失敗し、エラー・メッセージ BFGCL0829Eが表示されます。
-credentialsFile file_path
オプション。 IBM MQ 認証の詳細が追加される既存または新規の資格情報ファイルの絶対ファイル・パス。
このコマンドは、指定されたManaged File Transfer資格情報ファイルへの一連のIBM MQ認証詳細の追加をサポートします。 このコマンドは、 IBM MQ 接続認証が有効になっている場合に使用します。 既存の詳細を更新する場合は、-fforce パラメーターを使用する必要があります。
-userid username
オプション。 資格情報の詳細を関連付けるために使用するユーザー ID。 ユーザー ID を指定しない場合、資格情報の詳細はすべてのユーザーに適用されます。 -credentialsFileパラメーターも指定する必要があります。

例

この例では、エージェント・キュー・マネージャー QM_NEPTUNE を使用して、新しい Connect:Direct ブリッジ・エージェント CD_BRIDGE が作成されます。 エージェントは、 Connect:Direct ノード BRIDGE_NODE を使用して、ファイルを他の Connect:Direct ノードに転送します。 BRIDGE_NODE ノードはエージェントと同じシステムにあり、デフォルトのポートをクライアント接続で使用します。 Connect:Direct を転送元または転送先として転送されるファイルは、/tmp/cd-bridge ディレクトリーに一時的に保管されます。
fteCreateCDAgent -agentName CD_BRIDGE -agentQMgr QM_NEPTUNE 
                 -cdNode BRIDGE_NODE -cdTmpDir /tmp/cd-bridge

戻りコード

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