fteCreateAgent(MFTエージェントを作成)

fteCreateAgent コマンドは、 Managed File Transfer Agent とそれに関連する構成を作成します。

エージェントへのアクセスを制御することができます。 詳しくは、 MFT エージェント・アクションでのユーザー権限の制限 を参照してください。 -acパラメーターを使用して、いくつかのキューにアクセスする権限を付与する必要があります。

重要:
[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環境変数に値が設定されていない。

目的

fteCreateAgent コマンドは、エージェントを作成するために使用します。 このコマンドは 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 エージェント名
  • [MQ 9.2.0 Jul 2020]SYSTEM.FTE.HA エージェント名
これらのキューは、内部システム・キューであるため、エージェントを削除しない限り、メッセージの変更、削除、または読み取りを行うことはできません。 実行する 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 には、エージェントの構成に役立つ拡張エージェント・プロパティーが用意されています。 これらのプロパティーについては、 agent.properties ファイルで説明されています。

エージェントを操作するために、MQMFTCredentials.xml資格情報ファイルを作成しなければならない可能性があります。 このファイルのサンプルは MQ_INSTALLATION_PATH/mqft/samples/credentials/ 内にあります。 詳細および例については、 MFT資格情報ファイル形式を参照のこと。

重要:

UNIX プラットフォームと 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 を使用してソケット・ファイルにバインドしようとして失敗しました。

特殊文字

特殊文字が含まれているパラメーター値を使用する場合には、予期しない形で特殊文字がコマンド・シェルで解釈されないように注意してください。 例えば、スペース、引用符 (単一または二重)、スラッシュ、バックスラッシュ文字などを含む完全修飾ファイル・パスや名前は、直接コマンド自体に渡されずに、コマンド・シェルで解釈されてしまう可能性があります。 文字がコマンド・シェルによって解釈される動作を回避するには、パラメーター全体を二重/単一引用符で囲むか、またはコマンド・シェルのエスケープ・シーケンスを使用して特殊文字をエスケープします。

Syntax

fteCreateAgent

Read syntax diagramSkip visual syntax diagramfteCreateAgent-agentName agent_name -agentQMgr agent_qmgr_name -agentQMgrHost agent_qmgr_host-agentQMgrPort agent_qmgr_port-agentQMgrChannel agent_qmgr_channel-agentDesc agent_description-ac-authorityChecking-s service_name-su user_name -sp password-sj options-sl options -n-mquseriduser_id-mqpasswordpassword-credentialsFilefile_path-p configuration_options -f-x

パラメーター

--agentName agent_name
必須。 作成するエージェントの名前。 エージェント名は、その調整キュー・マネージャーに対して固有である必要があります。
エージェントの命名について詳しくは、 オブジェクトの命名規則を参照してください。
-agentQMgr agent_qmgr_name
必須。 エージェントのキュー・マネージャーの名前。
-agentQMgrHost agent_qmgr_host
オプション。 エージェントのキュー・マネージャーのホスト名または IP アドレス。
-agentQMgrPort agent_qmgr_port
オプション。 エージェントのキュー・マネージャーとのクライアント接続で使用されるポート番号。
-agentQMgrChannel agent_qmgr_channel
オプション。 エージェントのキュー・マネージャーとの接続に使用されるチャネル名。
-agentDesc agent_description
オプション。 エージェントの説明。 IBM MQ Explorerに表示されます。
-ac または -authorityChecking
オプション。 このパラメーターは、権限検査を有効にします。 このパラメーターを指定すると、 エージェントは、要求を実行依頼しているユーザーにその要求アクションの実行権限があることを検査します。 詳しくは、 MFT エージェント・アクションでのユーザー権限の制限を参照してください。
[Windows]- サービス名
オプション (Windows のみ)。 エージェントを Windows サービスとして実行するように指示し、Windows 管理者ユーザー ID からコマンドを実行する必要があります。 service_name を指定しない場合、サービスの名前はmqmftAgentAGENTQMGRになります。ここで、エージェントはエージェント名、QMGR はエージェント・キュー・マネージャー名です。
Windows の「サービス」ウィンドウの「名前」列に示されるサービスの表示名は、常に「Managed File Transfer Agent AGENT@QMGR」です。
注: 再配布可能エージェントを Windows サービスとして実行する場合、サービスを機能させるには、システム環境で BFG_DATA 環境変数を設定する必要があります。
[Windows]-su ユーザー名
オプション (Windows のみ)。 エージェントが Windows サービスとして実行される場合、このパラメーターは、サービスが実行されるアカウントの名前を指定しま す。 Windowsドメイン・ユーザー・アカウントを使用してエージェントを実行するには、DomainName\UserNameの形式で値を指定します。 ローカル組み込みドメインのアカウントを使用してサービスを実行するには、UserNameの形式で値を指定します。
-suパラメーターを使用して指定するWindowsユーザー・アカウントには、Log on as a service権限が必要です。 この権限を付与する方法については、 MFT エージェントまたはロガーを Windows サービスとして実行するためのガイダンスを参照してください。
-sが指定されている場合は必須です。
[Windows]-sp パスワード
オプション (Windows のみ)。
このパラメーターは、-sが指定されている場合にのみ有効です。 -sパラメーターを指定するときにこのパラメーターを指定しないと、警告メッセージが生成されます。 このメッセージは、サービスを正常に開始するには、Windows サービス・ツールを使用してパスワードを設定する必要があることを警告します。
[Windows]-sj オプション
オプション (Windows のみ)。 エージェントが Windows サービスとして開始される場合は、JVM に渡されるオプションのリストを -D または -X の形式で定義します。 オプションは、番号記号 (#) またはセミコロン (;) 文字を使用して区切られます。 # またはセミコロン (;) 文字を組み込む必要がある場合は、それらを単一引用符で囲みます。
このパラメーターは、-sが指定されている場合にのみ有効です。
[Windows]-sl オプション
オプション (Windows のみ)。 Windows サービスのログ・レベルを設定します。 有効なオプションは、 error、 info、 warn、 debugです。 デフォルトは info です。 このオプションは、Windows サービスに関して問題が発生した場合に便利です。 これを debug に設定すると、より詳細な情報がサービス・ログ・ファイルに記録されます。
このパラメーターは、-sが指定されている場合にのみ有効です。
[Windows]-n
オプション (Windows のみ)。 エージェントを通常のプロセスとして実行するように指示します。 これは、-sオプションと同時に指定することはできません。 -sパラメーターと-nパラメーターのどちらも指定されていない場合、エージェントは通常のWindowsプロセスとして構成されます。
-p configuration_options
オプション。 このパラメーターは、エージェントを作成するために使用される構成オプションのセットを決定します。 慣例として、このパラメーターの入力には、デフォルト調整キュー・マネージャー以外の名前を使用します。 その後、 fteCreateAgent コマンドは、このデフォルト以外の調整キュー・マネージャーに関連付けられたプロパティー・ファイルのセットを使用します。

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

-mquserid ユーザー ID
オプション。 調整キュー・マネージャーで認証するユーザー ID を指定します。
-mqpassword パスワード
オプション。 調整キュー・マネージャーで認証するパスワードを指定します。 -mquseridパラメーターも指定する必要があります。 -mquseridを指定し、-mqpasswordを指定しない場合は、関連付けられたパスワードの入力を求めるプロンプトが出されます。 パスワードは表示されません。
-credentialsFile file_path
オプション。 IBM MQ 認証の詳細が追加される既存または新規の資格情報ファイルの絶対ファイル・パス。
このコマンドは、指定されたManaged File Transfer資格情報ファイルへの一連のIBM MQ認証詳細の追加をサポートします。 このコマンドは、 IBM MQ 接続認証が有効になっている場合に使用します。 既存の詳細を更新する場合は、-fforce パラメーターを使用する必要があります。
-credentialPath credentials_path.
このコマンドは、資格情報のマイグレーション先の場所を定義します。 このパラメーターは、既存の資格情報ファイルのディレクトリー・パスとするか、または新しい資格情報ファイルのディレクトリー・パスとすることができます。 [z/OS]プラットフォームでは z/OS プラットフォームでは、クレデンシャル・ファイルは既存のパーティショ ン・データセット拡張（PDSE）にすることができる。 PDSE には、資格情報ファイルの既存のメンバーまたは新規メンバーを含めることができます。 PDSE の既存のメンバーは、資格情報ファイルを含めるように更新されている必要があります。 PDSE の形式は可変ブロックでなければなりません。
-f
オプション。 コマンドに強制的に、既存の一致しないパラメーターを上書きさせます。 このパラメーターを指定しても、既存の Windows サービス・エージェントが強制的に置換されることはありません。
- ? または -h
オプション。 コマンド構文を表示します。
[MQ 9.2.0 Jul 2020]-x
オプション。 高可用性モードで実行するエージェント構成を作成します。
このパラメーターを指定すると、新規オプション highlyAvailable が agent.properties ファイルに追加されます。

例

以下の例では、エージェント・キュー・マネージャー QM_NEPTUNE を使用して AGENT3 が作成され、それはデフォルトの調整キュー・マネージャーを使用します。
fteCreateAgent -agentName AGENT3 -agentQMgr QM_NEPTUNE
 -agentQMgrHost myhost.ibm.com -agentQMgrPort 1415 -agentQMgrChannel CHANNEL1
[MQ 9.2.0 Jul 2020]この例では、 AGHA がエージェント・キュー・マネージャ QMHA と共に高可用性モードで作成されている。
fteCreateAgent -agentName AGHA -agentQMgr QMHA -x

戻りコード

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