fteStopAgent (stop a WebSphere MQ File Transfer Edition agent)
Use the fteStopAgent command to either stop a WebSphere® MQ File Transfer Edition agent in a controlled way or to stop an agent immediately if necessary using the -i parameter.
Purpose
When you stop an agent by using the fteStopAgent command, you can either allow the agent to complete its current file transfer before stopping, or stop the agent immediately even if the agent is currently transferring a file. When the agent has stopped, you cannot use that agent to transfer files until you restart the agent.
You can run the fteStopAgent command from any system that can connect to the WebSphere MQ network and then route to the agent queue manager. Specifically for the command to run, you must have installed a WebSphere MQ File Transfer Edition component (either Server, Client, or Remote Tools and Documentation) on this system and you must have configured the WebSphere MQ File Transfer Edition on this system to communicate with the WebSphere MQ network. If no connectivity details are available, then a bindings mode connection is made to the default queue manager on the local system. If command.properties does not exist then an error is generated.
Specify the optional -p parameter for this command only if you want to use a set of configuration options different from your default set. See Properties files for WebSphere MQ File Transfer Edition for more information.
If your agent is running as a Windows service, running the fteStopAgent command stops the Windows service. For more information, see Starting an agent as a Windows service.
Syntax
fteStopAgent >>-fteStopAgent--+------------------------+---------------------> '- -m--(agent_qmgr_name)-' >--+------------------------------+--+-----+--agent_name------->< '- -p--(configuration_options)-' '- -i-'
Parameters
- -m (agent_qmgr_name)
- Optional. The name of the queue manager that the agent that you want to stop is connected to. If you do not specify this parameter, the stop request is sent to the queue manager identified by the set of configuration options you are using.
- -p (configuration_options)
- Optional. This parameter determines the set of configuration options
that is used to issue the request to stop an agent. Use the name of
a non-default coordination queue manager as the input for this parameter.
The command then uses the set of properties files associated with
this non-default coordination queue manager.
If you do not specify this parameter, the set of configuration options based on the default coordination queue manager is used.
- -i
- Optional. Immediately stops the agent. The agent does not complete
any transfers that are currently in progress.
If you do not specify the -i parameter, the agent completes any transfers currently in progress but the agent does not start any new transfers.
- agent_name
- Required. The name of the WebSphere MQ File Transfer Edition agent that you want to stop.
- -? or -h
- Optional. Displays command syntax.
Example
In this example the agent AGENT2 on queue manager QM_JUPITER is stopped. The -m parameter is used because this queue manager that AGENT2 is connected to differs from the queue manager specified by the set of configuration options.fteStopAgent -m QM_JUPITER AGENT2
Return codes
- 0
- Command completed successfully.
- 1
- Command ended unsuccessfully.