fteModifyLogger (run a IBM MQ Managed File Transfer logging application as a Windows service)

Purpose

A stand-alone logger, whether for a file or for a database, is shown as IBM MQ Managed File Transfer logger for property set logger_name@logger_qm in the Name column of the Services application. The value of logger_qm is the name of the command queue manager of the logger.

Parameters

-loggerName(logger_name)

Required. The name of the IBM MQ Managed File Transfer logger you want to modify.

-pconfiguration_options

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

-sservice_name

Optional. Indicates that the logger is to run as a Windows service. If you do not specify service_name, the service is named mqmftLogger<LOGGER><QMGR>, where <LOGGER> is the logger name and <QMGR> is your logger queue manager name.

The display name for the service, which is shown in the Windows Services window in the Name column, is always WebSphere MQ Managed File Transfer logger <LOGGER>@<QMGR>.

-su or -serviceUseruser_name

Required when -s is specified. Specifies the name of the account under which the Windows 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 permission to log on as a service. For information about how to grant this permission, see Guidance for running an agent or logger as a Windows service.

-sp or -servicePassword password

Optional. Only valid when -s is specified. Password for the user account set by the -su or -serviceUser parameter.

If you do not specify this parameter when you specify the -s parameter, you are warned that you must set the password by using the Windows Services tool before the service can start successfully.

-sj or -serviceJVMOptionsoptions

Optional. Only valid when -s is specified. When the logger 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 (').

For more information about the way in which the fteModifyLogger command handles the validation of updates to the JVM options that are specified with the -serviceJVMOptions parameter, see Guidance for updating agent or logger JVM options.

-sl or -serviceLogLeveloptions

Optional. Only valid when -s is specified. 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.

-n or -normal

Optional. Indicates that the logger 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 logger is configured as a normal Windows process.

-? or -h

Optional. Displays command syntax.

Return codes

0

Command completed successfully.

1

Command ended unsuccessfully.