fteStopLogger: stop an MFT logger

The fteStopLogger command stops a Managed File Transfer logger.


Purpose

Use the fteStopLogger command to stop a logger. The logger can be either a file logger, which records a history of managed file transfer activity to a file, or a database logger which records the history to a database.


Additional notes about stopping a stand-alone logger process

If your logger is running as a Windows service, running the fteStopLogger command stops the Windows service.


Syntax

fteStopLogger

fteStopLogger-p configuration_options-qmqueue_manager_name-cqcommand_queue_name-mquseriduserID-mqpasswordpasswordlogger_name


Parameters

    -p (configuration_options)
    Optional. Determines the set of configuration options that is used to stop the logger. Use the name of a set of configuration options as the value for the -p parameter. By convention this value is the name of a coordination queue manager. If you do not specify this parameter, the default set of configuration options is used.

    -qm (queue_manager_name)
    Optional. By default, the logger's command queue is assumed to be on the coordination queue manager specified by the -p parameter (or its default). To send logger commands to a command queue located elsewhere, use the -qm parameter to specify an alternative destination. In all cases, this command connects to the command queue manager indicated by the -p parameter, regardless of the message's ultimate destination.

    -cq (command_queue_name)
    Optional. Specifies the command queue to send the stop message to. In most cases, loggers use the default queue name meaning this parameter is not necessary.

    -mquserid (userID)
    Optional. Specifies the user ID to authenticate with the command queue manager.

    -mqpassword (password)
    Optional. Specifies the password to authenticate with the command queue manager. We must also specify the -mquserid parameter. If you specify -mquserid, but do not specify -mqpassword, we will be prompted to supply the associated password. The password will not be displayed.

    logger_name
    Required. The name of the Managed File Transfer logger we want to stop.

    -? or -h
    Optional. Displays command syntax.


Example

In this example, a logger has previously been created named logger1 and is currently running. This command shows how the logger can be stopped:
fteStopLogger logger1


Return codes

    0
    Command completed successfully.

    1
    Command ended unsuccessfully.

Parent topic: MFT commands


Related reference


Related information