fteCreateAgent (create a WebSphere MQ File Transfer Edition agent)

The fteCreateAgent command creates an agent and its associated configuration.

Purpose

Use the fteCreateAgent command to create an agent. This command provides you with the MQSC commands that you must run against your agent queue manager to create the following agent queues:
  • 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
These queues are internal system queues that you must not modify, delete, or read messages from unless you are deleting the agent. The MQSC commands to run are also supplied in a file in the following location: configuration_directory\coordination_qmgr_name\agents\agent_name\agent_name_create.mqsc.

If you later want to delete the agent, this command also provides you with the MQSC commands you must run to clear then delete the queues used by the agent. The MQSC commands are in a file in the following location: configuration_directory\coordination_qmgr_name\agents\agent_name\agent_name_delete.mqsc.

WebSphere® MQ File Transfer Edition provides advanced agent properties that help you configure agents. These properties are described in The agent.properties file.

Syntax

Syntax diagram format

           

Read syntax diagramSkip visual syntax diagram
fteCreateAgent

>>-fteCreateAgent-- -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--+----------------+-- -su--(user_name)--+------------------+--+-----------------+--+-----------------+-+   
   |      '-(service_name)-'                     '- -sp--(password)-'  '- -sj--(options)-'  '- -sl--(options)-' |   
   '- -n--------------------------------------------------------------------------------------------------------'   

>--+------------------------------+--+-----+-------------------><
   '- -p--(configuration_options)-'  '- -f-'   

Parameters

-agentName (agent_name)
Required. The name of the agent you want to create. The agent name must be unique to its coordination queue manager.

For more information about naming agents, see Object naming conventions .

-agentQMgr (agent_qmgr_name)
Required. The name of the agent queue manager.

-agentQMgrHost (agent_qmgr_host)
Optional. The host name or IP address of the agent queue manager.

-agentQMgrPort (agent_qmgr_port)
Optional. The port number used for client connections to the agent queue manager.

-agentQMgrChannel (agent_qmgr_channel)
Optional. The channel name used to connect to the agent queue manager.

-agentDesc (agent_description)
Optional. A description of the agent, which is displayed in WebSphere MQ Explorer.

-ac or -authorityChecking
Optional. This parameter enables authority checking. If you specify this parameter, the agent checks that users who are submitting requests are authorized to perform the requested action. For more information, see User authorities on WebSphere MQ File Transfer Edition actions.

-s (service_name)
Optional (Windows only). Indicates that the agent is to run as a Windows service. If you do not specify service_name, the service is named fteAgent<AGENT><QMGR>, where <AGENT> is the agent name and <QMGR> is your agent queue manager name.

The display name for the service, which is shown in the Windows Services window in the Name column, is always IBM WMQFTE agent <AGENT>@<QMGR>.

-su (user_name)
Optional (Windows only). When the agent is to run as a Windows service, this parameter specifies the name of the account under which the service runs. To run the agent using a Windows domain user account specify the value in the form DomainName\UserName. To run the service using an account from the local built-in domain specify the value in the form UserName.

The Windows user account that you specify using the -su parameter must have the Log on as a service right. For information about how to grant this right, see Guidance for running an agent or database logger as a Windows service.

Required when -s specified. Equivalent to -serviceUser.

-sp (password)
Optional (Windows only). Password for the user account set by -su or -serviceUser parameter.

This parameter is only valid when -s is specified. Equivalent to -servicePassword. If you do not specify this parameter when you specify the -s parameter, a warning message is produced. This message warns you that you must set the password using the Windows Services tool before the service starts successfully.

-sj (options)
Optional (Windows only). When the agent is started as a Windows service, defines a list of options in the form of -D or -X that are passed to the JVM. The options are separated using a number sign (#) or semicolon (;) character. If you must embed any # or semicolon (;) characters, put them inside single quotation marks.

This parameter is only valid when -s is specified. Equivalent to -serviceJVMOptions.

-sl (options)
Optional (Windows only). Sets the Windows service log level. Valid options are: error, info, warn, debug. The default is info. This option can be useful if you are having problems with the Windows service. Setting it to debug gives more detailed information in the service log file.

This parameter is only valid when -s is specified. Equivalent to -serviceLogLevel.

-n
Optional (Windows only). Indicates that the agent is to be run as a normal process. This is mutually exclusive with the -s option. If neither one of the -s parameter and the -n parameter is specified, then the agent is configured as a normal Windows process.

Equivalent to -normal.

-p (configuration_options)
Optional. This parameter determines the set of configuration options that is used to create an agent. By convention use the name of a non-default coordination queue manager as the input for this parameter. The fteCreateAgent command then uses the set of properties files 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 this parameter, the set of configuration options based on the default coordination queue manager is used.

-f
Optional. Forces the command to overwrite the existing configuration.

-? or -h
Optional. Displays command syntax.

Example

In this example, AGENT3 is created with an agent queue manager QM_NEPTUNE and uses the default coordination queue manager:
fteCreateAgent -agentName AGENT3 -agentQMgr QM_NEPTUNE
 -agentQMgrHost myhost.ibm.com -agentQMgrPort 1415 -agentQMgrChannel CHANNEL1

Return codes

0
Command completed successfully.
1
Command ended unsuccessfully.

Reference Reference

Feedback

Timestamp icon Last updated: Tuesday, 30 January 2018
http://www.ibm.com/support/knowledgecenter/SSEP7X_7.0.4/com.ibm.wmqfte.doc/create_agent_cmd.htm