fteModifyDatabaseLogger (run a WebSphere MQ File Transfer Edition database logging application as a Windows service)
The fteModifyDatabaseLogger command modifies a stand-alone database logger so that it can be run as a Windows service. This command is only available on Windows.
The stand-alone database logger is shown as IBM® WMQFTE database logger for property
set qmgr unique_ID
in the Name column
of the Services application. The value of qmgr is
the name of the coordination queue manager. The value of unique_ID is
blank if the default properties file is used. If a non-default properties
file is used, the value of unique_ID is a randomly
generated value.
Syntax
fteModifyDatabaseLogger >>-fteModifyDatabaseLogger--------------------------------------> >--+--------------------------------+---------------------------> '- -p-- -(configuration_options)-' >--+----------------------------------------------------------------------------------------------------------------------+--> +- -s-- -+----------------+-- -su-- -(user_name)--+--------------------+--+-------------------+--+-------------------+-+ | '-(service_name)-' '- -sp-- -(password)-' '- -sj-- -(options)-' '- -sl-- -(options)-' | '- -n------------------------------------------------------------------------------------------------------------------' >--+---------------+--+-------------------+-------------------->< '- -b-- -(bits)-' '-(properties file)-'
Parameters
- -p (configuration_options)
- Optional. This parameter determines the set of configuration options
that is used to modify the database logger. By convention use the
name of a non-default coordination queue manager as the input for
this parameter. The fteModifyDatabaseLogger 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 database logger is to run as a Windows service. If you do not specify service_name, the service is named fteDBLoggerQMGRuniqueID. The value of QMGR is the name of the coordination queue manager. The value of unique_ID is blank if the default properties file is used. If a non-default properties file is used, the value of unique_ID is a randomly generated value.
- -su (user_name)
- Optional. When the database logger 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 database 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.
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 database 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 database logger is configured as a normal Windows process.
Equivalent to -normal.
- -b (bits)
- Optional. Equivalent to -bitMode. Selects
whether the database logger runs as a 32-bit or 64-bit process. Valid
values are:
- 32 - run the database logger as a 32-bit process
- 64 - run the database logger as a 64-bit process
- properties file
- Optional. By default, the stand-alone database logger properties file is assumed to be located in the directory config_directory/coordination_qmgr_name. You can optionally supply your own fully qualified path to a properties file containing the required properties for the stand-alone database logger to run. The log output is located under the default coordination queue manager directory in a folder called logs irrespective of where the properties file is located. You can alter the default configuration set by specifying the -p parameter on the command line.
- -? or -h
- Optional. Displays command syntax.
Example
In this example, the database logger is modified to run as a Windows service:fteModifyDatabaseLogger -s -su fteuser -sp ftepassword
You must stop the database logger, using the fteStopDatabaseLogger command, before you can run the fteModifyDatabaseLogger command.
Return codes
- 0
- Command completed successfully.
- 1
- Command ended unsuccessfully.