IBM MQ

https://www.ibm.com/docs/en/ibm-mq/9.4.x
Admin
IBM MQ is a robust messaging middleware that enables applications and systems to communicate...
Tokens:9,292,507
Snippets:86,614
Trust Score:10
Update:3 days ago
Show doc for...
Tokens:
Raw
### Start MQIPT with a home directory using mqipt command

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=thru-starting-stopping-mqipt

Use the mqipt command located in the bin directory of the MQIPT installation directory to start an instance. The example starts an instance using C:\mqiptHome as the home directory. The user ID must have permission to create the errors and logs subdirectories, or they must already exist with appropriate permissions.

```shell
mqipt C:\mqiptHome
```

--------------------------------

### Example: Verify interim fix installation on Linux

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=mq-applying-websphere-liberty-interim-fixes-mqweb-server

Example command to verify the installation and the expected output showing the applied iFix.

```bash
/opt/mqm/web/bin/productInfo version --ifixes
```

```text
Product name: WebSphere Application Server
Product version: 21.0.0.3
Product edition: BASE

PH34122 in the iFix(es): [21003-wlp-archive-IFPH34122]
```

--------------------------------

### Example: Install interim fix on Linux

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=mq-applying-websphere-liberty-interim-fixes-mqweb-server

Example command to install the specific interim fix JAR on Linux, followed by the expected output.

```bash
java -jar 21003-wlp-archive-ifph34122.jar --installLocation /opt/mqm/web
```

```text
Applying fix to Liberty install directory at /opt/mqm/web now.
lib/com.ibm.ws.ui.tool.javaBatch_1.0.50.cl210320210319-1444.jar
lib/com.ibm.ws.ui.tool.explore_1.0.50.cl210320210319-1444.jar
lib/com.ibm.ws.ui_1.0.50.cl210320210319-1444.jar
Fix has been applied successfully.
Successfully extracted all product files.
```

--------------------------------

### START QMGR Command Examples

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=zos-using-mqsc-start-stop-queue-manager

Basic examples of the START QMGR command, which must be prefixed with a command prefix string (CPF).

```text
+CSQ1  START QMGR

+CSQ1  START QMGR PARM(NEWLOG)
```

--------------------------------

### Verify installation library and version

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=i-installing-mq-client

Example output showing the library and version details after pressing F11 in the Display Software Resources screen.

```text

Resource          Feature
ID    Option Feature  Type  Library  Release
5725A49  *BASE  5050   *CODE  QMQM    V9R4M0
5725A49  1    5050   *CODE  QMQMSAMP  V9R4M0
```

--------------------------------

### Linux: Start IBM MQ Explorer from command line

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=explorer-installing-mq-into-eclipse-environments

Start the Eclipse-based product from the same command line that ran setmqenv. Example assumes IBM MQ Explorer is installed in /opt/mqexplorer.

```shell
. /opt/mqexplorer/MQExplorer
```

--------------------------------

### Get basic installation information (z/OS)

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=admininstallation-get

Retrieves basic installation details for z/OS using the HTTP GET method.

```http
https://REST.example.com:9443/ibmmq/rest/v3/admin/installation
```

```json
{
    "installation": [{
       "platform": "z/os",
       "version": "9.1.0"
    }]
}
```

--------------------------------

### Start sample programs

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=multiplatforms-high-availability-sample-programs

Launch the producer, mover, and getter sample programs.

```text
C:\> start amqsphac SOURCE QM1
C:\> start amqsmhac -s SOURCE -t TARGET -m QM1
C:\> start amqsghac TARGET QM1
```

--------------------------------

### Example of starting an application with a configuration file

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=jms-mq-classes-jmsjakarta-messaging-configuration-file

This command points to a specific configuration file located on a Windows file system.

```bash
java -Dcom.ibm.msg.client.config.location=file:/D:/mydir/myjms.config MyAppClass
```

--------------------------------

### Windows: Set environment and start IBM MQ Explorer

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=explorer-installing-mq-into-eclipse-environments

Run setmqenv to set the PATH environment variable, then start the stand-alone IBM MQ Explorer from the same command line. Example assumes IBM MQ is installed in C:\Program Files\IBM\MQ and IBM MQ Explorer in C:\Program Files\IBM\MQ Explorer.

```batch
"C:\Program Files\IBM\MQ\bin\setmqenv" -s
"C:\Program Files\IBM\MQ Explorer\MQExplorer.exe"
```

--------------------------------

### Example Java command with configuration file

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=tmcja-collecting-mq-classes-java-trace-by-using-mq-classes-java-configuration-file

An example command demonstrating how to point to a local configuration file on a Windows system.

```bash
java -Dcom.ibm.msg.client.config.location=file:/D:/mydir/myJava.config 
MyAppClass
```

--------------------------------

### Get basic installation information (AIX, Linux, Windows)

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=admininstallation-get

Retrieves basic installation details using the HTTP GET method.

```http
https://localhost:9443/ibmmq/rest/v3/admin/installation
```

```json
{
    "installation": 
    [{
       "name": "Installation1",
       "platform": "windows",
       "version": "9.1.0.0"
    }]
}
```

--------------------------------

### Example command.properties file content

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=reference-mft-commandproperties-file

A sample configuration showing the connection queue manager, host, port, and channel settings.

```properties
connectionQMgr=PLUTO
connectionQMgrHost=kuiper.example.com
connectionQMgrPort=1930
connectionQMgrChannel=SYSTEM.DEF.SVRCONN
```

--------------------------------

### Start sample client programs

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=linux-verifying-multi-instance-queue-manager

Commands to start the sample programs amqsghac, amqsmhac, and amqsphac on the client.

```cmd
start amqsghac TARGET QM1
start amqsmhac -s SOURCE -t TARGET -m QM1
start amqsphac SOURCE QM1
```

