fteModifyAgent (run an MFT agent as a Windows service)

The fteModifyAgent command modifies an existing agent so that it can be run as a Windows service. This command is only available on Windows, and must be run by a user who is an IBM® MQ administrator and a member of the mqm group.

Syntax

fteModifyAgent

Windows system options

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 mqmftAgentAGENTQMGR, 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 Managed File Transfer Agent AGENT@QMGR.
Note: If the redistributable agent is going to run as a Windows service, then the BFG_DATA environment variable needs to be set in the system environment for the service to work.
-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 Troubleshooting an MFT agent or logger running as a Windows service.; This parameter is required when -s is specified.
-sp password: Optional. This parameter is only valid when -s is specified.
-sj options: Optional. When the agent is started as a Windows service, this parameter defines a list of options in the form of -D or -X that will be passed to the Java Virtual Machine (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.; For more information about the way in which the fteModifyAgent command handles the validation of updates to the JVM options see How agent and logger JVM options are processed.
-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.
-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.
-? or -h: Optional. Displays command syntax.

Example

In this example, AGENT1 is modified to run as a Windows service:

fteModifyAgent -agentName AGENT1 -s Service1 -su fteuser -sp ftepassword

In this example, AGENT1 is modified to remove the Windows service:

fteModifyAgent -agentName AGENT1

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

Return codes

Table 1. Return code identifiers and descriptions
Return code	Description
0	Command completed successfully
1	Command ended unsuccessfully