fteDeleteAgent (delete a WebSphere MQ File Transfer Edition agent)
The fteDeleteAgent command deletes a WebSphere® MQ File Transfer Edition agent and its configuration. If the agent is protocol a bridge agent, the user credentials file is left on the file system.
Purpose
Stop the agent with the fteStopAgentcommand before running the fteDeleteAgent command.
If you have configured your agent to run as a Windows service, running the fteDeleteAgent command deletes the service definition.
The fteDeleteAgent command
provides you with the MQSC commands that you must run against your
agent's queue manager to clear and delete the agent's system queues.
These queues are as follows:
- SYSTEM.FTE.AUTHADM1.agent_name
- SYSTEM.FTE.AUTHAGT1.agent_name
- SYSTEM.FTE.AUTHMON1.agent_name
- SYSTEM.FTE.AUTHOPS1.agent_name
- SYSTEM.FTE.AUTHSCH1.agent_name
- SYSTEM.FTE.AUTHTRN1.agent_name
- SYSTEM.FTE.COMMAND.agent_name
- SYSTEM.FTE.DATA.agent_name
- SYSTEM.FTE.EVENT.agent_name
- SYSTEM.FTE.REPLY.agent_name
- SYSTEM.FTE.STATE.agent_name
If your agent is a web agent
there are two additional queues that must be deleted. The fteDeleteAgent command
clears and deletes the following queue:
- SYSTEM.FTE.WEB.RESP.agent_name
Note: Delete
the SYSTEM.FTE.WEB.gateway_name queue only if all web agents
associated with this Web Gateway have been deleted.
The fteCreateAgent command
also provides these commands in a file in the following location:
configuration_directory/coordination_qmgr_name/agents/agent_name/agent_name_delete.mqsc
Syntax
fteDeleteAgent >>-fteDeleteAgent--+------------------------------+--+-----+----> '- -p--(configuration_options)-' '- -f-' >--agent_name--------------------------------------------------><
Parameters
- -p (configuration_ options)
- Optional. If you have more than one coordination queue manager,
use this parameter to explicitly specify which agent configuration
you want to delete. Use the name of a non-default coordination queue
manager as the input for this parameter. The command then uses the
configuration options associated with this non-default coordination
queue manager.
Specify the optional -p parameter only if you want to use configuration options different from your defaults. If you do not specify -p, the configuration options defined in the wmqfte.properties file are used. See Configuration options for more information.
- -f
- Optional. Forces the command to deregister the agent from the coordination queue manager even if the agent's configuration files cannot be found. Because information about the agent's queue manager is not available in this situation, the command will connect directly to the coordination queue manager instead of using the agent queue manager as it normally would.
- agent_name
- Required. The name of the agent that you want to delete.
- -? or -h
- Optional. Displays command syntax.
Example
In this example, AGENT3 and its configuration on coordination queue manager QM_COORD1 are deleted:fteDeleteAgent -p QM_COORD1 AGENT3
This example command outputs the following MQSC commands
to delete the agent's three queues:CLEAR QLOCAL(SYSTEM.FTE.COMMAND.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.COMMAND.AGENT3)
CLEAR QLOCAL(SYSTEM.FTE.DATA.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.DATA.AGENT3)
CLEAR QLOCAL(SYSTEM.FTE.REPLY.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.REPLY.AGENT3)
CLEAR QLOCAL(SYSTEM.FTE.STATE.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.STATE.AGENT3)
CLEAR QLOCAL(SYSTEM.FTE.EVENT.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.EVENT.AGENT3)
CLEAR QLOCAL(SYSTEM.FTE.AUTHADM1.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.AUTHADM1.AGENT3)
CLEAR QLOCAL(SYSTEM.FTE.AUTHAGT1.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.AUTHAGT1.AGENT3)
CLEAR QLOCAL(SYSTEM.FTE.AUTHTRN1.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.AUTHTRN1.AGENT3)
CLEAR QLOCAL(SYSTEM.FTE.AUTHOPS1.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.AUTHOPS1.AGENT3)
CLEAR QLOCAL(SYSTEM.FTE.AUTHSCH1.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.AUTHSCH1.AGENT3)
CLEAR QLOCAL(SYSTEM.FTE.AUTHMON1.AGENT3)
DELETE QLOCAL(SYSTEM.FTE.AUTHMON1.AGENT3)
Return codes
- 0
- Command completed successfully.
- 1
- Command ended unsuccessfully.