fteModifyAgent (modify a WebSphere MQ File Transfer Edition agent)

The fteModifyAgent command modifies an existing agent so that it can be run as a Windows service. This command is only available on Windows.

Syntax

Syntax diagram format

           

Read syntax diagramSkip visual syntax diagram
fteModifyAgent

>>-fteModifyAgent-- -agentName-- -(agent_name)------------------>

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

>--+----------------------------------------------------------------------------------------------------------------------+-><
   +- -s-- -+----------------+-- -su-- -(user_name)--+--------------------+--+-------------------+--+-------------------+-+   
   |        '-(service_name)-'                       '- -sp-- -(password)-'  '- -sj-- -(options)-'  '- -sl-- -(options)-' |   
   '- -n------------------------------------------------------------------------------------------------------------------'   

Parameters

-agentName (agent_name)
Required. The name of the agent you want to modify.

-p (configuration_options)
Optional. This parameter determines the set of configuration options that is used to modify the agent. By convention use the name of a non-default coordination queue manager as the input for this parameter. The fteModifyAgent 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.

-s (service_name)
Optional. 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. When the agent is to run as a Windows service, this parameter specifies the name of the account under which the service should run. 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.

This parameter is required when -s is specified. Equivalent to -serviceUser.

-sp (password)
Optional. Password for the user account set by the -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 will start successfully.

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

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

-sl (options)
Optional. 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. Indicates that the agent is to be run as a normal process. This is mutually exclusive with the -s option. If neither the -s nor the -n option is specified, then the agent is configured as a normal Windows process.

Equivalent to -normal.

-? or -h
Optional. Displays command syntax.

Example

In this example, AGENT1 is modified to run as a Windows service:
fteModifyAgent -agentName AGENT1 -s -su fteuser -sp ftepassword

You must stop the agent you want to modify, using the fteStopAgent command, before you can run the fteModifyAgent command.

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/modify_agent_cmd.htm