fteCancelTransfer（'MFT転送をキャンセルする）

fteCancelTransfer コマンドは、 Managed File Transfer 転送を取り消すために使用します。 このコマンドは、転送のソース・エージェントまたは宛先エージェントに対して発行できます。

目的

転送の進行中に fteCancelTransfer コマンドを発行した場合、その転送の一部として既に転送されたファイルは宛先システムに残り、削除されません。 その転送の一部として部分的に転送されたファイルは、宛先システムからすべて削除されます。 転送の宛先側では、その転送が「取り消し済み」としてログに記録されます。

Connect:Direct® ノードへの転送が取り消された場合、取り消された転送の一部として部分的に転送されたファイルは宛先システムに残り、削除されません。

fteCancelTransfer コマンドは、 IBM® MQ ネットワークに接続してからエージェント・キュー・マネージャーに経路指定できる任意のシステムから実行できます。 特にコマンドを実行するには、このシステムに Managed File Transfer をインストールしておく必要があります。また、 IBM MQ ネットワークと通信するようにこのシステムに Managed File Transfer を構成しておく必要があります。 接続の詳細を使用できない場合、接続にそのエージェントのキュー・マネージャーの詳細が使用されます (詳細が使用可能な場合)。

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

Syntax

fteCancelTransfer

Read syntax diagramSkip visual syntax diagramfteCancelTransfer-m(agent_qmgr_name)-p(configuration_options)-aagent_name -mquseriduser_id-nolpw-mqpasswordpassword-nolpwtransfer_ID

パラメーター

-m agent_qmgr_name
オプション。 エージェントのキュー・マネージャーの名前。 このエージェントは、取り消す転送のソース・エージェントまたは 宛先エージェントのいずれかでなければなりません。 このパラメーターを指定しない場合、使用している構成オプションのセットで識別されるキュー・マネージャーに取り消し要求が送信されます。
-p configuration_options
オプション。 このパラメーターは、転送を取り消すために使用する構成オプションのセットを決定します。 慣例として、このパラメーターの入力には、デフォルト調整キュー・マネージャー以外の名前を使用します。 これで、コマンドは、デフォルト以外の調整キュー・マネージャーと関連付けられたプロパティー・ファイルのセットを使用します。
このパラメーターを指定しない場合、デフォルトの調整キュー・マネージャーに基づいた構成オプションのセットが使用されます。
-a agent_name
必須。 取り消す転送のソース・エージェントまたは宛先エージェントいずれかの名前。
-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が表示されます。
transfer_ID
必須。 取り消す転送の ID。 fteCreateTransfer コマンドが発行されると、転送 ID (要求 ID でもある) がコマンド行に表示されます。 転送 ID は、ファイル転送ログ・メッセージにも含まれるか、 IBM MQ エクスプローラーの「転送ログ」パネルに表示されます。
- ? または -h
オプション。 コマンド構文を表示します。

例

この例では、AGENT1 が取り消す転送のソース・エージェントです。
fteCancelTransfer -a AGENT1 414d5120514d5f4c4d343336303920201159c54820027102

戻りコード

0

コマンドが正常に完了したか、あるいはエージェントには指定された転送 ID が不明であるかのいずれかです。 転送 ID がエージェントに不明の場合、最も可能性の高い原因は、転送が既に完了済みであるか、またはキャンセル済みであることです。

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