fteStopAgent(「MFTエージェントを停止する)

目的

fteStopAgent コマンドを使用してエージェントを停止すると、停止する前にエージェントが現行のファイル転送を完了することや、エージェントが現在ファイルを転送中であってもエージェントを即時に停止することができます。 エージェントが停止してしまうと、再始動するまでそのエージェントを使用してファイルを転送することはできません。

停止するエージェントが IBM® MQ ネットワークに接続されている場合は、 IBM MQ ネットワークに接続してエージェント・キュー・マネージャーに経路指定できる任意のシステムから fteStopAgent コマンドを実行できます。 具体的には、このコマンドを実行する場合、このシステムに Managed File Transfer コンポーネント (Service またはエージェント) をインストールし、IBM MQ ネットワークと通信するように構成しておく必要があります。 接続の詳細を使用できない場合は、ローカル・システムのデフォルト・キュー・マネージャーに対してバインディング・モードで接続されます。 command.propertiesが存在しない場合は、エラーが生成されます。

停止するエージェントが IBM MQ ネットワークに接続されていない場合 (例えば、 IBM MQ ネットワークが現在使用可能でない場合) は、エージェントが実行されているシステムからのみ fteStopAgent コマンドを実行できます。 IBM MQ ネットワークに接続されていないエージェントを停止するには、エージェントを実行しているユーザーと同じユーザーから fteStopAgent コマンドを実行する必要があります。 または、そのエージェントが Windows システムで実行されている場合には、このコマンドを管理者として実行することもできます。

デフォルト・セットとは異なる構成オプションのセットを使用する場合にのみ、このコマンドにオプションの-pパラメーターを指定してください。 詳しくは、MFTagent.propertiesファイルを参照してください。

エージェントが Windows サービスとして実行されている場合、 fteStopAgent コマンドを実行すると Windows サービスが停止します。 詳しくは、 Windows サービスとしての MFT エージェントの開始を参照してください。

パラメーター

-m agent_qmgr_name

オプション。 停止するエージェントの接続先のキュー・マネージャーの名前。

エージェントがリモート・システム上にある場合、またはエージェントがローカル・システム上にあるがエージェントを開始したユーザーではない場合は、-mパラメーターを使用し、適切な権限を持っている必要があります。 権限について詳しくは、 MFT固有のリソースに対するグループ権限の制限を参照してください。

-p configuration_options

オプション。 このパラメーターは、エージェントを停止する要求を発行するために使用される構成オプションのセットを決定します。 このパラメーターの入力には、デフォルト調整キュー・マネージャー以外の名前を使用します。 これで、コマンドは、デフォルト以外の調整キュー・マネージャーと関連付けられたプロパティー・ファイルのセットを使用します。

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

-i

オプション。 即時にエージェントを停止します。 エージェントは、現在進行中の転送を完了しません。

-iパラメーターを指定しない場合、エージェントは現在進行中の転送をすべて完了しますが、新しい転送は開始しません。

-mquserid ユーザー ID

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

-mqpassword パスワード

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

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

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

-ノルプウ

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

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

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

agent_name

必須。 停止する Managed File Transfer エージェントの名前を指定します。

- ? または -h

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

戻りコード

0

コマンドは正常に完了しました。

1

コマンドは失敗しました。