runmqras

Gather diagnostic information together into a single archive to submit to IBM Support.

Purpose

You can use the runmqras command to gather diagnostic information from the appliance into a single archive. You can use this command to gather information about an application or appliance failure, possibly for submission into IBM when you report a problem.

By default, the command gathers information such as the FDC files, error logs, product version, and status information. The command does not gather user information that is contained in messages on queues when you use the default setting. However, if you request sections other than default, the data collected might contain user information.

The diagnostic information is written to a zip file named runmqras_timestamp.zip, where timestamp has the format yymmdd_HHMMSS.

The zip file written to the appliance URI mqdiag:///, You can retrieve it by using the copy command (see copy), or by using the IBM® MQ Appliance web UI (see Managing files by using the IBM MQ Appliance web UI). You can also use the ftp custom option of the runmqras command to copy the trace directly to an FTP server.

Syntax

Parameters

section Sections

Specifies the optional sections about which to gather more specific information.

By default, a generic section of documentation is collected. Running without requesting more sections is intended as a starting point for general problem diagnosis, but more specific information can be gathered for a specific problem type. You can specify multiple values for Sections in a comma-separated list.

IBM support generally supplies you with the sections to use. Example values for Sections are the following values:

all: Gathers all possible information, including all trace files, and diagnostics for many different types of problems. This option results in the generation of a very large file, so you must check that the mqdiag:/// directory does not currently contain trace information. If mqdiag:/// does already contain information, you should copy the files off of the appliance, or send them to IBM support, before running runmqras with the all section.; You could also consider using the qmlist parameter with this option to limit the output to specified queue managers.
cluster: Gather information specific for clustering
defs: Gather the queue manager definitions and status
format: Generate and include formatted trace files.
nodefault: Prevents the default collections from occurring, but other explicitly requested sections are still collected.
trace: Gather all the trace file information plus the default information.; This option results in the generation of a very large file, so you must check that the mqdiag:/// directory does not currently contain trace information. If mqdiag:/// does already contain information, you should copy the files off of the appliance, or send them to IBM support, before running runmqras with the trace section.
webui: A diagnostics test is run on the IBM MQ Console, and the results written to the archive.

qmlist QMRs

Specifies one or more queue manager names on which the command is to be run.

You can specify multiple queue managers in a comma-separated list.

By default, the command is run on all queue managers.

timeout secs

Specifies the default timeout to give an individual command before the command stops waiting for completion.

A value of zero means that the command waits indefinitely.

The default value is 10.

demo

Specifies that the command is run in demonstration mode.

In demonstration mode, no commands are processed, and no files gathered. However, you can see which commands would be processed, and which files would be gathered in the console.log file that is generated as part of the output.

-v

Specifies verbose output.

ftp IBM pmrno number

Specifies that the collected archive is sent through basic FTP to IBM.

Anonymous FTP is used to deliver the archive into the IBM ECuRep server. This process is identical to submitting the file manually by using FTP.

number must specify a valid IBM PMR (problem record number) against which to associate the archive.

ftp IBM caseno number

Specifies that the collected archive is sent through basic FTP to IBM.

Anonymous FTP is used to deliver the archive into the IBM ECuRep server. This process is identical to submitting the file manually by using FTP.

number must specify a valid Salesforce case number against which to associate the archive.

Note: If you want to specify a PMR number, use the -pmrno parameter, not the -caseno parameter.

It is not permitted to supply both the -caseno and -pmrno parameters together.

ftp custom

Specifies that the collected archive is sent through basic FTP to a site of your choosing.

When you use this parameter, you must specify the following ftp parameters:

ftpserver server: Specifies an FTP server name to connect to.
ftpusername userid: Specifies the user ID to log in to the FTP server with.
ftppassword password: Specifies the password to log in to the FTP server with
ftpdirectory path: Specifies the directory on the FTP server to place the resulting file into.

Usage notes

This command must be run from the IBM MQ administration mode. If the system is in the IBM MQ administration mode the prompt includes mqa(mqcli)#. To enter the IBM MQ administration mode, enter mqcli on the command line. To exit the IBM MQ administration mode, enter exit on the command line.
Use runmqras -section format to generate and include formatted trace files.
For more information about this command in IBM MQ, see runmqras in the IBM MQ documentation.

Examples

The following command gathers the default documentation from the installation, and all queue managers on the system:
```
runmqras
```
The following command gathers the default documentation from the installation, and sends it directly into IBM to be associated with PMR number 11111,222,333 using the basic FTP capability:
```
runmqras -ftp ibm -pmrno 11111,222,333
```
The following command gathers the default documentation from a machine, plus all trace files, the queue manager definitions, and status for all queue managers on the system:
```
runmqras -section trace,defs
```
The following command copies the information gathered by runmqras from the mqdiag:/// directory on the appliance to another location on a system with the IP address 10.10.1.159:
```
(config)# copy mqdiag:///runmqras_160818_221406.zip scp://jrb@10.10.1.159//home/user
```