--------------------------------

### Sample output from publisher example

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=applications-example-1-publisher-fixed-topic

Example console output showing the program running with default parameters and with custom arguments.

```text
X:\Publish1\Debug>PublishStock
Optional parameters:  TopicObject Publication
Published "129" using topic "IBMSTOCKPRICE" to topic string "NYSE/IBM/PRICE"
Completion code 0 and Return code 0

X:\Publish1\Debug>PublishStock IBMSTOCKPRICE 155
Optional parameters:  TopicObject Publication
Published "155" using topic "IBMSTOCKPRICE" to topic string "NYSE/IBM/PRICE"
Completion code 0 and Return code 0
```

--------------------------------

### Example keystore.conf file

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=ams-structure-keystore-configuration-file-keystoreconf

A sample configuration file showing both Native AMS and Java AMS application settings.

```text
# Native AMS application configuration
cms.keystore = c:\Documents and Settings\Alice\AliceKeystore
cms.certificate = AliceCert

# Java AMS application configuration
jceks.keystore = c:/Documents and Settings/Alice/AliceKeystore
jceks.certificate = AliceCert
jceks.encrypted = no
jceks.keystore_pass = passw0rd
jceks.key_pass = passw0rd
```

--------------------------------

### Get installation path attribute (AIX, Linux, Windows)

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=admininstallation-get

Retrieves only the installation path attribute for a specific installation.

```http
https://localhost:9443/ibmmq/rest/v3/admin/installation/Installation1?attributes=extended.installationPath
```

```json
{
    "installation": [{
        "extended": {
             "installationPath": "C:\\Program Files\\IBM\\MQ"
         },
         "name": "Installation1",
         "platform": "windows",
         "version": "9.1.0.0"
    }]
}
```

--------------------------------

### Delete IBM MQ installation entry

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=reference-dltmqinst-delete-mq-installation

Example of deleting an installation entry by specifying the installation name and path.

```bash
dltmqinst -n MyInstallation -p /opt/myInstallation
```

--------------------------------

### Run MQIVP sample on Linux

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=java-using-mq-classes-sample-applications

Example commands to navigate to the samples directory and run the MQIVP installation verification program on Linux.

```bash
cd /opt/mqm/samp/wmqjava/samples
/opt/mqm/java/bin/runjms MQIVP
```

--------------------------------

### fteSetupCommands example with connection parameters

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=reference-ftesetupcommands-create-mft-commandproperties-file

Creates a command.properties file for a connection queue manager. The example specifies the queue manager name, host, port, and channel. If -connectionQMgrHost is omitted, a bindings mode connection is assumed; if host is specified without port and channel, defaults of 1414 and SYSTEM.DEF.SVRCONN are used.

```shell
fteSetupCommands -connectionQMgr QM_NEPTUNE -connectionQMgrHost 9.146.157.241
-connectionQMgrPort 1414 -connectionQMgrChannel SYSTEM.DEF.SVRCONN

```

--------------------------------

### Example: start JMSConsumer with trace control file

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=applications-collecting-mq-classes-java-trace-dynamically

Example command that starts the application MQJavaPutter with the trace control file set to C:\Trace\enableTrace.txt. When this file is detected, trace is enabled for the application.

```java
java -Dcom.ibm.msg.client.commonservices.trace.OnOffFile=C:\Trace\enableTrace.txt MQJavaPutter
```

--------------------------------

### Example MQIPT startup output

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=thru-starting-stopping-mqipt

Example console messages shown when MQIPT starts successfully. These messages indicate the status of MQIPT and can be used to verify successful startup. If an error occurs, refer to the troubleshooting documentation.

```text
5724-H72 (C) Copyright IBM Corp. 2000, 2026. All Rights Reserved
MQCPI001 IBM MQ Internet Pass-Thru 9.4.0.0 starting
MQCPI004 Reading configuration information from mqipt.conf
MQCPI152 MQIPT name is C:\mqiptHome
MQCPI021 Password checking has been enabled on the command port
MQCPI144 MQ Advanced capabilities not enabled
MQCPI011 The path C:\mqiptHome\logs will be used to store the log files
MQCPI006 Route 1414 is starting and will forward messages to :
MQCPI034 ....examplehost(1414)
MQCPI035 ....using MQ protocols
MQCPI057 ....trace level 5 enabled
MQCPI078 Route 1414 ready for connection requests
```

--------------------------------

### Get extended installation information (AIX, Linux, Windows)

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=admininstallation-get

Retrieves extended installation details for a specific installation using the attributes parameter.

```http
https://localhost:9443/ibmmq/rest/v3/admin/installation/Installation1?attributes=*
```

```json
{
    "installation": 
    [{
         "extended": {
             "dataPath": "C:\\Program Files (x86)\\IBM\\WebSphere MQ",
             "description": "My MQ installation",
             "installationPath": "C:\\Program Files\\IBM\\WebSphere MQ",
             "level": "p910-L180501",
             "maximumCommandLevel": 910,
             "operatingSystem": "Windows 7 Professional x64 Edition, Build 7601: SP1",
             "primary": true
         },
         "name": "Installation1",
         "platform": "windows",
         "version": "9.1.0.0"
    }]
}
```

--------------------------------

### Output for IBM MQ client installation

Source: https://www.ibm.com/docs/en/ibm-mq/9.4.x?topic=reference-dspmqinst-display-mq-installation

Example output for an IBM MQ client installation.

```text
InstName:      Installation1
InstDesc:      My installation
Identifier:    1
InstPath:      /opt/mqm
Version:       9.3.0.0
Primary:       No
State:         Available
License:       Production
Entitlement:   IBM MQ Client
```
Tokens:
Raw