fteRAS: run RAS gathering tool

The fteRAS command runs the RAS gathering tool to collect MustGather data.


Purpose

Use the fteRAS command to run the RAS gathering tool if you need to collect MustGather data to use to help find a solution when a Managed File Transfer agent, database logger or other command is reporting a problem or failing to work properly.

When you run the fteRAS command, the output directory in which the resulting archive (.zip) file is placed can be either the default location, or a directory of your choosing.


Syntax

fteRAS

fteRAS -p configuration_options-lPDSLibraryNameSecurity-mquseriduserid-mqpasswordpasswordOutputDirectory


Parameters

    -p configuration_options

    Optional. Determines the set of configuration options that is used to gather RAS, for example, the list of agents. Use the name of a set of configuration options as the value for the -p parameter. By convention, this name is the name of a coordination queue manager. If we do not specify this parameter, the default set of configuration options is used.

    -l
    Optional. z/OS® only. Specifies the name of a PDS library that contains JCL scripts that invoke MQMFT commands for a particular agent or logger. This option is always set when the command is run from a command PDS library's BFGRAS JCL script, such that all members of the PDS library are captured in the output directory.
    -mquserid user id
    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. You must also specify the -mquserid parameter. If you specify -mquserid but do not also specify -mqpassword, you are prompted to supply the associated password. The password is not displayed on the screen.
    OutputDirectory
    Optional. A directory to use when you are gathering the RAS data, and where the output .zip file is stored after the data is gathered successfully. If the directory does not exist, it is created. The default location is the mqft logs directory.
    -? or -h
    Optional. Displays command syntax.


Examples

On UNIX and Linux , to store the output file fteRAS.zip in the /var/mqm/errors directory, run fteRAS as shown in the following example:

fteRAS /var/mqm/errors
The following message confirms that the command has completed successfully:
BFGCL0604I: fteRAS command completed successfully. Output is stored in /var/mqm/errors/fteRAS.zip
On Windows, to store the output file fteRAS.zip in the default errors directory for a new installation of IBM MQ , run fteRAS as shown in the following example:
fteRAS "C:\ProgramData\IBM\MQ\errors"
The following message confirms that the command has completed successfully:
BFGCL0604I: fteRAS command completed successfully. Output is stored in C:\ProgramData\IBM\MQ\errors\fteRAS.zip
Note: For IBM MQ Version 8.0 or later, if this is not a new installation of that version of the product, the location of the errors directory might be different on your system. For more information, see Program and data directory locations on Windows. On IBM i, to copy the output file to /QIBM/UserData/mqm/errors, run the fteRAS command from the Qshell as shown in the following example:
/QIBM/ProdData/mqm/bin/fteRAS /QIBM/UserData/mqm/errors
The following message confirms that the command has completed successfully:
BFGCL0604I: fteRAS command completed successfully. Output is stored in /QIBM/UserData/mqm/errors/fteRAS.zip