9.

Installing IBM MQ

IBM
 Note
Before using this information and the product it supports, read the information in “Notices” on page
299.

This edition applies to version 9 release 2 of IBM® MQ and to all subsequent releases and modifications until otherwise
indicated in new editions.
When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any way it
believes appropriate without incurring any obligation to you.
© Copyright International Business Machines Corporation 2007, 2023.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract with
IBM Corp.
Contents

Installing and uninstalling..................................................................................... 5

IBM MQ installation overview...................................................................................................................... 5
IBM MQ components and features........................................................................................................ 6
License requirements............................................................................................................................. 8
Where to find product requirements and support information.............................................................9
Where to find downloadable installation images.................................................................................. 9
IBM MQ code signatures...................................................................................................................... 12
Planning considerations for installation on Multiplatforms................................................................ 14
Redistributable IBM MQ clients........................................................................................................... 27
IBM MQ non-install images..................................................................................................................31
Installing and uninstalling IBM MQ on AIX............................................................................................... 32
IBM MQ components for AIX systems.................................................................................................33
Checking requirements on AIX............................................................................................................ 35
Planning to install IBM MQ on AIX.......................................................................................................37
Preparing the system on AIX............................................................................................................... 37
Installing IBM MQ server on AIX......................................................................................................... 42
Converting a trial license on AIX..........................................................................................................46
Displaying messages in your national language on AIX......................................................................46
Installing an IBM MQ client on AIX......................................................................................................47
Verifying an IBM MQ installation on AIX..............................................................................................50
Uninstalling or modifying IBM MQ on AIX........................................................................................... 60
Installing and uninstalling IBM MQ on IBM i.............................................................................................62
IBM MQ components for IBM i.............................................................................................................63
Hardware and software requirements on IBM i systems....................................................................63
Planning to install IBM MQ on IBM i.................................................................................................... 64
Preparing the system on IBM i............................................................................................................. 65
Installing IBM MQ server on IBM i....................................................................................................... 66
Converting a trial license on IBM i....................................................................................................... 79
Installing an IBM MQ client on IBM i................................................................................................... 79
Installing IBM MQ Java messaging and web services for IBM i......................................................... 82
Verifying an IBM MQ installation on IBM i........................................................................................... 84
Uninstalling IBM MQ for IBM i..............................................................................................................89
Installing and uninstalling IBM MQ on Linux............................................................................................ 94
Checking requirements on Linux......................................................................................................... 94
Planning to install IBM MQ on Linux.................................................................................................... 98
Preparing the system on Linux.............................................................................................................99
License acceptance on IBM MQ for Linux......................................................................................... 107
Installing IBM MQ on Linux using rpm.............................................................................................. 108
Installing IBM MQ on Linux Red Hat using yum................................................................................ 123
Installing IBM MQ on Linux Ubuntu using Debian.............................................................................126
Redistributable clients on Linux........................................................................................................ 139
Converting a trial license on Linux..................................................................................................... 140
Displaying messages in your national language on Linux................................................................. 141
Verifying an IBM MQ installation on Linux.........................................................................................142
Uninstalling or modifying IBM MQ on Linux...................................................................................... 155
Installing and uninstalling IBM MQ on Windows.................................................................................... 162
IBM MQ features for Windows systems............................................................................................ 163
Checking requirements on Windows................................................................................................. 173
Planning to install IBM MQ on Windows............................................................................................175
Installing IBM MQ server on Windows.............................................................................................. 182
Installing an IBM MQ client on Windows...........................................................................................209
Converting a trial license on Windows...............................................................................................223

iii
 Displaying messages in your national language on Windows systems............................................ 223
Redistributable clients on Windows.................................................................................................. 224
Verifying an IBM MQ installation on Windows.................................................................................. 226
Uninstalling IBM MQ on Windows..................................................................................................... 239
Installing IBM MQ Advanced for Multiplatforms.................................................................................... 245
Installing and uninstalling AMS on Multiplatforms........................................................................... 246
Installing Managed File Transfer ...................................................................................................... 253
Installing MQ Telemetry.....................................................................................................................259
Installing RDQM (replicated data queue managers).........................................................................265
Installing IBM MQ for z/OS......................................................................................................................278
z/OS installation overview................................................................................................................. 279
Checking requirements on z/OS........................................................................................................ 281
Planning to install IBM MQ for z/OS.................................................................................................. 281
Delivery media....................................................................................................................................284
Customizing IBM MQ and its adapters.............................................................................................. 284
Verifying your installation of IBM MQ for z/OS.................................................................................. 285
Macros intended for customer use.................................................................................................... 285
Product usage recording with IBM MQ for z/OS products................................................................ 286
Installing and enabling IBM MQ for z/OS Value Unit Edition............................................................ 288
Installing IBM MQ Advanced for z/OS............................................................................................... 289
Installing IBM MQ Advanced for z/OS Value Unit Edition................................................................. 291
Installing and uninstalling IBM MQ Explorer as a stand-alone application on Linux and Windows..... 292
Installing the stand-alone IBM MQ Explorer on Linux...................................................................... 292
Uninstalling the stand-alone IBM MQ Explorer on Linux.................................................................. 294
Installing the stand-alone IBM MQ Explorer on Windows................................................................294
Uninstalling the stand-alone IBM MQ Explorer on Windows............................................................295
Installing and uninstalling IBM MQ Internet Pass-Thru......................................................................... 296
Installing MQIPT................................................................................................................................ 296
Uninstalling MQIPT............................................................................................................................ 298

Notices..............................................................................................................299
Programming interface information........................................................................................................ 300
Trademarks.............................................................................................................................................. 300

iv
Installing and uninstalling IBM MQ
Before you start installing IBM MQ, consider how you want to use it. Use these topics to help you to
prepare for installation, install the product, and verify the installation. There is also information to help
you to uninstall the product.

About this task

To get started with installing IBM MQ, see the topics for the platforms that your enterprise uses. For
concepts and considerations relating to installation, see “IBM MQ installation overview” on page 5.
You can also apply and remove maintenance to IBM MQ. See Applying maintenance to IBM MQ.
Attention: The information in this section applies to both Continuous Delivery (CD) and Long Term
Support (LTS) releases.
Any information that applies specifically to an LTS or CD release is marked with the appropriate
icon.

For tutorials to help you with installing and upgrading, see A

collection of tutorials for installing and upgrading IBM MQ on AIX®, Linux®, and Windows. The tutorials
cover:
• Preparing a host for IBM MQ.
• Downloading the IBM MQ code.
• Installing and uninstalling the IBM MQ code, and applying fix packs.
• Upgrading from one version of IBM MQ to another, and moving a queue manager from one host to
another.

Procedure
1. To find information on installing IBM MQ, see the appropriate sections for the platform, or platforms,
that your enterprise uses:

• “Installing and uninstalling IBM MQ on AIX” on page 32

• “Installing IBM MQ on Linux using rpm” on page 108

• “Installing and uninstalling IBM MQ on Windows” on page 162

• “Installing IBM MQ for z/OS” on page 278

2. To find out about concepts and considerations relating to installation, see “IBM MQ installation
overview” on page 5.

IBM MQ installation overview

An overview of concepts and considerations for installing IBM MQ, with links to instructions on how to
install, verify, and uninstall IBM MQ on each of the supported platforms.

Related concepts
“Multiple installations on AIX, Linux, and Windows” on page 17
On AIX, Linux, and Windows, it is possible to have more than one copy of IBM MQ on a system.
“Installation considerations for MQ Telemetry” on page 259

© Copyright IBM Corp. 2007, 2023 5

 From IBM WebSphere MQ 7.1, MQ Telemetry is a component of the main IBM MQ product, and is no
longer a separate plugin. You can choose to install MQ Telemetry when you first install IBM MQ, or when
you modify an existing IBM MQ installation.
“Managed File Transfer product options” on page 254
Managed File Transfer can be installed as four different options, depending on your operating system and
overall setup. These options are Managed File Transfer Agent, Managed File Transfer Service, Managed
File Transfer Logger, or Managed File Transfer Tools.
Related tasks
Maintaining and migrating
Installing Advanced Message Security
Use the information for your platform to guide you through installing the Advanced Message Security
(AMS) component.

IBM MQ components and features

You can select the components or features that you require when you install IBM MQ.
Important: Ensure that your enterprise has the correct license, or licenses, for the components that you
are going to install. For more information, see “License requirements” on page 8 and IBM MQ license
information.
Also review the information on hardware and software requirements for the platform on which you are
planning to install IBM MQ. For more information, see “Where to find product requirements and support
information” on page 9.

Installation of IBM MQ on Multiplatforms

IBM MQ can be installed as a server or a client. The installation images can be downloaded (see “Where
to find downloadable installation images” on page 9), or IBM MQ can be installed from a DVD.
From IBM MQ 9.1, separate client eImages are no longer available for downloading from Passport
Advantage. A separate client DVD is also no longer available. Instead, you can either obtain the client
eImage from inside the main IBM MQ server eImage, or server DVD, which include the server and client.
Alternatively, you can download the IBM MQ client components from Fix Central. Follow the links in
Resource adapter, clients and other resources.
An IBM MQ server is an installation of one or more queue managers that provide queuing services to one
or more clients. All the IBM MQ objects, for example queues, exist only on the queue manager machine
(the IBM MQ server machine), and not the client. An IBM MQ server can also support local IBM MQ
applications.
An IBM MQ MQI client is a component that allows an application running on one system to communicate
with a queue manager running on another system. The output from the call is sent back to the client,
which passes it back to the application.
For detailed explanations of all the components that you can install, see:

• “IBM MQ components for AIX systems” on page 33

• “IBM MQ components for IBM i” on page 63

• “IBM MQ rpm components for Linux systems” on page 109

• “IBM MQ Debian components for Linux Ubuntu systems” on page 127

• “IBM MQ features for Windows systems” on page 163

For information about how to install IBM MQ on each supported platform, see the links in the following
table:

6 Installing IBM MQ
Table 1. Where to find IBM MQ installation information for each platform
Platform IBM MQ server IBM MQ client
“Installing IBM MQ server on “Installing an IBM MQ client on
AIX
AIX” on page 42 AIX” on page 47
“Installing IBM MQ server on IBM “Installing an IBM MQ client on
IBM i
i” on page 66 IBM i” on page 79
“Installing the first IBM MQ “Installing an IBM MQ client on
Linux
installation on Linux using the Linux using rpm” on page 120
rpm command” on page 113
“Installing an IBM MQ server “Installing an IBM MQ client
Linux
on Linux Ubuntu using Debian on Linux Ubuntu using Debian
packages” on page 131 packages ” on page 137
“Installing IBM MQ server on “Installing an IBM MQ client on
Windows
Windows” on page 182 Windows” on page 209

For more information about installing IBM MQ Advanced for Multiplatforms, see “Installing
IBM MQ Advanced for Multiplatforms” on page 245.

Note: Up to and including IBM MQ 8.0, IBM WebSphere MQ for HP NonStop Server
was also a component platform. Since then, this component has been supplied and supported separately
as IBM MQ for HPE NonStop V8.1, which provides IBM MQ on HPE NonStop L-series and J-series
platforms. The documentation is here: IBM MQ for HPE NonStop V8.1.

Installing IBM MQ clients and servers

A client can be installed on its own, on a separate machine from the base product and server. It is also
possible to have both a server and a client installation on the same system.
To install an IBM MQ client on a system that is already running an IBM MQ server, you must use
the appropriate Server DVD or eImage downloaded from Passport Advantage (see “Where to find
downloadable installation images” on page 9).
From IBM MQ 9.1, separate client eImages are no longer available for downloading from Passport
Advantage. A separate client DVD is also no longer available. Instead, you can either obtain the client
eImage from inside the main IBM MQ server eImage, or server DVD, which include the server and client.
Alternatively, you can download the IBM MQ client components from Fix Central. Follow the links in
Resource adapter, clients and other resources.
Even if your client and server are installed on the same system, you must still define the MQI channel
between them. See Defining MQI channels for details.

Advanced Message Security, Managed File Transfer, MQ Telemetry, and Replicated

data queue managers (RDQM)
Advanced Message Security, Managed File Transfer, MQ Telemetry, and RDQM are separately installed
components of IBM MQ. Make sure that you purchase a license for using IBM MQ Advanced before
installing any of these components (see IBM MQ license information). See “Installing IBM MQ Advanced
for Multiplatforms” on page 245 for installation instructions.

Installation of IBM MQ on z/OS

Installing and uninstalling IBM MQ 7

 For information on installation options for IBM MQ for z/OS, see “Installing IBM MQ for z/OS” on page
278.
For information on installation options for IBM MQ Advanced for z/OS, see “Installing IBM MQ Advanced
for z/OS” on page 289.

For information on installation options for IBM MQ Advanced for z/OS Value Unit Edition,
see “Installing IBM MQ Advanced for z/OS Value Unit Edition” on page 291.
Related concepts
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.
“Where to find downloadable installation images” on page 9
You download installation images for IBM MQ from Passport Advantage, Fix Central, or (for z/OSsystems)
the ShopZ website. A number of IBM MQ components including fix packs, CSUs, clients, and the resource
adapter are also available for downloading from Fix Central and elsewhere.

License requirements
You must have purchased sufficient licenses for your installation. The details of the license agreement
is stored on your system at installation time so that you can read it at any time. IBM MQ supports IBM
License Metric Tool (ILMT).
Important: Ensure that your enterprise has the correct license, or licenses, for the components that you
are going to install. See IBM MQ license information for more details.

License files
At installation, the license agreement files are copied into the /licenses directory under the
MQ_INSTALLATION_PATH. You can read them at any time.

If you have installed a trial license, follow the instructions for converting a trial license on
the platform, or platforms, your enterprise uses.

On IBM i, you can use the WRKSFWAGR command to view the software licenses.

ILMT
ILMT automatically detects IBM MQ, if you are using it, and checks with it each time a queue manager is
started. You do not need to take any further action. You can install ILMT before or after IBM MQ.
The automatic detection applies to both the IBM MQ server and IBM MQ Java products.
Related concepts
“Hardware and software requirements on Linux systems” on page 95
Before you install IBM MQ, check that your system meets the hardware and operating system software
requirements for the particular components you intend to install.
“Hardware and software requirements on IBM i systems” on page 63
Check that the server environment meets the prerequisites for installing IBM MQ for IBM i.
“Hardware and software requirements on Windows systems” on page 173
Check that the server environment meets the prerequisites for installing IBM MQ for Windows and install
any prerequisite software that is missing from your system from the server DVD.
Related tasks
“Checking requirements on Windows” on page 173

8 Installing IBM MQ
 Before you install IBM MQ on Windows, you must check for the latest information and system
requirements.

Where to find product requirements and support information

Before you install IBM MQ, you must check for the latest information and system requirements.
You can consult the following sources to check that you have the information that you need to help you
with planning your installation, including information on hardware and software requirements:
IBM MQ System Requirements website
For details of the supported operating systems, and the prerequisites, supported software, and
hardware requirements for each supported operating system, go to the System Requirements for
IBM MQ website and follow the links to the Detailed System Requirements report for the version of
IBM MQ that you are installing. You can select a report for a specific operating system or for a specific
component. In both cases, there are separate reports for Long Term Support and Continuous Delivery.
Product readme file
The product readme file includes information about last minute changes and known problems and
workarounds. The latest version is available at the IBM MQ, WebSphere MQ, and MQSeries® product
readmes web page. Always check to see that you have the latest version of the product readme file.
Support information
The IBM MQ support web page is regularly updated with the latest product support information. For
example, if you are migrating from an earlier version, look under the heading Solve a problem for the
document Problems and solutions when migrating.
Related concepts
“IBM MQ installation overview” on page 5
An overview of concepts and considerations for installing IBM MQ, with links to instructions on how to
install, verify, and uninstall IBM MQ on each of the supported platforms.
“Hardware and software requirements on AIX systems” on page 36
Before you install IBM MQ, check that your system meets the hardware and operating system software
requirements for the particular components you intend to install.
“Hardware and software requirements on IBM i systems” on page 63
Check that the server environment meets the prerequisites for installing IBM MQ for IBM i.
“Hardware and software requirements on Linux systems” on page 95
Before you install IBM MQ, check that your system meets the hardware and operating system software
requirements for the particular components you intend to install.
“Hardware and software requirements on Windows systems” on page 173
Check that the server environment meets the prerequisites for installing IBM MQ for Windows and install
any prerequisite software that is missing from your system from the server DVD.
Related tasks
Applying maintenance to IBM MQ
“Installing IBM MQ for z/OS” on page 278
Installation tasks that are associated with installing IBM MQ on z/OS systems are grouped in this section.

Where to find downloadable installation images

You download installation images for IBM MQ from Passport Advantage, Fix Central, or (for z/OSsystems)
the ShopZ website. A number of IBM MQ components including fix packs, CSUs, clients, and the resource
adapter are also available for downloading from Fix Central and elsewhere.
Note: This topic gives background information on the various types of downloadable images, and the
various sites from which you can download them. If you are already familiar with this information, and are
ready to download the latest images, go to Downloading IBM MQ 9.2 then select the tab for the specific
release, fix pack or CSU that you require.

Installing and uninstalling IBM MQ 9

 Passport Advantage
There are two Passport Advantage offerings. Passport Advantage is designed for larger enterprises and
enterprises with multiple sites. Passport Advantage Express® is designed for smaller enterprises and
single-site enterprises.
See the Passport Advantage and Passport Advantage Express web site for further information on how you:
• Acquire new IBM software licenses.
• Renew Software Subscription and Support and Fixed Term Licenses.
• Buy and renew technical support for some Selected Open Source and other non-warranted applications.
• Subscribe to IBM SaaS offerings and acquire IBM Appliances.
You download IBM MQ Server eAssemblies for the full release on all supported platforms from Passport
Advantage. The eImages that make up the full release can be downloaded individually if you do not need
the full release.
The initial release is IBM MQ 9.2.0. For Long Term Support (LTS) users, it brings you up to date with the
new functions that were incrementally added into IBM MQ 9.1 by the Continuous Delivery (CD) releases.
For CD users, it is the next CD release after IBM MQ 9.1.5.
A free 90-day trial version of the LTS release, for each of the last two IBM MQ major versions, is available
for download here: https://www.ibm.biz/ibmmqtrial. This is useful if you want to try out IBM MQ, or if you
are waiting for a full version purchase to complete. When your purchase completes, you can convert your
trial installation to a full production copy.
From IBM MQ 9.1, separate client eImages are no longer available for downloading from Passport
Advantage. A separate client DVD is also no longer available. Instead, you can either obtain the client
eImage from inside the main IBM MQ server eImage, or server DVD, which include the server and client.
Alternatively, you can download the IBM MQ client components from Fix Central. Follow the links in
Resource adapter, clients and other resources.

From IBM MQ 9.1.4, you can also download the

IBM Aspera fasp.io Gateway from Passport Advantage.

Note: Prior to 1Q 2023, non-install images for building your own

IBM MQ queue manager container images were available from Passport Advantage. These images are
now available on Fix Central. Follow the link in Resource adapter, clients and other resources.

Fix Central (for Multiplatforms Fix Packs and CSUs)

You download IBM MQ for Multiplatforms Fix Packs and Cumulative security updates (CSUs) from Fix
Central. For more information and download links, go to Downloading IBM MQ 9.2, then select the tab for
the release, fix pack or CSU that you require.

Shopz (for z/OS releases and fixes)

IBM MQ for z/OS downloads are available from the Shopz website. You have two options:
• Order the features as a new product installation.
• Apply PTFs to a previously installed release.
For more information and download links, go to Downloading IBM MQ 9.2, then select the tab for the
release, fix pack or CSU that you require.
For complete information on IBM MQ for z/OS product packaging, see the Release For Announcement
(RFA) on the IBM Offering Information site.

10 Installing IBM MQ
Resource adapter, clients and other resources
A number of IBM MQ resources are also made available on Fix Central and elsewhere.
Clients:
• IBM MQ C and .NET clients
• IBM MQ Java / JMS client
• IBM MQ Java client components (on Maven)
• IBM MQ redistributable clients
• IBM MQ Resource Adapter - For use with any Java EE 7 compliant application server
• IBM MQ redistributable Managed File Transfer Agents
• IBM MQ classes for .NET Standard (on NuGet)
• IBM MQ classes for XMS .NET Standard (on NuGet)
Components:
• IBM MQ Internet Pass-Thru
• IBM MQ Explorer - This stand-alone install image is not currently supported on Windows Server 2019.
For Windows Server 2019, install from the main IBM MQ install image from Passport Advantage.
• IBM MQ Appliance firmware update - Entitlement needed.
• IBM MQ on AWS Quick Start
Containers:
• Prebuilt: IBM MQ Advanced container (subject to entitlement)
• Build your own: https://github.com/ibm-messaging/mq-container. This works in conjunction with the
non-install (unzippable) IBM MQ images to build an IBM MQ container image that can run under the Red
Hat® OpenShift® anyuid security context constraint (SCC)
– For production environments the three non-install images for Linux (subject to entitlement) are
available here:
- IBM MQ Advanced non-install images for Linux
Note that any version of the certified container is supported for one year only when used as part of an
IBM MQ CD release, or two years (with an optional extension for another year) when used as part of
an IBM Cloud Pak® for Integration LTS release.
– For development environments the non-install packages can be found at the following locations:
- IBM MQ Advanced for Developers non-install image for Linux x86-64
- IBM MQ Advanced for Developers non-install image for Linux PPCLE
- IBM MQ Advanced for Developers non-install image for Linux systemZ
– A sample helm chart is also available here: https://github.com/ibm-messaging/mq-helm
Development:
• IBM MQ Advanced for Developers - Windows / Linux / Ubuntu / Raspberry Pi (as-is, see the readme)
• IBM MQ Mac Toolkit for Development - For those who want to develop MQ applications on macOS. The
client is also used in the Get started with IBM MQ tutorials.
• IBM MQ Advanced for Developers container (on Docker Hub). Or build your own.

SupportPacs
IBM MQ SupportPacs provide downloadable code and documentation that complements the IBM MQ
family of products. Each SupportPac supplies a particular function or service that can be used with one or
more of the IBM MQ products.
• SupportPacs for IBM MQ and other project areas

Installing and uninstalling IBM MQ 11

 • IBM MQ - SupportPacs by Product
Related concepts
“IBM MQ code signatures” on page 12
From IBM MQ 9.2.4, downloadable .zip, and .tar.gz files are signed. Installable .rpm and .deb files
are also signed. Where possible the signature is embedded in the file. For file formats that do not allow
this, a separate .sig file is made available containing the signatures and the public keys that are used to
sign the IBM MQ binary files.
“IBM MQ components and features” on page 6
You can select the components or features that you require when you install IBM MQ.
Related tasks
Downloading IBM MQ classes for .NET Standard from the NuGet repository
Downloading IBM MQ classes for XMS .NET Standard from the NuGet repository
IBM MQ Internet Pass-Thru
IBM MQ in containers
Related reference
IBM MQ license information
Related information
IBM MQ downloads for developers

IBM MQ code signatures

From IBM MQ 9.2.4, downloadable .zip, and .tar.gz files are signed. Installable .rpm and .deb files
are also signed. Where possible the signature is embedded in the file. For file formats that do not allow
this, a separate .sig file is made available containing the signatures and the public keys that are used to
sign the IBM MQ binary files.
IBM MQ public certificates, checksums, pgp key and .sig files can be downloaded from the extra
download packages at https://ibm.biz/mq92signatures.

*.zip files
IBM MQ deliverables in .zip file form contain an embedded digital signature that can be verified by using
a recent Java Development Kit (JDK) as shown in the following example:

jarsigner -certs -verify 9.2.4.0-IBM-MQC-Redist-Java.zip

jar verified.

Note: More details, including the signer, can be found by running with the verbose option.

*.tar.gz files
IBM MQ deliverables in *.tar.gz file form are signed by IBM MQ and their digital signatures are
provided in the extra downloadable package. To verify a file's signature, use openssl as shown in the
following example for 9.2.4.0-IBM-MQC-Redist-LinuxX64.tar.gz:

openssl dgst -sha256 -verify ibm_mq_public.pem -signature 9.2.4.0-IBM-MQC-Redist-

LinuxX64.tar.gz.sig 9.2.4.0-IBM-MQC-Redist-LinuxX64.tar.gz
Verified OK

12 Installing IBM MQ
*.rpm
The IBM-provided RPMs are signed with a digital signature, and systems will not recognize the signing
key without it being authorized. Obtain the IBM MQ public signing gpg key from the extra downloadable
package and install it into rpm. This only needs to be done once per system.

rpm --import ibm_mq_public.pgp

The validity of any of the IBM MQ RPMs can then be verified, for example:

# rpm -Kv MQSeriesRuntime-9.2.4-0.x86_64.rpm

MQSeriesRuntime-9.2.4-0.x86_64.rpm:
Header V3 RSA/SHA256 Signature, key ID 0209b828: OK
Header SHA1 digest: OK
V3 RSA/SHA256 Signature, key ID 0209b828: OK
MD5 digest: OK

Note: If you skip this step, then a harmless warning might be issued during RPM installation to indicate
there is a signature but the system does not recognize the signing key, for example:
warning: MQSeriesRuntime-9.2.4-0.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID 0209b828:
NOKEY

*.deb
The IBM provided debian type packages are signed with an embedded digital signature. To verify a
package you will need the IBM MQ public signing gpg key from the additional package, and the “debsigs”
operating system package installed.
1. Import the gpg key and identify its gpg key value:

# gpg --import ibm_mq_public.pgp

gpg: keybox '/root/.gnupg/pubring.kbx' created
gpg: /root/.gnupg/trustdb.gpg: trustdb created
gpg: key D2D53B4E0209B828: public key "IBM MQ signing key <[email protected]>" imported
gpg: Total number processed: 1
gpg: imported: 1

From this, the key value would be D2D53B4E0209B828 and the certificate alias would be “IBM MQ
signing key <[email protected]>”. The following instructions use those values – replace them
with the ones calculated from your import.
2. Export the certificate alias into the system keyrings:

mkdir /usr/share/debsig/keyrings/D2D53B4E0209B828/
cd /usr/share/debsig/keyrings/D2D53B4E0209B828/
gpg --output IBMMQ.bin --export "IBM MQ signing key <[email protected]>"

3. Set up the system to enable a signing policy for this key:

mkdir /etc/debsig/policies/D2D53B4E0209B828/
cd /etc/debsig/policies/D2D53B4E0209B828/

Create a file called IBM-MQ.pol in this directory with the following contents. Note that only the ‘id’
fields need changing to the key value from step 1.

<?xml version="1.0"?>
<!DOCTYPE Policy SYSTEM "https://www.debian.org/debsig/1.0/policy.dtd">
<Policy xmlns="https://www.debian.org/debsig/1.0/">
<Origin Name="IBM MQ signing key" id="D2D53B4E0209B828" Description="IBM MQ signing key"/>
<Selection>
<Required Type="origin" File="IBMMQ.bin" id="D2D53B4E0209B828"/>
</Selection>
<Verification MinOptional="0">
<Required Type="origin" File="IBMMQ.bin" id="D2D53B4E0209B828"/>
</Verification>
</Policy>

4. Validate packages individually using the debsig-verify utility:

Installing and uninstalling IBM MQ 13

 # debsig-verify ibmmq-runtime_9.2.4.0_amd64.deb
debsig: Verified package from 'IBM MQ signing key' (IBM MQ signing key)

Note: Whilst it is possible to configure dpkg to verify signatures during installation, this is not advisable as
it will cause dpkg to reject the installation of unsigned Debian files.
Related tasks
“Installing the first IBM MQ installation on Linux using the rpm command” on page 113
You can install an IBM MQ server on a 64-bit Linux system using rpm. The instructions in this topic are for
the first installation of IBM MQ on a Linux system.
“Installing an IBM MQ client on Linux using rpm” on page 120
Installing an IBM MQ client on a 64 bit Linux system.
“Installing IBM MQ on Linux Red Hat using yum” on page 123
From IBM MQ 9.2.0 you can install IBM MQ on Linux Red Hat by using the yum installer.

Planning considerations for installation on Multiplatforms

Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.
Before you start installing, consider how you want to use IBM MQ and review the information in this
section, and also the information in the general Planning section.
When planning your installation, make sure that you check the hardware and software requirements for
your system. For more information, see “Where to find product requirements and support information” on
page 9.

Note: This information is about planning an installation on IBM MQ for Multiplatforms. For
information about planning an installation on z/OS, see “Planning to install IBM MQ for z/OS” on page
281.

Installation name on AIX, Linux, and Windows

Each installation of IBM MQ on AIX, Linux, and Windows, has a unique identifier known as an installation
name. The installation name is used to associate things such as queue managers and configuration files
with an installation.
You can choose the installation name and make it meaningful to you. For example, you might call a test
system testMQ.
If you do not specify an installation name when the product is installed, a default installation name is
automatically assigned. For the first installation, this name is Installation1. For the second installation, the
name is Installation2, and so on. The installation name cannot be changed after the product is installed.

On AIX and Linux systems, the first IBM MQ installation is automatically given
an installation name of Installation1.
Note: For subsequent installations, you can use the crtmqinst command to set the installation name
before installing the product.

On Windows systems, you can choose the installation name during the installation process.
The installation name can be up to 16 bytes and must be a combination of alphabetic and numeric
characters in the ranges a-z, A-Z, and 0-9. You cannot use blank characters. The installation name must
be unique, regardless of whether uppercase or lowercase characters are used. For example, the names
INSTALLATIONNAME and InstallationName are not unique.
You can find out what installation name is assigned to an installation in a particular location using the
dspmqinst command.

14 Installing IBM MQ
Installation descriptions
Each installation can also have an installation description. This description can give more detailed
information about an installation in cases where the installation name cannot provide enough information.
These descriptions can be up to 64 single-byte characters, or 32 double-byte characters. The default
installation description is blank. You can set the installation description using the setmqinst command.
Related concepts
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
“Installation location on Multiplatforms” on page 15
You can install IBM MQ into the default location. Alternatively, you can install into a custom
location during the installation process. The location where IBM MQ is installed is known as the
MQ_INSTALLATION_PATH.
“IBM MQ components and features” on page 6
You can select the components or features that you require when you install IBM MQ.
Related reference
dspmqinst
setmqinst
crtmqinst

Installation location on Multiplatforms

You can install IBM MQ into the default location. Alternatively, you can install into a custom
location during the installation process. The location where IBM MQ is installed is known as the
MQ_INSTALLATION_PATH.

Default location
The default location for the IBM MQ product code is shown in the following table:

Table 2. Installation location of IBM MQ

Platform Installation location
/usr/mqm
AIX
/QIBM/ProdData/mqm
IBM i
/opt/mqm
Linux
C:\Program Files\IBM\MQ
Windows systems
C:\ProgramData\IBM\MQ
Windows data directories

Important: For Windows installations, the directories are as stated, unless there is a
previous installation of the product that still contains registry entries or queue managers, or both. In
this situation, the new installation uses the old data directory location. For more information, see Program
and data directory locations.

Installing and uninstalling IBM MQ 15

 On IBM i, IBM MQ can only be installed in the default location. For more information about
the directory structure of IBM i, see Directory structure on IBM i

On AIX and Linux systems, working data is stored in /var/mqm, but you
cannot change this location. For more information about the directory structure of AIX and Linux systems,
see Directory structure on AIX and Linux systems.

Custom location installation

For an installation into a custom location, the path specified must either be an empty directory, or a path
that does not exist. The length of the path is limited to 256 bytes. Permissions on the path must be such
that the user mqm and users in the mqm group can access the directories.

• On AIX and Linux systems, the path must not contain spaces.

• On AIX, the product is installed into a User Specified Installation Location (USIL), which
can be either an existing USIL or a new USIL that is automatically created by the installation process. If
a custom location is specified, the product location is the path specified during installation, plus /usr/
mqm.
For example, the path specified is /usr/custom_location. The MQ_INSTALLATION_PATH is /usr/
custom_location/usr/mqm.
Access permissions for the USIL directory should be set to rwx for user and r-x for group and others
(755).
• On the following platforms, the product location is the same path as specified during installation:

– Linux

– Windows
For example, on Linux, the path specified is /opt/custom_location. The MQ_INSTALLATION_PATH
is /opt/custom_location.
• On the following platforms, you can install IBM MQ into a non empty MQ_INSTALLATION_PATH
directory:

– Linux
On Linux, you do this by setting the environment variable AMQ_OVERRIDE_EMPTY_INSTALL_PATH to 1
before starting the installation.
Note, that a non empty directory in this context, indicates a directory which contains system files and
directories.
For each installation, all of the IBM MQ components that you require must be installed in the same
location.
For more information about how to install to a custom location, see the installation topics for the
appropriate platform.

Additional location restrictions

New IBM MQ installations should not be located in the following paths:
• In a path that is a subdirectory of another existing installation.
• In a path that is part of the direct path to an existing installation.
If IBM MQ is installed in /opt/IBM/MQ/installations/1, you cannot install in /opt/IBM/MQ/
installations/1/a. Additionally, you should not install a new installation to /opt/IBM/MQ.
However, you can install a new installation in /opt/IBM/MQ/installations/2 or /opt/IBM/
MQnew because neither of these is a part of the direct path /opt/IBM/MQ/installations/1.

16 Installing IBM MQ
• In a path that is a subdirectory of the default location, for example:

– /usr/mqm on AIX.

– /opt/mqm on Linux.
The reason an installation should not be located in a path that is a subdirectory of the default location
is to avoid the risk if you later decide to install IBM MQ into the default location, and cannot then do so.
If you do subsequently install into the default location, because IBM MQ has full access rights over the
installation directory, existing files might be replaced or deleted. Scripts that you might subsequently
run to uninstall IBM MQ might remove the installation directory at the end of the script.
• In a directory or subdirectory that is, or might later be used by another product, for example, an IBM
Db2® installation, or operating system component.
You must not install to any directory located under /opt/IBM/db2 where /opt/IBM/db2 is an
example.
• In a directory or subdirectory that the mqm user or mqm group does not have authority to write to.
Related concepts
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.
“Installation name on AIX, Linux, and Windows” on page 14
Each installation of IBM MQ on AIX, Linux, and Windows, has a unique identifier known as an installation
name. The installation name is used to associate things such as queue managers and configuration files
with an installation.
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
“IBM MQ components and features” on page 6
You can select the components or features that you require when you install IBM MQ.

Multiple installations on AIX, Linux, and Windows

On AIX, Linux, and Windows, it is possible to have more than one copy of IBM MQ on a system.
You can choose where each copy of IBM MQ is installed, but each copy must be in a separate installation
location. A maximum of 128 installations of IBM MQ can exist on a single machine at a time. You have a
choice:
• Keep the simplicity of maintaining and managing a single installation of IBM MQ on a machine.
• Take advantage of the flexibility that is offered by enabling multiple IBM MQ installations.

Decisions to make before installing

Before you install multiple copies of IBM MQ, you must make several decisions:
Where will you install each copy of IBM MQ?
You can choose the installation location for your installations at IBM WebSphere MQ 7.1, or later. For
more information, see “Installation location on Multiplatforms” on page 15.
Do you need a primary installation?
A primary installation is an installation to which system-wide locations refer.
For more information, see “Primary installation on AIX, Linux, and Windows” on page 18.

Installing and uninstalling IBM MQ 17

 How will your applications connect?
You need to consider how your applications locate the appropriate IBM MQ libraries. For more
information, see Connecting applications in a multiple installation environment, and Connecting .NET
applications in a multiple installation environment.
Do your existing exits need changing?
If IBM MQ is not installed in the default location, your exits need to be updated. For more information,
see Writing exits and installable services on AIX, Linux, and Windows .
Which queue manager will be associated with which installation?
Each queue manager is associated with a particular installation. The installation that a queue manager
is associated with limits that queue manager so that it can be administered only by commands from
that installation. For more information, see Associating a queue manager with an installation.
How will you set up your environment to work with each installation?
With multiple installations on a system, you need to consider how you will work with particular
installations, and how you will issue commands from that installation. You can either specify the full
path to the command, or you can use the setmqenv or crtmqenv command to set environment
variables. Setting the environment variables allows you to omit the path to the commands for that
installation. For more information, see setmqenv, and crtmqenv.
When you have answered these questions, you can install IBM MQ after you have read “IBM MQ
installation overview” on page 5.
If you have existing installations of IBM MQ and you want to use the multiple installation capability to
migrate from one version of IBM MQ to another version, see one of the following platform-specific topics:

• Multi-installation queue manager coexistence on AIX, Linux, and Windows

The IBM message service client for .NET support pack and multiple installations
For multiple version support, on IBM WebSphere MQ 7.1 or later, the Java and .NET Messaging and
Web Services feature must be installed with the IBM MQ product. For more information about installing
the .NET feature, see Installing IBM MQ classes for .NET.
Related tasks
Configuring multiple installations
Finding installations of IBM MQ on a system
Migrating on AIX and Linux: side-by-side
Migrating on AIX and Linux: multi-stage
“Choosing MSI Instance IDs for multiple server installations” on page 186
For multiple silent installations, for each version that is installed you must find an MSI instance ID that is
available to use for that installation.
“Choosing MSI Instance IDs for multiple client installations” on page 212
For multiple silent installations, for each version that is installed you must find an MSI instance ID that is
available to use for that installation.

Primary installation on AIX, Linux, and Windows

On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
From IBM WebSphere MQ 7.1, you can install multiple versions of IBM MQ on AIX, Linux, and Windows.
It is possible to have more than one installation of IBM MQ on one of these systems at any time
and, optionally, to configure one of these installations as the primary installation. Environment variables
and symbolic links pointing to a single installation are less meaningful when multiple versions exist.
However, some functions require these system-wide locations to work. For example, custom user scripts
for administering IBM MQ, and third party products. These functions work only on the primary installation.

18 Installing IBM MQ
 On AIX and Linux systems, if you set an installation as the primary installation,
symbolic links to the external libraries and control commands of that installation are added into /usr/
lib, and /usr/bin. If you do not have a primary installation, the symbolic links are not created. For a list
of the symbolic links that are made to the primary installation, see “External library and control command
links to primary installation on AIX and Linux” on page 23.

On Windows systems, the global environmental variables point to the directories into which
the primary installation was installed. These environment variables are used to locate IBM MQ libraries,
control commands, and header files. Additionally, on Windows systems, some features of the operating
system require the central registration of interface libraries that are then loaded into a single process.
With multiple versions of IBM MQ, there would be conflicting sets of IBM MQ libraries. The features would
try to load these conflicting sets of libraries into a single process. Therefore, such features can be used
only with the primary installation. For details about some of the features that are limited to use with the
primary installation, see “Features that can be used only with the primary installation on Windows” on
page 25.
If all the installations on the system are at IBM WebSphere MQ 7.1, or later, you can choose whether to
have a primary installation. Consider the options in Table 3 on page 19.

Table 3. Primary installation options

Valid installation
Options configurations More information
Primar Non-
y primary
Single IBM None If you want to continue working with a single installation in
installation of WebSp the same way as previous releases, configure your installation
IBM WebSphere here as the primary installation. For information about this option,
MQ 7.1, or later. MQ see “Single installation of IBM MQ configured as the primary
7.1, or installation” on page 20
later.
None IBM If you want to continue working with a single installation, but
WebSphere do not want symbolic links or global environment variables
MQ 7.1, or created for you, configure your installation as non-primary. For
later. information about the implications of this option, see “Single
installation of IBM MQ configured as non-primary” on page
21

Multiple IBM IBM If you want to have multiple installations of IBM MQ, you can
installations: WebSp WebSphere choose whether to make one of the installations primary. For
here MQ 7.1, or information about this option, see “Multiple installations of
IBM WebSphere MQ later. IBM MQ” on page 22
MQ 7.1, or later. 7.1, or
later.
None IBM
WebSphere
MQ 7.1, or
later.

Related concepts
“Single installation of IBM MQ configured as the primary installation” on page 20
Marking an IBM MQ installation as primary adds symbolic links, or global environment variables to the
system so that the IBM MQ commands and libraries used by applications are automatically available with
minimum system setup required.
“Single installation of IBM MQ configured as non-primary” on page 21

Installing and uninstalling IBM MQ 19

 If you install IBM MQ as non-primary you might have to configure a library path for applications to load
IBM MQ libraries. On Windows, some product capabilities are available only when IBM MQ is configured
as primary.
“Multiple installations of IBM MQ” on page 22
You can choose to have one of the IBM MQ installations configured as the primary installation. Your choice
depends on how applications locate libraries.
“Installation location on Multiplatforms” on page 15
You can install IBM MQ into the default location. Alternatively, you can install into a custom
location during the installation process. The location where IBM MQ is installed is known as the
MQ_INSTALLATION_PATH.
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.
“Installation name on AIX, Linux, and Windows” on page 14
Each installation of IBM MQ on AIX, Linux, and Windows, has a unique identifier known as an installation
name. The installation name is used to associate things such as queue managers and configuration files
with an installation.
Related tasks
Changing the primary installation

Single installation of IBM MQ configured as the primary installation

Marking an IBM MQ installation as primary adds symbolic links, or global environment variables to the
system so that the IBM MQ commands and libraries used by applications are automatically available with
minimum system setup required.
You decide where to install IBM MQ.
Where possible, configure applications and scripts to use the system search path to find the IBM MQ
control commands or IBM MQ libraries. This configuration of applications and scripts provides maximum
flexibility for undertaking future tasks such as migrating to the next release of IBM MQ, or installing a
second installation. For more information about options for connecting your applications, see Connecting
applications in a multiple installation environment.

On AIX and Linux, the first installation onto a system must be manually
configured to be the primary installation.

On Windows, the first installation is automatically configured as the primary installation.

Set the primary installation using the setmqinst command. For more information, see “Uninstalling,
upgrading, and maintaining the primary installation” on page 25.
Related concepts
“Installation location on Multiplatforms” on page 15
You can install IBM MQ into the default location. Alternatively, you can install into a custom
location during the installation process. The location where IBM MQ is installed is known as the
MQ_INSTALLATION_PATH.
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.
“Installation name on AIX, Linux, and Windows” on page 14
Each installation of IBM MQ on AIX, Linux, and Windows, has a unique identifier known as an installation
name. The installation name is used to associate things such as queue managers and configuration files
with an installation.
Related tasks
Changing the primary installation

20 Installing IBM MQ
 Single installation of IBM MQ configured as non-primary
If you install IBM MQ as non-primary you might have to configure a library path for applications to load
IBM MQ libraries. On Windows, some product capabilities are available only when IBM MQ is configured
as primary.

AIX and Linux systems

The implications of running a non-primary installation on AIX or Linux are as follows:

• Applications that locate their IBM MQ libraries using an embedded library path, for example, RPATH,
cannot find those libraries if the following conditions are true:
– IBM MQ is installed in a different directory from the directory specified in the RPATH
– There are no symbolic links in /usr
• Where applications locate their libraries using an external library path, for example, LD_LIBRARY_PATH,
you must configure the external library path to include the MQ_INSTALLATION_PATH/lib or
MQ_INSTALLATION_PATH/lib64 directory. The setmqenv and crtmqenv commands can configure a
number of environment variables in the current shell, including the external library path.
• Most IBM MQ processes run as setuid/setgid. As a result, when loading user exits they ignore the
external library path. User exits that reference IBM MQ libraries can find those libraries only if they are
found in the library path embedded within them. They would be resolved if there were a symbolic link
in /usr. User exits that are intended to be run on IBM WebSphere MQ 7.1, or later, can now be built
so that they do not refer to IBM MQ libraries at all. Instead they rely on IBM MQ to pass in function
pointers to the IBM MQ functions that the exit can then use. For more information, see Writing exits and
installable services on AIX, Linux, and Windows .
For more information about options for connecting your applications, see Connecting applications in a
multiple installation environment.
On AIX and Linux platforms, the first installation onto a system is not automatically configured as the
primary installation. However, a single symbolic link is included in /usr/bin to locate the dspmqver
command. If you do not want any symbolic links, you must remove this link using the following command:

setmqinst -x -p MQ_INSTALLATION_PATH

Windows systems

The implications of running a non-primary installation on Windows are:

• Applications normally find their libraries using the external library path, PATH. There is no concept of
an embedded library path or explicit library location. If the installation is non-primary, the global PATH
environment variable does not contain the IBM MQ installation directory. For applications to find IBM
MQ libraries, update the PATH environment variable to reference the IBM MQ installation directory. The
setmqenv and crtmqenv commands can configure a number of environment variables in the current
shell, including the external library path.
• Some product capabilities are available only when an installation is configured as the primary
installation; see “Features that can be used only with the primary installation on Windows” on page
25.
By default, on Windows, the first installation is automatically configured as primary. You must manually
deselect it as the primary installation.
Related concepts
“Installation location on Multiplatforms” on page 15

Installing and uninstalling IBM MQ 21

 You can install IBM MQ into the default location. Alternatively, you can install into a custom
location during the installation process. The location where IBM MQ is installed is known as the
MQ_INSTALLATION_PATH.
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.
“Installation name on AIX, Linux, and Windows” on page 14
Each installation of IBM MQ on AIX, Linux, and Windows, has a unique identifier known as an installation
name. The installation name is used to associate things such as queue managers and configuration files
with an installation.
Related tasks
Changing the primary installation
Related reference
setmqenv
crtmqenv

Multiple installations of IBM MQ

You can choose to have one of the IBM MQ installations configured as the primary installation. Your choice
depends on how applications locate libraries.
The IBM MQ libraries, such as mqm, which ship with the product automatically use libraries of the level
required by the queue manager to which they are connecting. This means that provided an application
locates its IBM MQ libraries from an IBM MQ installation, it can connect to any queue manager on that
system. Having one installation configured as primary ensures that if the application finds its IBM MQ
interface library, the application can connect to any queue manager.
For more information about connecting applications in a multiple installation environment, see
Connecting applications in a multiple installation environment.
The primary installation is not automatically changed when you uninstall the primary installation. If you
want another installation to be the primary installation, you must manually set the primary installation
using the setmqinst command. For more information, see “Uninstalling, upgrading, and maintaining the
primary installation” on page 25.
Related concepts
“Installation location on Multiplatforms” on page 15
You can install IBM MQ into the default location. Alternatively, you can install into a custom
location during the installation process. The location where IBM MQ is installed is known as the
MQ_INSTALLATION_PATH.
“Multiple installations on AIX, Linux, and Windows” on page 17
On AIX, Linux, and Windows, it is possible to have more than one copy of IBM MQ on a system.
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.
“Installation name on AIX, Linux, and Windows” on page 14
Each installation of IBM MQ on AIX, Linux, and Windows, has a unique identifier known as an installation
name. The installation name is used to associate things such as queue managers and configuration files
with an installation.
Related tasks
Changing the primary installation

22 Installing IBM MQ
 External library and control command links to primary
installation on AIX and Linux
On AIX and Linux platforms the primary installation is the one to which links from the /usr file system are
made. However, only a subset of those links created with previous releases are now made.
No links are created from /usr/include to any installation and only links to external libraries
and documented control commands are made from /usr/lib, and where appropriate, /usr/lib64
(external libraries) and /usr/bin (control commands).
In order to run these commands you must complete the following steps:
1. provide a full path to the command in an available IBM MQ installation,
2. use the setmqenv script to update your shell environment,
3. manually add the bin directory from an IBM MQ installation directory to your PATH,
4. run the setmqinst command as root to make one of your existing IBM MQ installations the primary
installation.

External libraries
Links are made to the following external libraries, both 32-bit and 64-bit:
• libmqm
• libmqm_r
• libmqmxa
• libmqmxa_r
• libmqmax
• libmqmax_r
• libmqmcb
• libmqmcb_r
• libmqic
• libmqic_r
• libmqcxa
• libmqcxa_r
• libmqicb
• libmqicb_r
• libimqb23ia
• libimqb23ia_r
• libimqc23ia
• libimqc23ia_r
• libimqs23ia
• libimqs23ia_r
• libmqmzf
• libmqmzf_r
The following 64-bit only libraries are also linked to:
• libmqmxa64
• libmqmxa64_r
• libmqcxa64
• libmqcxa64_r

Installing and uninstalling IBM MQ 23

 Control commands
The following control commands are linked to from /usr/bin:
• addmqinf
• amqcrs6a
• amqcrsta
• amqmfsck
• crtmqinst
• dltmqinst
• dspmqinst
• setmqinst
• crtmqcvx
• crtmqm
• dltmqm
• dmpmqaut
• dmpmqlog
• dspmq
• dspmqaut
• dspmqcsv
• dspmqfls
• dspmqinf
• dspmqrte
• dspmqtrc
• dspmqtrn
• dspmqver
• endmqcsv
• endmqlsr
• endmqm
• endmqtrc
• rcdmqimg
• rcrmqobj
• rmvmqinf
• rsvmqtrn
• runmqchi
• runmqchl
• runmqckm
• runmqdlq
• runmqlsr
• runmqsc
• runmqtmc
• runmqtrm
• setmqaut
• setmqenv
• setmqm

24 Installing IBM MQ
• setmqprd
• strmqcsv
• strmqikm
• strmqm
• strmqtrc
Related concepts
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
“Features that can be used only with the primary installation on Windows” on page 25
Some Windows operating-system features can be used only with the primary installation. This restriction
is due to the central registration of interface libraries, which might conflict as a result of multiple versions
of IBM MQ being installed.

Features that can be used only with the primary installation on Windows
Some Windows operating-system features can be used only with the primary installation. This restriction
is due to the central registration of interface libraries, which might conflict as a result of multiple versions
of IBM MQ being installed.

The .NET monitor

The IBM MQ .NET monitor can run in two different modes: transactional and non-transactional. The
transactional mode uses MSDTC transaction coordination and requires that the .NET monitor is registered
with COM+. The .NET monitor from the primary installation is the only .NET monitor that is registered with
COM+.
Any attempt to run the .NET monitor in transactional mode with a non-primary installation
results in the failure of the .NET monitor to enlist with MSDTC. The .NET monitor receives an
MQRC_INSTALLATION_MISMATCH error, which in turn results in an AMQ8377 error message on the
console.
Related concepts
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
“External library and control command links to primary installation on AIX and Linux” on page 23
On AIX and Linux platforms the primary installation is the one to which links from the /usr file system are
made. However, only a subset of those links created with previous releases are now made.

Uninstalling, upgrading, and maintaining the primary installation

On all platforms, if you uninstall the primary installation, it ceases to be the primary installation. You must
run the setmqinst command to select a new primary installation. On Windows, if you update the primary
installation, it continues to be the primary installation. If you apply a fix pack to the primary installation, it
continues to be the primary installation.
Be cautious about the effect uninstalling or upgrading the primary installation has on applications.
Applications might be using the linkage library of the primary installation to switch to the linkage library
of another installation. If such an application is running, you might not be able to uninstall the primary
installation. The operating system might have locked the link library of the primary installation on behalf
of the application. If the primary installation has been uninstalled, an application that loads the IBM MQ
libraries it requires by linking to the primary installation is not able to start.
The solution is to switch the primary installation to another installation before uninstalling. Stop, and
restart applications that are linked through the previous primary installation before uninstalling it.

Installing and uninstalling IBM MQ 25

 Windows

If you update the primary installation, it stops being the primary installation at the beginning of the
update procedure. If, by the end of the update procedure, you have not made another installation primary,
the upgraded installation is made primary again.

Maintenance
If you apply a fix pack to the primary installation, it stops being the primary installation at the beginning
of the maintenance procedure. If, by the end of the maintenance procedure, you have not made another
installation primary, the upgraded installation is made primary again.
Related concepts
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
Related tasks
Changing the primary installation
Applying maintenance to IBM MQ

Server-to-server links on AIX, Linux, and Windows

For verifying a server-to-server verification, the communication links between the two systems must
be checked. Before you can do the verification, you must ensure that the communications protocol is
installed and configured on both systems.
The examples used in the verification tasks listed in this topic for AIX, Linux, and Windows use TCP/IP.
The various communication protocols used by the supported platforms are as follows.

AIX
IBM MQ supports both TCP and SNA. If you do not use TCP, see Setting up communication on AIX and
Linux systems.

Linux
IBM MQ for Linux supports TCP on all Linux platforms. On x86 platforms and Power platforms, SNA
is also supported. If you want to use the SNA LU6.2 support on these platforms, you need the IBM
Communications Server for Linux 6.2. The Communications Server is available as a PRPQ product
from IBM. For more details, see Communications Server.
If you do not use TCP, see Setting up communication on AIX and Linux systems.

Windows
IBM MQ for Windows supports TCP, SNA, NetBios, and SPX. If you do not use TCP, see Setting up
communication for Windows .
Related tasks
“Verifying an IBM MQ installation on AIX” on page 50
The topics in this section provide instructions on how to verify a server or a client installation of IBM MQ
on AIX systems.
“Verifying an IBM MQ installation on Linux” on page 142
The topics in this section provide instructions on how to verify a server or a client installation of IBM MQ
on Linux systems.
“Verifying an IBM MQ installation on Windows” on page 226

26 Installing IBM MQ
The topics in this section provide instructions on how to verify a server or a client installation of IBM MQ
on Windows systems.

Redistributable IBM MQ clients

The IBM MQ redistributable client is a collection of runtime files that are provided in a .zip or .tar file
that can be redistributed to third parties under redistributable license terms, which provides a simple way
of distributing applications and the runtime files that they require in a single package.
For information about redistributable license terms for the redistributable IBM MQ clients, see IBM MQ
Redistributable Components.

What are the IBM MQ redistributable clients?

The redistributable client that is supplied with IBM MQ is also a non-installed and relocatable image.
Maintenance of a redistributable, non-installed image, is achieved through replacement; that is, you
download newer versions of the runtime components when they are shipped.
• A redistributable client implies distributing the required run time with an application both inside and
outside of your environment.
• A relocatable client implies putting the files somewhere else other than a fixed default location. For
example, instead of installing into /opt/ installing into /usr/local.
• A non-installed client implies that you are not required to lay down client files, and that these files can
be copied as required.
From IBM MQ 8.0.0 Fix Pack 4, native redistributable client runtime libraries are provided for Linux
x86-64 and Windows 64-bit platforms to make it simple to distribute both applications and the required
IBM MQ runtime libraries. A third package, which is not platform-specific, contains the runtime files that
are required for the Java/JMS applications, including the IBM MQ resource adapter for JMS applications
that are running under an application server.
Note: For important considerations about bundling the relocatable JAR files for IBM MQ classes for JMS,
see What is installed for IBM MQ classes for JMS.
You can use the files that are contained in the redistributable images to run the following client
applications:
• Native IBM MQ applications using the MQI written in C, C++, and COBOL.
• IBM MQ applications using the IBM MQ classes for Java and IBM MQ classes for JMS.

• IBM MQ using fully managed and unmanaged .NET classes.

From IBM MQ 9.1.0, XMS .NET is shipped as part of the redistributable client. XMS .NET requires the IBM
MQ .NET client (amqmdnet.dll). If unmanaged mode is to be used, then the IBM MQ C client libraries
are also needed along with amqmdnet.dll.
From IBM MQ 9.1.0, Managed File Transfer Agent is optionally provided as an individual redistributable
component, available to be downloaded as a tar package on Linux, or as zip package on Windows. This
option enables developers to download, configure and test a Managed File Transfer Agent, to ensure it
connects to an existing Managed File Transfer configuration and then make the configured agent bundle
available to many users within their organization. Users who are unfamiliar with how Managed File
Transfer works, can easily set up the pre-configured agent on their local environment and quickly connect
to the relevant IBM MQ network. The users do not have to install IBM MQ to be able to transfer files. For
more information, see Configuring the Redistributable Managed File Transfer Agent.

Downloading the redistributable client packages

You can download the redistributable client packages from Fix Central:
• IBM MQ redistributable clients
• IBM MQ redistributable Managed File Transfer Agents

Installing and uninstalling IBM MQ 27

 The file names describe the file contents and equivalent maintenance levels.
For V9R2M0, the downloadable packages for the native redistributable client runtime libraries and JMS
and Java runtime files are available under the following file names:

Long Term Support: 9.2.0 IBM MQ C redistributable client for Linux x86-64
9.2.0.0-IBM-MQC-Redist-LinuxX64.tar.gz

Long Term Support: 9.2.0 IBM MQ C and .NET redistributable client for Windows x64
9.2.0.0-IBM-MQC-Redist-Win64.zip
Long Term Support: 9.2.0 IBM MQ JMS and Java redistributable client
9.2.0.0-IBM-MQC-Redist-Java.zip
For IBM MQ 9.2.0, the downloadable packages for the Redistributable Managed File Transfer Agent are
available under the following file names:

Long Term Support: 9.2.0 Redistributable IBM MQ Managed File Transfer Agent for
Linux X86-64
9.2.0.0-IBM-MQFA-Redist-LinuxX64

Long Term Support: 9.2.0 Redistributable IBM MQ Managed File Transfer Agent for
Linux on z Systems
9.2.0.0-IBM-MQFA-Redist-LinuxS390X

Long Term Support: 9.2.0 Redistributable IBM MQ Managed File Transfer Agent for
Linux PPC (Little Endian)
9.2.0.0-IBM-MQFA-Redist-LinuxPPC64LE

Long Term Support: 9.2.0 Redistributable IBM MQ Managed File Transfer Agent for
Windows x64
9.2.0.0-IBM-MQFA-Redist-Win64
The IBM IPLA license agreement is extended for IBM MQ to enable you to download a number of
additional runtime files from Fix Central.
Related concepts
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.
“Installation location on Multiplatforms” on page 15
You can install IBM MQ into the default location. Alternatively, you can install into a custom
location during the installation process. The location where IBM MQ is installed is known as the
MQ_INSTALLATION_PATH.
“Redistributable clients on Linux” on page 139
The Linux x86-64 image is shipped in a LinuxX64.tar.gz file.
“Redistributable clients on Windows” on page 224
The Windows 64-bit image is shipped in a Win64.zip file.
“.NET application runtime - Windows only” on page 225
Considerations when using the .NET application.
Related tasks
Configuring the Redistributable Managed File Transfer Agent

28 Installing IBM MQ
 Limitations and other considerations for redistributable
clients
There are a number of points to consider when installing the IBM MQ C redistributable client for Linux
x86-64 and the IBM MQ C and .NET redistributable client for Windows x64 packages.

Limitations
GSKit objects
No new GSKit objects are shipped. Only the runtime files are shipped, both in a regular installation
and with the redistributable client.
IBM JREs
No IBM JREs are provided with the redistributable client.
If you want to run Java/JMS applications, you must provide your own runtime environment. Your
JRE, that applications run under, must meet the current SOE requirements and are bound by any
restrictions or limitations that apply.
Developing applications
Before IBM MQ 9.2.0, all other files that support the development and distribution of applications
(including copybooks, header files, and sample source code) are not available in any of the
redistributable client packages, including the IBM MQ C redistributable client packages, and are not
licensed for redistribution. If you need to develop IBM MQ applications, you still need to perform a
traditional installation so that you obtain the SDK files that are required to build client applications.

From IBM MQ 9.2.0, this limitation no longer applies to the IBM MQ C redistributable
client packages. From IBM MQ 9.2.0, the IBM MQ C redistributable client packages include the
elements required to build the application, that is the header files and copybooks. However, the
sample source code is still not included in these packages.

Windows C runtime libraries

You might have these libraries on your machine already, but if you do not, you need to download and
install the following Microsoft C/C++ runtime libraries:
• Microsoft Visual C++ Redistributable 2008
• Microsoft Visual C++ Redistributable 2012
The download links for the redistributable downloads for each of these libraries can be found at The
latest supported Visual C++ downloads.
The redistributable Java client does not include any of the files related to the JMSAdmin tool
A client installed by unpacking the redistributable Java client does not contain the JMSAdmin tool,
or its prerequisite JAR files fscontext.jar and providerutil.jar. This means that the client
cannot connect to any file system contexts (.bindings files) created by a different installation that
does have the JMSAdmin tool.
If you want to use a pre-existing file system context (.bindings file) with the redistributable Java
client, you can obtain these pre-requisite JAR files from Maven:
• https://mvnrepository.com/artifact/com.sun.jndi/providerutil/1.2
• https://mvnrepository.com/artifact/com.sun.jndi/fscontext

From IBM MQ 9.2.0 Fix Pack 2 for Long Term Support and and IBM
MQ 9.2.2 for Continuous Delivery, the self-extracting JAR file version-IBM-MQ-Install-Java-
All.jar includes all of the files related to the JMSAdmin tool. For more information, see Obtaining
the IBM MQ classes for JMS separately.

Installing and uninstalling IBM MQ 29

 Choosing the files to distribute with an application
A script file named genmqpkg is provided by the redistributable client under the bin directory. You
can use the genmqpkg script to generate a smaller subset of files that are tailored to the needs of the
application for which the files are intended to be distributed.
When you run the script, you are asked a series of interactive Yes or No questions to determine the
runtime requirements for an IBM MQ application. Finally, genmqpkg asks you to supply a new target
directory, where the script duplicates the required directories and files.

From IBM MQ 9.2.0, the genmqpkg script that is shipped with the IBM MQ C redistributable
client packages includes an additional question asking whether the runtime requires the SDK to compile
applications. Also from IBM MQ 9.2.0, for the IBM MQ C redistributable client packages, responses can be
given programmatically. All the interactive prompts can be bypassed by setting environment variables and
executing the command with a -b flag to indicate a batch mode.
Important: IBM support is only able to provide assistance with the full, unmodified set of files contained
within the redistributable client packages.

Other considerations
The default data path of a non-installed client is:

Linux x86-64
$HOME/IBM/MQ/data

Windows
%HOMEDRIVE%\%HOMEPATH%\IBM\MQ\data
On AIX and Linux systems, the length of the path must not contain spaces.
Important: A redistributable client runtime co-exists with a full IBM MQ client or server installation,
provided that they are installed in different locations. However, unpacking a redistributable image into the
same location as a full IBM MQ installation is not supported.
On Linux the ccsid.tbl used to define the supported CCSID conversions is traditionally expected to be
found in the UserData directory structure, along with error logs, trace files, and so on. The UserData
directory structure is populated by unpacking the redistributable client, and so, if the file is not found in
its usual location, the redistributable client falls back to locate the file in the /lib subdirectory of the
installation.

Home directory
A ${HOME}/.mqm directory is created when using an unregistered or non-installed version of IBM MQ,
such as the redistributable client.
The directory is created so that IBM MQ has a reliable way of accessing its socket files using a path that
fits within the sun_path length. If IBM MQ cannot write to the HOME directory you receive an error
message.

Classpath changes
The classpath used by dspmqver, setmqenv, and crtmqenv commands adds the
com.ibm.mq.allclient.jar to the environment, immediately following the com.ibm.mq.jar and
com.ibm.mqjms.jar.

dspmqver output examples

An example of dspmqver output from the redistributable client on Linux:

Name: IBM MQ
Version: 8.0.0.4

30 Installing IBM MQ
Level: p800-804-L150909
BuildType: IKAP - (Production)
Platform: IBM MQ for Linux (x86-64 platform)
Mode: 64-bit
O/S: Linux 2.6.32.59-0.7-default
InstName: MQNI08000004
InstDesc: IBM MQ V8.0.0.4 (Redistributable)
Primary: No
InstPath: /Development/johndoe/unzip/unpack
DataPath: /u/johndoe/IBM/MQ/data
MaxCmdLevel: 802

An example of dspmqver output from the redistributable client on Windows:

Name: IBM MQ
Version: 8.0.0.4
Level: p800-804-L150909
BuildType: IKAP - (Production)
Platform: IBM MQ for Windows (x64 platform)
Mode: 64-bit
O/S: Windows 7 Professional x64 Edition, Build 7601: SP1
InstName: MQNI08000004
InstDesc: IBM MQ V8.0.0.4 (Redistributable)
Primary: No
InstPath: C:\Users\johndoe\Desktop\Redist
DataPath: C:\Users\johndoe\IBM\MQ\data
MaxCmdLevel: 802

Related concepts
“Redistributable IBM MQ clients” on page 27
The IBM MQ redistributable client is a collection of runtime files that are provided in a .zip or .tar file
that can be redistributed to third parties under redistributable license terms, which provides a simple way
of distributing applications and the runtime files that they require in a single package.
“.NET application runtime - Windows only” on page 225
Considerations when using the .NET application.

IBM MQ non-install images

IBM MQ non-install images provide the IBM MQ product in a tar.gz format that can be unzipped and has
no further installation steps. The purpose of this packaging of IBM MQ is to deliver the IBM MQ product in
a format that can be used for building container images.
Note: These packages are provided only for building container images and are not supported for any other
use cases.
Copies of these packages are provided with Developer, Non-Production and Production license terms for
Linux x86-64, Linux on IBM Z and Linux on PPCLE. The Github mq-container project is a working example
with documentation on how to build a container image using these packages. It is made available under
an Apache V2 license and may be copied and customized for your own purposes.
To download the packages, go to IBM MQ downloads and follow the link to the IBM MQ release specific
download document. Production and Non-Production packages are on IBM Fix Central and the Developer
packages are on IBM Downloads.
The main differences between the installable and non-install IBM MQ packages are as follows:
Security
• The user that starts the queue manager will be the user that the queue manager is running as.
• The primary group of the user starting the queue manager will be considered the administrative
group rather than "mqm".
• No setuid on any IBM MQ executables. IBM MQ executables are required to run as a non-root user.
• It is no longer possible to authenticate incoming IBM MQ client users using local user credentials.
IBM MQ is not authorized to access this operating system information, so only LDAP/UserExternal
authorization can be used.

Installing and uninstalling IBM MQ 31

 Install
(If you using the IBM MQ Operator on OpenShift, this is handled transparently by the IBM MQ
Operator.)
As no installer technology is used:
• The installation is not registered with the operating system.
• Initial data directory structures do not exist and should be created with
<MQ_INSTALLATION_PATH>/bin/crtmqdir -a -f.
The product data directory is within the running user's home directory rather than /var/mqm. You can
change the default directory of the data path by using the MQ_OVERRIDE_DATA_PATH environment
variable.
Note: You must create the directory first, as the directory is not created automatically.
The setmqenv command can be used to initialize the current command environment, making it easier
to work with the package.
Related concepts
Support for building your own IBM MQ queue manager container images
Related reference
setmqenv (set IBM MQ environment)

Installing and uninstalling IBM MQ on AIX

Installation tasks that are associated with installing IBM MQ on AIX systems are grouped in this section.

About this task

To prepare for installation and to install the IBM MQ components, complete the following tasks.
For information about how to uninstall IBM MQ, see “Uninstalling or modifying IBM MQ on AIX” on page
60.
If product fixes or updates are made available, see Applying maintenance to IBM MQ.

Procedure
1. Check the system requirements.
See “Checking requirements on AIX” on page 35.
2. Plan your installation.
• As part of the planning process, you must choose which components to install and where to install
them. See “IBM MQ components for AIX systems” on page 33.
• You must also make some platform-specific choices. See “Planning to install IBM MQ on AIX” on
page 37.
3. Prepare your system for installation of IBM MQ.
See “Preparing the system on AIX” on page 37.
4. Install IBM MQ server.
See “Installing IBM MQ server on AIX” on page 42.
5. Optional: Install an IBM MQ client.
See “Installing an IBM MQ client on AIX” on page 47.
6. Verify your installation. See “Verifying an IBM MQ installation on AIX” on page 50.

32 Installing IBM MQ
 IBM MQ components for AIX systems
You can select the components that you require when you install IBM MQ.
Important: See IBM MQ license information for details of what each purchase of IBM MQ entitles you to
install.
On AIX each component of IBM MQ is represented by a fileset. Table 4 on page 33 shows the filesets
that are available when installing an IBM MQ server or client on an AIX system:

Table 4. IBM MQ filesets for AIX systems

Component Description Serve Client Fileset name
r medi
medi a
a
Runtime Contains files that are common to both server mqm.base.runtime
and client installations.
Note: This component must be installed.

Server You can use the server to run queue mqm.server.rte

managers on your system and connect to
other systems over a network. Provides
messaging and queuing services to
applications, and support for IBM MQ client
connections.
Standard Client The IBM MQ MQI client is a small subset of mqm.client.rte
IBM MQ, without a queue manager, that uses
the queue manager and queues on other
(server) systems. It can be used only when
the system it is on is connected to another
system that is running a full server version of
IBM MQ. The client and the server can be on
the same system if required.
SDK The SDK is required for compiling mqm.base.sdk
applications. It includes sample source
files, and the bindings (files .H, .LIB, .DLL,
and others), that you need to develop
applications to run on IBM MQ.
Sample The sample application programs are needed mqm.base.samples
programs if you want to check your IBM MQ installation
using the verification procedures.
Java messaging The files needed for messaging using Java mqm.java.rte
(includes Java Message Service).
Man pages AIX man pages, in U.S. English, for: mqm.man.en_US.data

control commands
MQI calls
MQSC commands

Java JRE A Java Runtime Environment that is used by mqm.jre.rte

those parts of IBM MQ that are written in
Java.
Message For available languages, see the table of
Catalogs message catalogs that follows.

Installing and uninstalling IBM MQ 33

 Table 4. IBM MQ filesets for AIX systems (continued)
Component Description Serve Client Fileset name
r medi
medi a
a
IBM Global IBM Global Security Kit V8 Certificate and mqm.gskit.rte
Security Kit TLS, Base Runtime.
Telemetry MQ Telemetry supports the connection of mqm.xr.service
Service Internet Of Things (IOT) devices (that is,
remote sensors, actuators and telemetry
devices) that use the IBM MQ Telemetry
Transport (MQTT) protocol. The telemetry
(MQXR) service enables a queue manager
to act as an MQTT server, and communicate
with MQTT client apps.
A set of MQTT clients is available from the
Eclipse Paho downloads page. These sample
clients help you write your own MQTT client
apps that IOT devices use to communicate
with MQTT servers.
See also “Installation considerations for MQ
Telemetry” on page 259.

Managed File MQ Managed File Transfer transfers files mqm.ft.agent

Transfer between systems in a managed and mqm.ft.base
auditable way, regardless of file size or mqm.ft.logger
the operating systems used. For information mqm.ft.service
about the function of each component, see mqm.ft.tools
“Managed File Transfer product options” on
page 254.
Advanced Provides a high level of protection for mqm.ams.rte
Message sensitive data flowing through the IBM
Security MQ network, while not impacting the end
applications. You must install this component
on all IBM MQ installations that host queues
you want to protect.
You must install the IBM Global Security
Kit component on any IBM MQ installation
that is used by a program that puts or
gets messages to or from a protected
queue, unless you are using only Java client
connections.
You must install the Java JRE component to
install this component.

AMQP Service Install this component to make AMQP mqm.amqp.rte

channels available. AMQP channels support
AMQP 1.0 APIs. You can use AMQP channels
to give AMQP applications access to the
enterprise-level messaging facilities provided
by IBM MQ.

34 Installing IBM MQ
Table 4. IBM MQ filesets for AIX systems (continued)
Component Description Serve Client Fileset name
r medi
medi a
a
REST API and Adds HTTP based administration for IBM MQ mqm.web.rte
Console through the REST API and IBM MQ Console.

Table 5. IBM MQ message catalogs for AIX systems

Message catalog language Component name
Brazilian Portuguese mqm.msg.pt_BR
Czech mqm.msg.cs_CZ
French mqm.msg.fr_FR
German mqm.msg.de_DE
Hungarian mqm.msg.hu_HU
Italian mqm.msg.it_IT
Japanese mqm.msg.ja_JP, mqm.msg.Ja_JP
Korean mqm.msg.ko_KR
Polish mqm.msg.pl_PL
Russian mqm.msg.ru_RU
Spanish mqm.msg.es_ES
Simplified Chinese mqm.msg.zh_CN, mqm.msg.Zh_CN
Traditional Chinese mqm.msg.zh_TW, mqm.msg.Zh_TW
U.S. English mqm.msg.en_US

Related concepts
“IBM MQ components and features” on page 6
You can select the components or features that you require when you install IBM MQ.
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.

Checking requirements on AIX

Before you install IBM MQ on AIX, you must check for the latest information and system requirements.

About this task

A summary of the tasks that you must complete to check system requirements is listed here with links to
further information.

Procedure
1. Check that you have the latest information, including information on hardware and software
requirements.
See “Where to find product requirements and support information” on page 9.

Installing and uninstalling IBM MQ 35

 2. Check that your systems meet the initial hardware and software requirements for AIX.
See “Hardware and software requirements on AIX systems” on page 36.
3. Check that your systems have sufficient disk space for the installation.
See Disk space requirements.
4. Check that you have the correct licenses.
See “License requirements” on page 8 and IBM MQ license information.

What to do next
When you have completed these tasks, you are ready to start preparing your system for installation. For
the next steps in installing IBM MQ, see “Preparing the system on AIX” on page 37.
Related concepts
“IBM MQ installation overview” on page 5
An overview of concepts and considerations for installing IBM MQ, with links to instructions on how to
install, verify, and uninstall IBM MQ on each of the supported platforms.
Related tasks
Applying maintenance to IBM MQ

Hardware and software requirements on AIX systems

Before you install IBM MQ, check that your system meets the hardware and operating system software
requirements for the particular components you intend to install.
For hardware and software requirements, see System Requirements for IBM MQ.

Host names
IBM MQ does not support host names that contain spaces. If you install IBM MQ on a system with a host
name that contains spaces, you are unable to create any queue managers.

32-bit client support

Attention: From IBM MQ 9.0.0, there is no separate 32-bit client installation package. The client
installation package and redistributable client contain both 32-bit and 64-bit IBM MQ client
libraries. The included 32-bit libraries can be used by 32-bit applications on supported platforms
where 32-bit support is offered by the operating system.

Java Message Service

Java 8 is bundled with IBM MQ 9.0 but client components are built with Java 7 compatibility flags on.
For development, a JDK is required, and a JRE is required for running. The JRE does not need to be the
JRE installed with IBM MQ, but has to be one from the supported list.
For a list of supported JDKs, see System Requirements for IBM MQ.
You can check the version installed using the following command:

java -version

Transport Layer Security (TLS)

If you want to use the TLS support, you need the IBM Global Security Kit (GSKit) V8 package. This
package is supplied with IBM MQ as one of the components available for installation.

Unicode support on AIX

If you need to convert data to and from Unicode on your system, you must install the following file sets:

36 Installing IBM MQ
 bos.iconv.ucs.com Unicode converters for AIX sets
bos.iconv.ucs.ebcdic Unicode converters for EBCDIC sets
bos.iconv.ucs.pc Unicode converters for PC sets

Planning to install IBM MQ on AIX

Before you install IBM MQ on AIX, you must choose which components to install and where to install
them. You must also make some platform-specific choices.

About this task

The following steps provide links to additional information to help you with planning your installation of
IBM MQ on AIX.
As part of your planning activities, make sure that you review the information on hardware and software
requirements for the platform on which you are planning to install IBM MQ. For more information, see
“Checking requirements on AIX” on page 35.

Procedure
• Decide which IBM MQ components and features to install.
See “IBM MQ components and features” on page 6 and “Where to find downloadable installation
images” on page 9.
Important: Ensure that your enterprise has the correct license, or licenses, for the components that
you are going to install. For more information, see “License requirements” on page 8 and IBM MQ
license information.
• Review the options for naming your installation.
In some cases, you can choose an installation name to use instead of the default name. See
“Installation name on AIX, Linux, and Windows” on page 14.
• Review the options and restrictions for choosing an installation location for IBM MQ.
For more information, see “Installation location on Multiplatforms” on page 15.
• If you plan to install multiple copies of IBM MQ, see “Multiple installations on AIX, Linux, and
Windows” on page 17.
• If you already have a primary installation, or plan to have one, see “Primary installation on AIX, Linux,
and Windows” on page 18.
• Make sure that the communications protocol needed for server-to-server verification is installed and
configured on both systems that you plan to use.
For more information, see “Server-to-server links on AIX, Linux, and Windows” on page 26.

Preparing the system on AIX

On AIX systems, you might have to complete several tasks before you install IBM MQ. You might also
want to complete other tasks, depending on your installation intentions.

About this task

The tasks that you perform to prepare your systems for installation are listed here. Complete the
appropriate tasks for your platform before installing.

Procedure
1. Set up a user ID of the name mqm, with a primary group of mqm.
See “Setting up the user and group on AIX” on page 38.

Installing and uninstalling IBM MQ 37

 Note: If the group mqm and/or user mqm do not exist, during the installation of the product, the installer
creates group mqm and user mqm with a home directory of /var/mqm.
2. Create file systems for both the product code and working data to be stored. See “Creating file systems
on AIX” on page 39.
3. Configure any additional settings needed for your AIX system.
See “Configuring and tuning the operating system on AIX” on page 41.

What to do next
When you have completed the tasks to prepare the system, you are ready to start installing IBM MQ. To
install a server, see “Installing IBM MQ server on AIX” on page 42. To install a client, see “Installing an
IBM MQ client on AIX” on page 47.
Related tasks
Planning
Maintaining and migrating
Applying maintenance to IBM MQ

Setting up the user and group on AIX

On AIX systems, IBM MQ requires a user ID of the name mqm, with a primary group of mqm. The mqm user
ID owns the directories and files that contain the resources associated with the product.

Creating the user ID and group

Set the primary group of the mqm user to the group mqm.
Note: If the group mqm and/or user mqm do not exist, during the installation of the product, the installer
creates group mqm and user mqm with a home directory of /var/mqm
If you are installing IBM MQ on multiple systems you might want to ensure each UID and GID of mqm
has the same value on all systems. If you are planning to configure multi-instance queue managers, it is
essential the UID and GID are the same from system to system. It is also important to have the same UID
and GID values in virtualization scenarios.
You can use the System Management Interface Tool ( smit ), for which you require root authority.
1. To create the mqm group, display the required window using this sequence:

Security & Users

Groups
Add a Group

Set the group name field to mqm.

2. To create the user mqm, display the required window using this sequence:

Security & Users

Users
Add a User

Set the user name field to mqm.

3. To add a password to the new user ID, display the required window using this sequence:

Security & Users

Passwords
Change a User's Password

Set the password as required.

38 Installing IBM MQ
Adding existing user IDs to the group
If you want to run administration commands, for example crtmqm (create queue manager) or strmqm
(start queue manager), your user ID must be a member of the mqm group. This user ID must not be longer
than 12 characters.
Users do not need mqm group authority to run applications that use the queue manager; it is needed only
for the administration commands.
You can use smit to add an existing user ID to the mqm group. Display the required menu using this
sequence:

Security & Users

Users
Change / Show Characteristics of a User

Type the name of the user in the User Name field and press Enter. Add mqm to the Group SET field,
which is a comma-separated list of the groups to which the user belongs. Users do not need to have their
primary group set to mqm. If mqm is in their set of groups, they can use the administration commands.

Log files created by MQ Telemetry service

The umask setting of the user ID that creates a queue manager will determine the permissions of the
Telemetry log files generated for that queue manager. Even though the ownership of the log files will be
set to mqm.
Related concepts
“Creating file systems on AIX” on page 39
Before installing IBM MQ, you might need to create file systems for both the product code and working
data to be stored. There are minimum storage requirements for these file systems. The default installation
directory for the product code can be changed at installation time, but the working data location cannot
be changed.
“Configuring and tuning the operating system on Linux” on page 102
Use this topic when you are configuring IBM MQ on Linux systems.
Related tasks
“Configuring and tuning the operating system on AIX” on page 41
When installing IBM MQ on AIX systems, there are some additional settings that must be configured.

Creating file systems on AIX

Before installing IBM MQ, you might need to create file systems for both the product code and working
data to be stored. There are minimum storage requirements for these file systems. The default installation
directory for the product code can be changed at installation time, but the working data location cannot
be changed.

Determining the size of a server installations file system

To determine the size of the /var/mqm file system for a server installation, consider:
• The maximum number of messages in the system at one time.
• Contingency for message buildups, if there is a system problem.
• The average size of the message data, plus 500 bytes for the message header.
• The number of queues.
• The size of log files and error messages.
• The amount of trace that is written to the /var/mqm/trace directory.
Storage requirements for IBM MQ also depend on which components you install, and how much working
space you need. For more details, see Disk space requirements.

Installing and uninstalling IBM MQ 39

 Creating a file system for the working data
Before you install IBM MQ, create and mount a file system called /var/mqm which is owned by the user
mqm in the group mqm; see “Setting up the user and group on AIX” on page 38. This file system is used
by all installations of IBM MQ on a system. If possible, use a partition strategy with a separate volume
for the IBM MQ data. This means that other system activity is not affected if a large amount of IBM
MQ work builds up. Configure the directory permissions to permit the mqm user to have full control, for
example, file mode 755. These permissions will then be updated during the IBM MQ installation to match
the permissions required by the queue manager.

Creating separate file systems for errors and logs

You can also create separate file systems for your log data ( /var/mqm/log ) and error files ( /var/mqm/
errors ). If possible, place these directories on different physical disks from the queue manager data
( /var/mqm/qmgrs ) and from each other.
If you create separate file systems the /var/mqm/errors directory can be NFS mounted. However, if
you choose to NFS-mount /var/mqm/errors, the error logs might be lost if the network fails.
You can protect the stability of your queue manager by having separate file systems for:
• /var/mqm/errors
• /var/mqm/trace
• /var/mqm/qmgrs
• /var/mqm/log
In the case of /var/mqm/errors, it is rare that this directory receives large quantities of data. But it
is sometimes seen, particularly if there is a severe system problem leading to IBM MQ writing a lot of
diagnostic information in to .FDC files. In the case of /var/mqm/trace, files are only written here when
you use strmqtrc to start tracing IBM MQ.
You can obtain better performance of normal IBM MQ operations (for example, syncpoints, MQPUT,
MQGET of persistent messages) by placing the following on separate disks:
• /var/mqm/qmgrs
• /var/mqm/log
In the rare event that you need to trace an IBM MQ system for problem determination, you can reduce
performance impact by placing the /var/mqm/trace file system on a separate disk.
If you are creating separate file systems, allow a minimum of 30 MB of storage for /var/mqm, 100 MB
of storage for /var/mqm/log, and 10 MB of storage for /var/mqm/errors. The 100 MB minimum
allowance of storage for /var/mqm/log is the absolute minimum required for a single queue manager
and is not a recommended value. The size of a file system must be scaled according to the number of
queue managers that you intend to use, the number of pages per log file, and the number of log files per
queue manager.
For more information about file systems, see File system support.
The size of the log file depends on the log settings that you use. The minimum sizes are for circular logging
using the default settings. For more information about log sizes, see Calculating the size of the log.
Related concepts
“Setting up the user and group on AIX” on page 38
On AIX systems, IBM MQ requires a user ID of the name mqm, with a primary group of mqm. The mqm user
ID owns the directories and files that contain the resources associated with the product.
Related tasks
“Configuring and tuning the operating system on AIX” on page 41

40 Installing IBM MQ
When installing IBM MQ on AIX systems, there are some additional settings that must be configured.

Configuring and tuning the operating system on AIX

When installing IBM MQ on AIX systems, there are some additional settings that must be configured.

About this task

When you install IBM MQ on AIX systems, you must configure the following operating system settings:
• File descriptors
• System resource limits

Procedure
• Increase the process limit for the number of file descriptors.
When running a multi-threaded process such as the agent process, you might reach the soft limit for
file descriptors. This limit gives you the IBM MQ reason code MQRC_UNEXPECTED_ERROR (2195)
and, if there are enough file descriptors, an IBM MQ FFST file.
To avoid this problem, increase the process limit for the number of file descriptors. You must alter
the nofiles attribute in /etc/security/limits to 10,000 for the mqm user ID, or in the default
stanza. To alter the number of file descriptors, complete the following steps:
a) Check the maximum number of file descriptors available to a process running as mqm:

lsuser -a nofiles mqm

b) Set the value to at least 10240:

chuser nofiles=10240 mqm

chuser nofiles_hard=10240 mqm

• Set the system resource limit for data segment and stack segment to unlimited using the following
commands in a command prompt:

ulimit -d unlimited
ulimit -s unlimited

Attention: For an mqm user ID other than root, the value unlimited might not be permitted.

What to do next
You can check your system configuration using the mqconfig command.
During high load IBM MQ can use virtual memory (swap space). If virtual memory becomes full it could
cause IBM MQ processes to fail or become unstable, affecting the system.
To prevent this situation your IBM MQ administrator should ensure that the system has been allocated
enough virtual memory as specified in the operating system guidelines.
For more information on configuring your system, see How to configure AIX and Linux systems for IBM
MQ.
Related concepts
“Setting up the user and group on AIX” on page 38
On AIX systems, IBM MQ requires a user ID of the name mqm, with a primary group of mqm. The mqm user
ID owns the directories and files that contain the resources associated with the product.
“Creating file systems on AIX” on page 39

Installing and uninstalling IBM MQ 41

 Before installing IBM MQ, you might need to create file systems for both the product code and working
data to be stored. There are minimum storage requirements for these file systems. The default installation
directory for the product code can be changed at installation time, but the working data location cannot
be changed.

Installing IBM MQ server on AIX

You can install an IBM MQ server on AIX either interactively or silently.

Before you begin

• Before you start the installation procedure, make sure that you complete the necessary steps that are
outlined in “Preparing the system on AIX” on page 37.
• IBM MQ can be installed into System Workload Partitions (WPARs) with both shared and private file
systems. For installation into private file systems, IBM MQ can be installed directly into the System
WPAR by using the procedure that is outlined in this topic. There are some limitations for shared /usr
file systems:
– The dspmqinst and dspmqver commands might report the primary installation incorrectly when
compared with the symbolic links in /usr/bin. To synchronize the reporting of the primary
installation in a System WPAR and the global environment, run setmqinst with the -i or -x
parameter, on the individual zones.
– You cannot change the primary installation within a WPAR. You must change the primary installation
through the global environment, which has appropriate write access to /usr/bin.
Note: During installation to a non-default location, ATTENTION messages that relate to errupdate or
trcupdate are produced. These messages are not errors. However, AIX system trace for IBM MQ is
not supported for installations in a non-default location, and IBM MQ trace must be used for problem
determination.
• If you install a copy of IBM MQ server for AIX by using Electronic Software Download, obtained from
Passport Advantage, you need to:
1. Decompress the tar file, by using the following command:

uncompress IBM_MQ_9.2.0_AIX.tar.Z

2. Extract the installation files from the tar file, by using the following command:

tar -xvf IBM_MQ_9.2.0_AIX.tar

3. Use the installation tools installp or smit to install the IBM MQ server for AIX.
Tip: If you find that the Function keys do not work in SMIT, try pressing Esc and the Function key number
to emulate the required Function key.

About this task

IBM MQ is supplied as a set of filesets that are installed by using the standard AIX installation tools. The
procedure uses the system management interface tool (SMIT), but you can choose to use installp,
geninstall or the web-based System Manager. You can select which components you want to install.
The components and file sets are listed in “IBM MQ components for AIX systems” on page 33.
This procedure installs IBM MQ into the default location of /usr/mqm.
Use the procedure that is described in “Installing the IBM MQ server silently on AIX” on page 44 if you
want to install IBM MQ in any one of the following situations:
• As the first installation on your system by using installp
• As the first installation on your system, and you are installing the product to a location that is not the
default location
• Alongside an existing installation

42 Installing IBM MQ
If you want to carry out a side-by-side installation, alongside an existing installation of IBM MQ in the
default location, you must install the second version of the product in a location that is not the default. To
create the non-default installation location you must use the mkusil command, which is available only
from the command line.
You can then use installp (see “Installing the IBM MQ server silently on AIX” on page 44), or SMIT if
you select the Relocatable Software Installation menu item.
If you want to carry out a single stage migration, refer to Migrating on AIX and Linux: single-stage.

Procedure
1. Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux. This information also applies to UNIX systems in general.
2. Set your current directory to the location of the installation packages.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.
3. Select the required smit window by using the following sequence:

Software Installation and Maintenance

Install and Update Software
Install and Update from ALL Available Software

4. Specify the input directory in the INPUT device / directory for software field.
a) Enter a period character .
b) Press the Enter key
5. List the software in the SOFTWARE to install field:
a) Enter .
b) Press F4
6. Select the file sets to install from the list. If you require messages in a language different from the
language that is specified by the locale that is selected on your system, ensure that you include the
appropriate message catalog. Enter ALL to install all applicable filesets.
7. View the license agreement:
a) Change Preview new LICENSE agreements? to yes
b) Press Enter
8. Accept the license agreements and install IBM MQ:
a) Change ACCEPT new license agreements? to yes
b) Change Preview new LICENSE agreements? to no
c) Press Enter

What to do next
• If you chose this installation to be the primary installation on the system, you must now set it as the
primary installation. Enter the following command at the command prompt:

MQ_INSTALLATION_PATH/bin/setmqinst -i -p MQ_INSTALLATION_PATH

where MQ_INSTALLATION_PATH represents the directory where IBM MQ is installed.

You can have only one primary installation on a system. If there is already a primary installation on the
system, you must unset it before you can set another installation as the primary installation. For more
information, see Changing the primary installation.

Installing and uninstalling IBM MQ 43

 • You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ. For
more information, see setmqenv and crtmqenv.
• If you want to confirm that the installation was successful, you can verify your installation. For more
information, see “Verifying an IBM MQ installation on AIX” on page 50.
Related concepts
“Installation location on Multiplatforms” on page 15
You can install IBM MQ into the default location. Alternatively, you can install into a custom
location during the installation process. The location where IBM MQ is installed is known as the
MQ_INSTALLATION_PATH.
“Multiple installations on AIX, Linux, and Windows” on page 17
On AIX, Linux, and Windows, it is possible to have more than one copy of IBM MQ on a system.
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
Related tasks
“Installing the IBM MQ server silently on AIX” on page 44
You can carry out a non-interactive installation of the IBM MQ server from the command line using
the AIX installp command. A non-interactive installation is also known as a silent, or unattended
installation.
“Uninstalling or modifying IBM MQ on AIX” on page 60
On AIX, you can uninstall the IBM MQ server or client using the System Management Interface Tool
(SMIT) or the installp command. You can also modify an installation by uninstalling a subset of the file
sets.
Changing the primary installation
Related reference
setmqinst

Installing the IBM MQ server silently on AIX

You can carry out a non-interactive installation of the IBM MQ server from the command line using
the AIX installp command. A non-interactive installation is also known as a silent, or unattended
installation.

Before you begin

Before you start the installation procedure, make sure that you have completed the necessary steps
outlined in “Preparing the system on AIX” on page 37.
Note: During installation, errors relating to errupdate or trcupdate might occur. This can caused by
installing to a non-default location, if so these errors can be safely ignored. However, native trace for IBM
MQ is only supported when installed in the default location.

About this task

You can use this method to install to a non-default location, and can select which components you want
to install. The components and filesets are listed in “IBM MQ components and features” on page 6.

Procedure
1. Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux. This information also applies to UNIX systems in general.

44 Installing IBM MQ
2. Set your current directory to the location of the installation packages.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.
3. Install the product in one of the following ways:
• Install the whole product in the default location:

installp -acgXYd . all

• Install selected file sets in the default location:

installp -acgXYd . list of file sets

• Install the whole product in a non-default location using the -R flag:

installp -R USIL_Directory -acgXYd . all

• Install selected file sets in a non-default location using the -R flag:

installp -R USIL_Directory -acgXYd . list of file sets

where USIL_Directory is a directory which exists before the command is run; it must not contain
any spaces or usr/mqm. IBM MQ is installed underneath the directory specified. For example, if /
USIL1 is specified, the IBM MQ product files are located in /USIL1/usr/mqm. This location is known
as the MQ_INSTALLATION_PATH.

What to do next
• If you have chosen this installation to be the primary installation on the system, you must now set it as
the primary installation. Enter the following command at the command prompt:

MQ_INSTALLATION_PATH/bin/setmqinst -i -p MQ_INSTALLATION_PATH

where MQ_INSTALLATION_PATH represents the directory where IBM MQ is installed.

You can have only one primary installation on a system. If there is already a primary installation on the
system, you must unset it before you can set another installation as the primary installation. For more
information, see Changing the primary installation.
• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ . For
more information, see setmqenv and crtmqenv.
• If you want to confirm that the installation was successful, you can verify your installation. See
“Verifying an IBM MQ installation on AIX” on page 50, for more information.
Related concepts
“Multiple installations on AIX, Linux, and Windows” on page 17
On AIX, Linux, and Windows, it is possible to have more than one copy of IBM MQ on a system.
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
Related tasks
“Installing IBM MQ server on AIX” on page 42
You can install an IBM MQ server on AIX either interactively or silently.
“Uninstalling or modifying IBM MQ on AIX” on page 60

Installing and uninstalling IBM MQ 45

 On AIX, you can uninstall the IBM MQ server or client using the System Management Interface Tool
(SMIT) or the installp command. You can also modify an installation by uninstalling a subset of the file
sets.
Changing the primary installation
Related reference
setmqinst
User Specified Installation Location (USIL)

Converting a trial license on AIX

Convert a trial license to a full license without reinstalling IBM MQ.
When the trial license expires, the "count-down" displayed by the strmqm command informs you the
license has expired, and the command does not run.

Before you begin

1. IBM MQ is installed with a trial license.
2. You have access to the installation media of a fully licensed copy of IBM MQ.

About this task

Run the setmqprd command to convert a trial license to a full license.
If you do not want to apply a full license to your trial copy of IBM MQ, you can uninstall it at any time.

Procedure
1. Obtain the full license from the fully licensed installation media.
The full license file is amqpcert.lic. On AIX, it is in the /MediaRoot/licenses directory on the
installation media.
2. Run the setmqprd command from the installation that you are upgrading:

MQ_INSTALLATION_PATH/bin/setmqprd /MediaRoot/licenses/amqpcert.lic

Related reference
setmqprd

Displaying messages in your national language on AIX

To display messages from a different national language message catalog, you must install the appropriate
catalog and set the LANG environment variable.

About this task

Messages in the language specified by the locale selected on your machine at installation time are
installed by default.
To find out which language is currently in use, run the locale command.
If this returns a language which is not one of the national languages provided by IBM MQ, you must select
a national language, otherwise you will not get a message catalog installed on your system.

Message catalogs for all languages are installed in MQ_INSTALLATION_PATH/msg/language

identifier , where language identifier is one of the identifiers in Table 6 on page 47. If you require
messages in a different language, perform the following steps:

46 Installing IBM MQ
Procedure
1. Install the appropriate message catalog (see “IBM MQ components and features” on page 6 ).
2. To select messages in a different language, ensure the LANG environment variable is set to the
identifier for the language you want to install:

Table 6. Language identifiers

Identifier Language
cs_CZ Czech
de_DE German
es_ES Spanish
fr_FR French
hu_HU Hungarian
it_IT Italian
ja_JP Japanese
ko_KR Korean
pl_PL Polish
pt_BR Brazilian Portuguese
ru_RU Russian
zh_CN Simplified Chinese
zh_TW Traditional Chinese

AIX has some additional message catalogs:

Table 7. AIX specific language identifiers

Identifier Language
Ja_JP Japanese
Zh_CN Simplified Chinese
Zh_TW Traditional Chinese

Installing an IBM MQ client on AIX

You can interactively install the IBM MQ client for AIX using smit.

Before you begin

Before you start the installation procedure, make sure that you have completed the necessary steps
outlined in “Preparing the system on AIX” on page 37.

About this task

IBM MQ is supplied as a set of filesets that are installed using the standard AIX installation tools. The
procedure uses the System Management Interface Tool ( smit ), but you can choose to use installp,
geninstall or the web-based System Manager. You can select which components you want to install.
The components and filesets are listed in “IBM MQ components for AIX systems” on page 33. You must
install at least the Runtime and Client components.

Installing and uninstalling IBM MQ 47

 This procedure installs IBM MQ into the default location. If you want to install to a non-default location,
you must use installp, see “Installing an IBM MQ client silently on AIX” on page 49.

Procedure
1. Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux. This information also applies to UNIX systems in general.
2. Set your current directory to the location of the installation packages.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.
3. Select the required smit window using the following sequence:

Software Installation and Maintenance

Install and Update Software
Install and Update from ALL Available Software

4. Click List to display the input device or directory for the software and select the location that contains
the installation images.
5. Select the SOFTWARE to install field to obtain a list of available filesets, and select the filesets you
want to install. Ensure that you include the appropriate message catalog if you require messages in
a language different from the language specified by the locale specified on your system. Enter ALL to
install all applicable filesets.
6. Change Preview new LICENSE agreements? to yes and press Enter to view the license agreements.
7. If you have a previous version of the product on your system, change the Automatically install
requisite software to no.
8. Change ACCEPT new license agreements? to yes and press Enter to accept the license agreements.
9. Change Preview new LICENSE agreements? to no and press Enter to install IBM MQ.

What to do next
• If you have chosen this installation to be the primary installation on the system, you must now set it as
the primary installation. Enter the following command at the command prompt:

MQ_INSTALLATION_PATH/bin/setmqinst -i -p MQ_INSTALLATION_PATH

You can have only one primary installation on a system. If there is already a primary installation on the
system, you must unset it before you can set another installation as the primary installation. For more
information, see Changing the primary installation.
• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ. For
more information, see setmqenv and crtmqenv.
• For instructions on how to verify your installation, see “Testing communication between a client and a
server on AIX” on page 59.
Related tasks
“Uninstalling or modifying IBM MQ on AIX” on page 60

48 Installing IBM MQ
On AIX, you can uninstall the IBM MQ server or client using the System Management Interface Tool
(SMIT) or the installp command. You can also modify an installation by uninstalling a subset of the file
sets.

Installing an IBM MQ client silently on AIX

You can carry out a non-interactive, or silent, installation of an IBM MQ client from the command line
using the AIX installp command.

Before you begin

Before you start the installation procedure, make sure that you have completed the necessary steps
outlined in “Preparing the system on AIX” on page 37.
Note: Installation to a non-default location is not supported on systems that have the AIX Trusted
Computing Base (TCB) enabled.

About this task

You can use this method to install to a non-default location, and can select which components you want
to install. The components and filesets are listed in “IBM MQ components and features” on page 6. You
must install at least the Runtime and Client components.

Procedure
1. Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux. This information also applies to UNIX systems in general.
2. Set your current directory to the location of the installation packages.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.
3. Install the product in one of the following ways:
• Install the whole product in the default location:

installp -acgXYd . all

• Install selected filesets in the default location:

installp -acgXYd . list of file sets

• Install the whole product in a non-default location using the -R flag:

installp -R USIL_Directory -acgXYd . all

• Install selected filesets in a non-default location using the -R flag:

installp -R USIL_Directory -acgXYd . list of file sets

where the directory specified with the -R flag is an AIX User Specified Installation Location (USIL)
directory which exists before the command is run; it must not contain any spaces or usr/mqm.
IBM MQ is installed underneath the directory specified. For example, if /USIL1 is specified,
the IBM MQ product files are located in /USIL1/usr/mqm. This location is known as the
MQ_INSTALLATION_PATH.

Installing and uninstalling IBM MQ 49

 What to do next
• If you have chosen this installation to be the primary installation on the system, you must now set it as
the primary installation. Enter the following command at the command prompt:

MQ_INSTALLATION_PATH/bin/setmqinst -i -p MQ_INSTALLATION_PATH

You can have only one primary installation on a system. If there is already a primary installation on the
system, you must unset it before you can set another installation as the primary installation. For more
information, see Changing the primary installation.
• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ. For
more information, see setmqenv and crtmqenv.
• For instructions on how to verify your installation, see “Testing communication between a client and a
server on AIX” on page 59.

Verifying an IBM MQ installation on AIX

The topics in this section provide instructions on how to verify a server or a client installation of IBM MQ
on AIX systems.

About this task

You can verify a local (stand-alone) server installation or a server-to-server installation of the IBM MQ
server:
• A local server installation has no communication links with other IBM MQ installations.
• A server-to-server installation does have links to other installations.
You can also verify that your IBM MQ MQI client installation completed successfully and that the
communication link is working.

Procedure
• To verify a local server installation, see “Verifying a local server installation using the command line on
AIX” on page 50.
• To verify a server-to-server installation, see “Verifying a server-to-server installation using the
command line on AIX” on page 52.
• To verify a client installation, see “Verifying a client installation using the command line on AIX” on
page 55.

Verifying a local server installation using the command line on AIX

On AIX systems, you can verify a local server installation by using the command line to create a simple
configuration of one queue manager and one queue.

Before you begin

To verify the installation, you must first install the samples package.
Before beginning the verification procedure, you might want to check that you have the latest fixes for
your system. For more information about where to find the latest updates, see “Checking requirements on
AIX” on page 35.

50 Installing IBM MQ
About this task
Use the following steps to configure your default queue manager from the command line. After the queue
manager is configured, use the amqsput sample program to put a message on the queue. You then use
the amqsget sample program to get the message back from the queue.
IBM MQ object definitions are case-sensitive. Any text entered as an MQSC command in lowercase is
converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that you
type the examples exactly as shown.

Procedure
1. On an AIX system, log in as a user in the mqm group.
2. Set up your environment:
a) Set up environment variables for use with a particular installation by entering one the following
command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

b) Check that the environment is set up correctly by entering the following command:

dspmqver

If the command completes successfully, and the expected version number and installation name
are returned, the environment is set up correctly.
3. Create a queue manager called QMA by entering the following command:

crtmqm QMA

Messages indicate when the queue manager is created, and when the default IBM MQ objects are
created.
4. Start the queue manager by entering the following command:

strmqm QMA

A message indicates when the queue manager starts.

5. Start MQSC by entering the following command:

runmqsc QMA

A message indicates when MQSC starts. MQSC has no command prompt.

6. Define a local queue called QUEUE1 by entering the following command:

DEFINE QLOCAL (QUEUE1)

A message indicates when the queue is created.

7. Stop MQSC by entering the following command:

end

Messages are shown, followed by the command prompt.

Note: Subsequent steps require that the samples package is installed.

Installing and uninstalling IBM MQ 51

 8. Change into the MQ_INSTALLATION_PATH/samp/bin directory, which contains the sample
programs.
MQ_INSTALLATION_PATH represents the high-level directory in which IBM MQ is installed.
9. Put a message on the queue by entering the following commands

./amqsput QUEUE1 QMA

The following messages are shown:

Sample AMQSPUT0 start

target queue is QUEUE1

10. Type some message text on one or more lines, where each line is a different message. Enter a blank
line to end the message input.
The following message is shown:

Sample AMQSPUT0 end

Your messages are now on the queue and the command prompt is shown.
11. Get the messages from the queue, by entering the following command:

./amqsget QUEUE1 QMA

The sample program starts, and your messages are displayed.

Results
You have successfully verified your local installation.

Verifying a server-to-server installation using the command line on

AIX
You can verify a server-to-server installation using two servers, one as a sender and one as a receiver.

Before you begin

• On AIX, IBM MQ supports both TCP and SNA.
The examples in this task use TCP/IP. If you do not use TCP, see Setting up communication on AIX and
Linux.
• If you are using TCP/IP, make sure that TCP/IP and IBM MQ are installed on both servers.
• Make sure that you are a member of the IBM MQ administrators group (mqm) on each server.
• Decide which installation is the sender server and which installation is the receiver server. The
installations might be on the same system, or on different systems.

About this task

IBM MQ object definitions are case-sensitive. Any text entered as an MQSC command in lowercase is
converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that you
type the examples exactly as shown.

Procedure
1. On the receiver server:
a) On AIX, log in as a user in the mqm group.

52 Installing IBM MQ
 b) Check which ports are free, for example by running netstat. For more information about this
command, see the documentation of your operating system.
If port 1414 is not in use, make a note of 1414 to use as the port number in step 2 h. Use the same
number for the port for your listener later in the verification. If it is in use, note a port that is not in
use; for example 1415.
c) Set up the environment for the installation you are using by entering the following command at the
command prompt:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

d) Create a queue manager called QMB by entering the following command at the command prompt:

crtmqm QMB

Messages tell you that the queue manager has been created, and that the default IBM MQ objects
have been created.
e) Start the queue manager by entering the following command:

strmqm QMB

A message tells you when the queue manager has started.

f) Start MQSC by entering the following command:

runmqsc QMB

A message tells you that MQSC has started. MQSC has no command prompt.
g) Define a local queue called RECEIVER.Q by entering the following command:

DEFINE QLOCAL (RECEIVER.Q)

A message tells you the queue has been created.

h) Define a listener by entering the following command:
DEFINE LISTENER (LISTENER1) TRPTYPE (TCP) CONTROL (QMGR) PORT ( PORT_NUMBER )

Where port_number is the name of the port the listener runs on. This number must be the same as
the number used when defining your sender channel.
i) Start the listener by entering the following command:

START LISTENER (LISTENER1)

Note: Do not start the listener in the background from any shell that automatically lowers the
priority of background processes.
j) Define a receiver channel by entering the following command:

DEFINE CHANNEL (QMA.QMB) CHLTYPE (RCVR) TRPTYPE (TCP)

A message tells you when the channel has been created.

k) End MQSC by typing:

end

Installing and uninstalling IBM MQ 53

 Some messages are displayed, followed by the command prompt.
2. On the sender server:
a) As the sender server is an AIX system, log in as a user in the mqm group.
b) Set up the environment for the installation you are using by entering the following command at the
command prompt:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

c) Create a queue manager called QMA by entering the following command at the command prompt:

crtmqm QMA

Messages tell you that the queue manager has been created, and that the default IBM MQ objects
have been created.
d) Start the queue manager, by entering the following command:

strmqm QMA

A message tells you when the queue manager has started.

e) Start MQSC by entering the following command:

runmqsc QMA

A message tells you that an MQSC session has started. MQSC had no command prompt.
f) Define a local queue called QMB (to be used as a transmission queue) by entering the following
command:

DEFINE QLOCAL (QMB) USAGE (XMITQ)

A message tells you when the queue has been created.

g) Define a local definition of the remote queue with by entering the following command:

DEFINE QREMOTE (LOCAL.DEF.OF.REMOTE.QUEUE) RNAME (RECEIVER.Q) RQMNAME ('QMB') XMITQ (QMB)

h) Define a sender channel by entering one of the following commands:

con-name is the TCP/IP address of the receiver system. If both installations are on the same
system, the con-name is localhost. port is the port you noted in 1 b. If you do not specify a port,
the default value of 1414 is used.
DEFINE CHANNEL (QMA.QMB) CHLTYPE (SDR) CONNAME ('CON-NAME(PORT)') XMITQ (QMB) TRPTYPE (TCP)

i) Start the sender channel by entering the following command:

START CHANNEL(QMA.QMB)

The receiver channel on the receiver server starts automatically when the sender channel starts.
j) Stop MQSC by entering the following command:

end

Some messages are displayed, followed by the command prompt.

54 Installing IBM MQ
 k) If the sender server is a Linux or AIX system, change into the MQ_INSTALLATION_PATH/
samp/bin directory. This directory contains the sample programs. MQ_INSTALLATION_PATH
represents the high-level directory in which IBM MQ is installed.
l) If both the sender server and receiver server are installations on the same system, check that the
queue managers have been created on different installations by entering the following command:

dspmq -o installation

If the queue managers are on the same installation, move either QMA to the sender installation
or QMB to the receiver installation by using the setmqm command. For more information, see
setmqm.
m) Put a message on the local definition of the remote queue, which in turn specifies the name of the
remote queue. Enter one of the following commands:
• On AIX and Linux:

./amqsput LOCAL.DEF.OF.REMOTE.QUEUE QMA

• On Windows:

amqsput LOCAL.DEF.OF.REMOTE.QUEUE QMA

A message tells you that amqsput has started.

n) Type some message text on one or more lines, followed by a blank line.
A message tells you that amqsput has ended. Your message is now on the queue and the
command prompt is displayed again.
3. On the receiver server:
a) As your receiver server is an AIX system, change into the MQ_INSTALLATION_PATH/samp/bin
directory.
This directory contains the sample programs. MQ_INSTALLATION_PATH represents the high-level
directory in which IBM MQ is installed.
b) Get the message from the queue on the receiver by entering the following command:

./amqsget RECEIVER.Q QMB

The sample program starts, and your message is displayed. After a pause, the sample ends. Then
the command prompt is displayed.

Results
You have now successfully verified the server-to-server installation.

Verifying a client installation using the command line on AIX

You can verify a client installation using the command line. On the server you create a queue manager,
a local queue, a listener, and a server-connection channel. You must also apply security rules to allow
the client to connect and make use of the queue defined. On the client you create a client-connection
channel, and then use the sample PUT and GET programs to complete the verification procedure.

About this task

The verification procedure shows how to create a queue manager called queue.manager.1, a local
queue called QUEUE1, and a server-connection channel called CHANNEL1 on the server.

Installing and uninstalling IBM MQ 55

 It shows how to create the client-connection channel on the IBM MQ MQI client workstation. It then
shows how to use the sample programs to put a message onto a queue, and get the message from the
queue.
The example does not address any client security issues. See Setting up IBM MQ MQI client security for
details if you are concerned with IBM MQ MQI client security issues.
The verification procedure assumes that:
• The full IBM MQ server product has been installed on a server.
• The server installation is accessible on your network.
• The IBM MQ MQI client software has been installed on a client system.
• The IBM MQ sample programs have been installed.
• TCP/IP has been configured on the server and client systems. For more information, see Configuring
connections between the server and client.

Procedure
1. Set up the server using the command line, using the instructions in “Setting up the server using the
command line on AIX” on page 56.
2. Set up the client, using the instructions in “Connecting to a queue manager, using the MQSERVER
environment variable on AIX” on page 58.
3. Test the communications between client and server, using the instructions in “Testing communication
between a client and a server on AIX” on page 59.

Setting up the server using the command line on AIX

Follow these instructions to create a queue manager, queue, and channel on the server. You can then use
these objects to verify the installation.

About this task

These instructions assume that no queue manager or other IBM MQ objects have been defined.
IBM MQ object definitions are case-sensitive. Any text entered as an MQSC command in lowercase is
converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that you
type the examples exactly as shown.

Procedure
1. Create a user ID on the server that is not in the mqm group.
This user ID must exist on the server and client. This is the user ID that the sample applications must
be run as, otherwise a 2035 error is returned.
2. Log in as a user in the mqm group.
3. You must set various environment variables so that the installation can be used in the current shell.
You can set the environment variables by entering the following command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

4. Create a queue manager called QUEUE.MANAGER.1 by entering the following command:

crtmqm QUEUE.MANAGER.1

You see messages telling you that the queue manager has been created.
5. Start the queue manager by entering the following command:

56 Installing IBM MQ
 strmqm QUEUE.MANAGER.1

A message tells you when the queue manager has started.

6. Start MQSC by entering the following command:

runmqsc QUEUE.MANAGER.1

A message tells you that an MQSC session has started. MQSC has no command prompt.
7. Define a local queue called QUEUE1 by entering the following command:

DEFINE QLOCAL(QUEUE1)

A message tells you when the queue has been created.

8. Allow the user ID that you created in step 1 to use QUEUE1 by entering the following command:

SET AUTHREC PROFILE(QUEUE1) OBJTYPE(QUEUE) PRINCIPAL(' non_mqm_user ') AUTHADD(PUT,GET)

where non_mqm_user is the user ID created in step 1. A message tells you when the authorization
has been set. You must also run the following command to give the user ID authority to connect:

SET AUTHREC OBJTYPE(QMGR) PRINCIPAL(' non_mqm_user ') AUTHADD(CONNECT)

If this command is not run, a 2305 stop error is returned.

9. Define a server-connection channel by entering the following command:

DEFINE CHANNEL (CHANNEL1) CHLTYPE (SVRCONN) TRPTYPE (TCP)

A message tells you when the channel has been created.

10. Allow your client channel to connect to the queue manager and run under the user ID that you
created in step 1, by entering the following MQSC command:

SET CHLAUTH(CHANNEL1) TYPE(ADDRESSMAP) ADDRESS(' client_ipaddr ') MCAUSER(' non_mqm_user ')

where client_ipaddr is the IP address of the client system, and non_mqm_user is the user ID created
in step 1. A message tells you when the rule has been set.
11. Define a listener by entering the following command:

DEFINE LISTENER (LISTENER1) TRPTYPE (TCP) CONTROL (QMGR) PORT (port_number)

where port_number is the number of the port the listener is to run on. This number must be the same
as the number used when defining your client-connection channel in “Installing an IBM MQ client on
AIX” on page 47.
Note: If you omit the port parameter from the command, a default value of 1414 is used for the
listener port. If you want to specify a port other than 1414, you must include the port parameter in
the command, as shown.
12. Start the listener by entering the following command:

START LISTENER (LISTENER1)

13. Stop MQSC by entering:

end

Installing and uninstalling IBM MQ 57

 You see some messages, followed by the command prompt.

What to do next
Follow the instructions to set up the client. See “Connecting to a queue manager, using the MQSERVER
environment variable on AIX” on page 58.

Connecting to a queue manager, using the MQSERVER environment variable

on AIX
When an IBM MQ application is run on the IBM MQ MQI client, it requires the name of the MQI channel,
the communication type, and the address of the server to be used. Provide these parameters by defining
the MQSERVER environment variable.

Before you begin

Before you start this task, you must complete the task, “Setting up the server using the command line on
AIX” on page 56, and save the following information:
• The host name or IP address of the server and port number that you specified when creating the
listener.
• The channel name of the server-connection channel.

About this task

This task describes how to connect an IBM MQ MQI client, by defining the MQSERVER environment
variable on the client.
You can give the client access to the generated client channel definition table, amqclchl.tab instead;
see Accessing client-connection channel definitions.

Procedure
1. Log in as the userid that you created in Step 1 of “Verifying a client installation using the command line
on AIX” on page 55.
2. Check the TCP/IP connection. From the client, enter one of the following commands:
• ping server-hostname
• ping n.n.n.n
n.n.n.n represents the network address. You can set the network address in IPv4 dotted decimal
form, for example, 192.0.2.0. Alternatively, set the address in IPv6 hexadecimal form, for
example 2001:0DB8:0204:acff:fe97:2c34:fde0:3485.
If the ping command fails, correct your TCP/IP configuration.
3. Set the MQSERVER environment variable. From the client, enter the following command:

export MQSERVER=CHANNEL1/TCP/'server-address (port)'

Where:
• CHANNEL1 is the server-connection channel name.
• server-address is the TCP/IP host name of the server.
• port is the TCP/IP port number the server is listening on.
If you do not give a port number, IBM MQ uses the one specified in the qm.ini file, or the client
configuration file. If no value is specified in these files, IBM MQ uses the port number identified in the
TCP/IP services file for the service name MQSeries. If an MQSeries entry in the services file does not
exist, a default value of 1414 is used. It is important that the port number used by the client and the
port number used by the server listener program are the same.

58 Installing IBM MQ
What to do next
Use the sample programs to test communication between the client and server; see “Testing
communication between a client and a server on AIX” on page 59.

Testing communication between a client and a server on AIX

On the IBM MQ MQI client workstation, use the amqsputc sample program to put a message on the
queue at the server workstation. Use the amqsgetc sample program to get the message from the queue
back to the client.

Before you begin

Complete the previous topics in this section:
• Set up a queue manager, channels, and queue.
• Open a command window.
• Set system environment variables.

About this task

Note that IBM MQ object definitions are case-sensitive. Text entered as an MQSC command in lowercase
is converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that
you type the examples exactly as shown.

Procedure
1. Change to the MQ_INSTALLATION_PATH/samp/bin directory, which contains the sample
programs.
MQ_INSTALLATION_PATH represents the high-level directory in which IBM MQ is installed.
2. You must set certain environment variables so that the installation can be used in the current shell.
You can set the environment variables by entering the following command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

3. Start the PUT program for QUEUE1 on QUEUE.MANAGER.1 by entering the following command:

./amqsputc QUEUE1 QUEUE.MANAGER.1

If the command is successful, the following messages are displayed:

Sample AMQSPUT0 start target queue is QUEUE1

Tip: You might get the error, MQRC_NOT_AUTHORIZED (2035). By default, channel authentication
is enabled when a queue manager is created. Channel authentication prevents privileged users
accessing a queue manager as an IBM MQ MQI client. For verifying the installation, you can either
change the MCA user ID to a non-privileged user, or disable channel authentication. To disable channel
authentication run the following MQSC command:

ALTER QMGR CHLAUTH(DISABLED)

When you finish the test, if you do not delete the queue manager, re-enable channel authentication:

ALTER QMGR CHLAUTH(ENABLED)

4. Type some message text, then press Enter twice.

The following message is displayed:

Sample AMQSPUT0 end

Installing and uninstalling IBM MQ 59

 Your message is now on the queue that is on the server queue manager.
5. Start the GET program for QUEUE1 on QUEUE.MANAGER.1 by entering the following command:

./amqsgetc QUEUE1 QUEUE.MANAGER.1

The sample program starts, and your message is displayed. After a short pause (approximately 30
seconds), the sample ends and the command prompt is displayed again.

Results
You have now successfully verified the client installation.

What to do next
1. You must set various environment variables on the server so that the installation can be used in the
current shell. You can set the environment variables by entering the following command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

2. On the server, stop the queue manager by entering the following command:

endmqm QUEUE.MANAGER.1

3. On the server, delete the queue manager by entering the following command:

dltmqm QUEUE.MANAGER.1

Uninstalling or modifying IBM MQ on AIX

On AIX, you can uninstall the IBM MQ server or client using the System Management Interface Tool
(SMIT) or the installp command. You can also modify an installation by uninstalling a subset of the file
sets.

Before you begin

If any updates have been applied, remove them before starting the uninstallation or modification
procedure. For more information, see Reverting to the previous maintenance level on AIX.
Important: You must stop all IBM MQ queue managers, other objects, and applications, before you begin
the process to uninstall or modify IBM MQ.

Procedure
1. Stop all IBM MQ applications associated with the installation you are uninstalling or modifying, if you
have not already done so.
2. For a server installation, end any IBM MQ activity associated with the installation you are uninstalling
or modifying:
a) Log in as a user in the group mqm.
b) Set up your environment to work with the installation you want to uninstall or modify. Enter the
following command:

. MQ_INSTALLATION_PATH/bin/setmqenv

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

c) Display the state of all queue managers on the system. Enter the following command:

60 Installing IBM MQ
 dspmq -o installation

d) Stop all running queue managers associated with the installation you want to uninstall or modify.
Enter the following command for each queue manager:

endmqm QMgrName

e) Stop any listeners associated with the queue managers. Enter the following command for each
queue manager:

endmqlsr -m QMgrName

3. Log in as root.
4. Uninstall or modify IBM MQ using either installp or smit. If IBM MQ was installed in a non-default
location, you must use installp.
• To uninstall or modify IBM MQ by using installp, enter one of the following commands:
– To uninstall an installation in the default location /usr/mqm:

installp -u mqm

– To uninstall an installation in a non-default location:

installp -R usil -u mqm

where usil is the path of the User Specified Installation Location (USIL) specified when the
product was installed.
– To modify an installation in a non-default location:

installp -R usil -u list of file sets

where usil is the path of the User Specified Installation Location (USIL) specified when the
product was installed.
• To uninstall or modify IBM MQ by using smit, complete the following steps:
a. Select the required smit window using the following sequence:

Software Installation and Maintenance

Software Maintenance and Utilities
Remove Installed Software

b. List the software in the SOFTWARE name field:

i) Enter .
ii) Press F4
c. Select the file sets to uninstall from the list (those beginning with mqm):
– For a complete uninstall, select all file sets.
– To modify the installation, select a subset of the file sets.
After selecting the file sets, press Enter. There is an option at this stage to do a preview. Leave
the option set to the default value of Yes to preview the file sets you are uninstalling, or select
No to not preview these file sets.
d. Press Enter on the Remove Installed Software panel, it asks whether you are sure, press Enter.

Installing and uninstalling IBM MQ 61

 Results
After uninstallation, certain files under the directory trees /var/mqm and /etc/opt/mqm are not
removed. These files contain user data and remain so subsequent installations can reuse the data.
Most of the remaining files contain text, such as INI files, error logs, and FDC files. The directory
tree /var/mqm/shared contains files that are shared across installations, including the executable
shared libraries libmqzsd.a and libmqzsd_r.a.

What to do next
• If the product successfully uninstalled, you can delete any files and directories contained in
the /usr/mqm directory under the User Specified Installation Location (USIL) specified in the
installp uninstallation command.
• Use the lslpp command to check for other products installed in the USIL. If there are no other
products installed in the USIL and you do not intend to use it again, you can delete the USIL using the
rmusil command.
• If there are no other IBM MQ installations on the system, and you are not planning to reinstall
or migrate, you can delete the /var/mqm and /etc/opt/mqm directory trees, including the files
libmqzsd.a and libmqzsd_r.a. Deleting these directories destroys all queue managers and their
associated data.
• You can optionally remove installations, once IBM MQ is uninstalled, from the Installation configuration
file, mqinst.ini using the commands listed.
Note: If you are not going to install another version of IBM MQ, you can delete the existing installations
using the dltmqinst command. Otherwise, if you install IBM MQ to the same location, the old
installation name is applied.

Installing and uninstalling IBM MQ on IBM i

Installation tasks that are associated with installing IBM MQ on IBM i systems are grouped in this section.

About this task

To prepare for installation and to install the IBM MQ components, complete the following tasks.
For information about how to uninstall IBM MQ, see “Uninstalling IBM MQ for IBM i” on page 89.
If product fixes or updates are made available, see Applying maintenance to IBM MQ .

Procedure
1. Check the system requirements.
See “Hardware and software requirements on IBM i systems” on page 63.
2. Plan your installation.
• As part of the planning process, you must choose which components to install and where to install
them. See “IBM MQ components for IBM i” on page 63.
• You must also make some platform-specific choices. See “Planning to install IBM MQ on IBM i” on
page 64.
3. Prepare your system for installation of IBM MQ.
See “Preparing the system on IBM i” on page 65.
4. Install IBM MQ server.
See “Installing IBM MQ server on IBM i” on page 66.
5. Optional: Install an IBM MQ client.
See “Installing an IBM MQ client on IBM i” on page 79.
6. Verify your installation. See “Verifying an IBM MQ installation on IBM i” on page 84.

62 Installing IBM MQ
 IBM MQ components for IBM i
The IBM MQ components that are available for IBM i.
Important: See IBM MQ license information for details of what each purchase of IBM MQ entitles you to
install.
The components are as follows:
Server (Base)
Support to enable you to create and support your own applications. This includes the runtime
component that provides support for external applications. It also includes support for client
connections from IBM MQ installations on other computers.
Samples (Option 1)
Sample application programs. The source is supplied in the QMQMSAMP library and executable files
are supplied in the QMQM library.
AMS (Option 2)
The AMS component.
Web Console and REST API (Option 3)
Adds HTTP based administration for IBM MQ through the REST API and IBM MQ Console.
To use this feature, you must install the following prerequisites:
• 5724L26 IBM MQ Java Messaging and Web Services
• 5770JV1 Java SE 8
Managed File Transfer (MFT) components
*BASE
Support to enable you to create and support your own MFT applications. It also includes support
for client connections from IBM MQ MFT installations on other computers.
2
Tools support
3
Agent
4
Services
You must install *BASE first because the other three options depend on *BASE. Note that option 4
requires that option 3 is installed.
Related concepts
“IBM MQ components and features” on page 6
You can select the components or features that you require when you install IBM MQ.

Hardware and software requirements on IBM i systems

Check that the server environment meets the prerequisites for installing IBM MQ for IBM i.
Before installation, you must check that your system meets the hardware and software requirements set
out in the IBM MQ system requirements page. See System Requirements for IBM MQ.

Storage requirements for IBM MQ server

The storage requirements for IBM i depend on which components you install, and how much working
space you need. The storage requirements also depend on the number of queues that you use, the
number and size of the messages on the queues, and whether the messages are persistent. You also
require archiving capacity on disk, tape, or other media. For more information, see System Requirements
for IBM MQ.
Disk storage is also required:

Installing and uninstalling IBM MQ 63

 • Prerequisite software
• Optional software
• Your application programs

Installing prerequisite software

To install the prerequisite software provided on the IBM MQ Server DVD (which does not include service
packs or web browsers), do one of the following:
• Use the IBM MQ installation procedure.
When you install using the IBM MQ Server DVD, there is a Software Prerequisites option in the IBM MQ
Installation Launchpad window. You can use this option to check what prerequisite software is already
installed and which is missing, and to install any missing software.

Prerequisite PTFs for multiple certificate support

You are not limited to a single certificate for TLS channels. To use multiple certificates on IBM i platforms,
you must install the following program temporary fixes (PTFs):
MF57749
MF57889
SI52214
MF58003
See Digital certificate labels: understanding the requirements for details about how to select certificates
by using certificate labels.
Related concepts
“License requirements” on page 8
You must have purchased sufficient licenses for your installation. The details of the license agreement
is stored on your system at installation time so that you can read it at any time. IBM MQ supports IBM
License Metric Tool (ILMT).
“Where to find product requirements and support information” on page 9
Before you install IBM MQ, you must check for the latest information and system requirements.

Planning to install IBM MQ on IBM i

Before you install IBM MQ on IBM i, you must choose which components to install and where to install
them. You must also make some platform-specific choices.

About this task

The following steps provide links to additional information to help you with planning your installation of
IBM MQ on IBM i.

Procedure
1. As part of your planning activities, make sure that you review the information on hardware and
software requirements for the platform on which you are planning to install IBM MQ.
For more information, see “Hardware and software requirements on IBM i systems” on page 63.
2. Decide which IBM MQ components and features to install.
See “IBM MQ components and features” on page 6 and “Where to find downloadable installation
images” on page 9.
Important: Ensure that your enterprise has the correct license, or licenses, for the components that
you are going to install. For more information, see “License requirements” on page 8 and IBM MQ
license information.

64 Installing IBM MQ
 Preparing the system on IBM i
On IBM i systems, you might have to complete several tasks before you install IBM MQ. You might also
want to complete other tasks, depending on your installation intentions.

About this task

The tasks that you perform to prepare your systems for installation are listed here. Complete the
appropriate tasks for your platform before installing.

Procedure
Configure any additional settings needed for your IBM i system.
See “Configuring and tuning the operating system on IBM i” on page 65.

What to do next
When you have completed the tasks to prepare the system, you are ready to start installing IBM MQ. To
install a server, see “Installing IBM MQ server on IBM i” on page 66. To install a client, see “Installing an
IBM MQ client on IBM i” on page 79.
Related tasks
Planning
Maintaining and migrating
Applying maintenance to IBM MQ

Configuring and tuning the operating system on IBM i

Before installing IBM MQ for IBM i, there are several system values which need to be checked using the
DSPSYSVAL command. If necessary, reset the values using the CHGSYSVAL command.
Check the following values and change if required:
QCCSID
Every message has a coded-character set identifier (CCSID) in its header. The CCSID tag identifies the
code page and character set of the source.
A queue manager obtains its CCSID from the job that created it. If the job CCSID is not a valid value
in the range 1-65534, the queue manager uses the default CCSID value (65535) instead. You can
change the CCSID used by the IBM MQ queue manager by using the CL command CHGMQM.
Note: The CCSID must be either single-byte character set (SBCS), or mixed, that is SBCS and DBCS. It
must not be DBCS only.
QSYSLIBL
Ensure that QSYS2 is included in the list of libraries that make up the system part of the library list.
IBM MQ uses programs in this library for data conversion and SNA LU 6.2 communication.
Note: Do not have QMQM as part of the system or user portion of the library list.
QALWOBJRST
Ensure that the QALWOBJRST system value is set to *ALL or *ALWPGMADP before you install MQ. If it
is set to *NONE, installation fails.
After installation, reset QALWOBJRST to its original value to maintain system security.
QSHRMEMCTL
Ensure that the QSHRMEMCTL system value is set to 1 (Allowed).
A value of 1 is used in environments where pointers can be shared amongst programs between
different jobs.
IBM MQ requires this setting to use the shared memory APIs shmat and shmget and to share its
pointers across jobs.

Installing and uninstalling IBM MQ 65

 If it is not set correctly, initialization of IBM MQ fails with system return code "3401" (Permission
denied), and commands such as CRTMQM, STRMQM, ENDMQM, TRCMQM fail.
QFRCCVNRST
Ensure that the QFRCCVNRST system value is set to 0 (Restore all objects without conversion), or 1
(Objects with validation errors are converted), before you install MQ. If it is not set, installation fails.
QMLTTHDACN
Optionally set this to control the generation of messages into joblogs. Set QMLTTHDACN to 2 to
get messages generated in a joblog; set it to 1 to avoid the messages. For example, the message
CPD000D is an informational message that is generated when a command that is not thread-safe is
issued from a multi-threaded application. Setting QMLTTHDACN to 1 avoids the message.
Related concepts
“Hardware and software requirements on IBM i systems” on page 63
Check that the server environment meets the prerequisites for installing IBM MQ for IBM i.
“License requirements” on page 8
You must have purchased sufficient licenses for your installation. The details of the license agreement
is stored on your system at installation time so that you can read it at any time. IBM MQ supports IBM
License Metric Tool (ILMT).
Related tasks
“Installing IBM MQ server on IBM i” on page 66
You install IBM MQ for IBM i by installing the IBM MQ server in its primary language, installing samples
and installing additional languages.

Installing IBM MQ server on IBM i

You install IBM MQ for IBM i by installing the IBM MQ server in its primary language, installing samples
and installing additional languages.

Before you begin

Note: Installing the latest version of the IBM MQ server includes client capabilities. Only install the
stand-alone client if you do not need the server capabilities.
You have completed planning the installation, obtained the installation DVD and set the system values,
see “Configuring and tuning the operating system on IBM i” on page 65. For a complete list of IBM MQ
installable services and components for IBM i systems, see Installable services and components for IBM i

About this task

How to install the base IBM MQ server in its primary language, install samples, and install translated
versions from a choice of national-languages.
You can install only one instance of IBM MQ for IBM i in each partition of your server.

Procedure
1. Sign on to the system with a user profile that has *ALLOBJ special authority, for example QSECOFR.
2. Install the IBM MQ for IBM i base product, and primary language.

RSTLICPGM LICPGM (5724H72) DEV (installation device) OPTION (*BASE) OUTPUT (*PRINT)

where the parameters of RSTLICPGM are,

LICPGM(5724H72)
The product identifier for IBM i.
DEV(installation device)
The device from which the product is to be loaded, typically an optical drive, for example, OPT01.

66 Installing IBM MQ
 OPTION (*BASE)
Install the IBM MQ for IBM i base product.
Unspecified parameters
Unspecified parameters, such as RSTOBJ (*ALL), revert to defaults. The command installs both
IBM MQ and the language files for the primary language of your system. For installing additional
languages, see step 4.
3. Optional: Install the samples using the command:

RSTLICPGM LICPGM (5724H72) DEV (installation device) OPTION (1) OUTPUT (*PRINT)

Where the parameters of RSTLICPGM are,

LICPGM (5724H72)
The product identifier for IBM i.
DEV (installation device)
The device from which the product is to be loaded, typically an optical drive, for example, OPT01.
OPTION (1)
Install the samples for IBM i.
OUTPUT (*PRINT)
The output is printed with the spooled output of the job.
4. Optional: Install the AMS component by using the following command:

RSTLICPGM LICPGM (5724H72) DEV (installation device) OPTION (2) OUTPUT (*PRINT)

Where the parameters of RSTLICPGM are,

LICPGM (5724H72)
The product identifier for IBM i.
DEV (installation device)
The device from which the product is to be loaded, typically an optical drive, for example, OPT01.
OPTION (2)
Install AMS for IBM i.
OUTPUT (*PRINT)
The output is printed with the spooled output of the job.
5. Optional: Install the WEB component by using the following command:

RSTLICPGM LICPGM (5724H72) DEV (installation device) OPTION (3) OUTPUT (*PRINT)

Where the parameters of RSTLICPGM are,

LICPGM (5724H72)
The product identifier for IBM i.
DEV (installation device)
The device from which the product is to be loaded, typically an optical drive, for example, OPT01.
OPTION (3)
Install the WEB component for IBM i.
OUTPUT (*PRINT)
The output is printed with the spooled output of the job.
Note: To use this feature, you must install the following prerequisites:
• 5724L26 IBM MQ Java Messaging and Web Services
• 5770JV1 Java SE 8
6. Optional: To install additional languages, sign on to the system with a user profile that has *ALLOBJ
special authority. Choose a language code from the table.

Installing and uninstalling IBM MQ 67

 Table 8. Globalizations of IBM MQ for IBM i.
Language ID Language
2909 Belgian English
2966 Belgian French MNCS (Multi-National Character Set)
2980 Brazilian Portuguese
2981 Canadian French MNCS
2975 Czech
2924 English uppercase and lowercase
2984 English US DBCS
2938 English US uppercase DBCS
2928 French
2940 French MNCS
2929 German
2939 German MNCS
2976 Hungarian
2932 Italian
2942 Italian MNCS
2962 Japanese
2930 Japanese Universal
2986 Korean
2978 Polish
2979 Russian
2989 Simplified Chinese
2931 Spanish

• If installing Japanese language feature code 2962, ensure the CCSID of the job installing the
product is set to 939 and not 930. Do this to avoid problems with invariant lowercase characters
in CCSID 930

CHGJOB CCSID(939)

• If the language feature code is not in the table then the product has not been translated into your
language. You must choose one of the available language feature codes and install that version
instead. You must manually change the system library list to use IBM MQ in that language load.

CHGSYSLIBL LIB(QSYS2924)

See also How a language of your choice is displayed for licensed programs in How a language is
displayed for IBM i functions in the IBM i product documentation.
• If you are using Korean DBCS and you configure your terminal emulators to 24*80 sessions you
might find that EDTF incorrectly displays DBCS characters in MQ error log messages that extend
beyond 80 columns. To avoid this, configure your terminal emulators to use sessions capable of
displaying 132 columns, for example 27*132.

68 Installing IBM MQ
 • Issue the following command specifying the appropriate language ID:

RSTLICPGM LICPGM(5724H72) DEV( installation device ) RSTOBJ(*LNG) LNG( language ID )

This installs the commands, message file, and panel groups into the relevant QSYS library for the
language. For example, library QSYS2928 is used for French. If this QSYS29nn library does not
exist, it is created by the RSTLICPGM command.
7. To ensure that the product has loaded correctly, issue the Display Software Resources (DSPSFWRSC)
command and check that the licensed program 5724H72 is listed. If you have installed the base and
the optional samples, you see:

Resource
ID Option Feature Description
5724H72 *BASE 5050 IBM MQ for IBM i
5724H72 *BASE 2924 IBM MQ for IBM i
5724H72 1 5050 IBM MQ for IBM i - Samples

8. Press F11, while viewing the Display Software Resources screen, and you see the library and version
number of the products installed:

Resource Feature
ID Option Feature Type Library Release
5724H72 *BASE 5050 *CODE QMQM V9R2M0
5724H72 *BASE 2924 *LNG QMQM V9R2M0
5724H72 1 5050 *CODE QMQMSAMP V9R2M0

9. If you have installed additional language versions, you also see entries for these versions. For
example, if you have installed the French version, for which the language ID is 2928, you see:
a)
Resource
ID Option Feature Description
5724H72 *BASE 2928 IBM MQ for IBM i

b) and when you press F11:

Resource Feature
ID Option Feature Type Library Release
5724H72 *BASE 2928 *LNG QSYS2928 V9R2M0

10. Use the command DSPMQMVER to check exactly what version you have installed. For V9R2M0, it
reports:

Version: 9.2.0.0

11. Do the post installation tasks of checking for updates, checking program authorities and starting the
IBM MQ subsystem, see “Performing post installation tasks for IBM MQ on IBM i” on page 77.

What to do next
If you want to see how the installation went in more detail, perform one or more of the following tasks:
• View the log file using the DSPJOBLOG command.
• View the spoolfile generated from the RSTLICPGM command.
If the installation of IBM MQ fails, see “Handling installation failures for IBM i” on page 78.
Related concepts
“Uninstalling IBM MQ for IBM i” on page 89

Installing and uninstalling IBM MQ 69

 There are two ways of uninstalling IBM MQ for IBM i.

Installing IBM MQ server silently on IBM i

You can perform a non-interactive installation of IBM MQ using the CALL PGM(QSYS/QLPACAGR)
command. A non-interactive installation is also known as a silent, or unattended installation.

Before you begin

Before you start the installation procedure, make sure that you have completed the necessary steps
outlined in “Preparing the system on IBM i” on page 65.

About this task

This topic describes the non-interactive installation of a server.

Procedure
1. Pre-agree the license terms and conditions for the base by running the command,

CALL PGM ( QSYS/QLPACAGR) PARM ('5724H72' 'V9R2M0' '0000' 0)

Where the parameters of PARM are,

5724H72
The product identifier for IBM i.
V9R2M0
The version, release, and modification level.
0000
The option number for the IBM MQ product.
0
Unused error structure.
2. Optionally pre-agree the license terms and conditions for the samples by running the command,

CALL PGM (QSYS/QLPACAGR) PARM ('5724H72' 'V9R2M0' '0001' 0)

Where the parameters of PARM are,

5724H72
The product identifier for IBM i.
V9R2M0
The version, release, and modification level.
0001
The option number for the IBM MQ product.
0
Unused error structure.
3. Install the IBM MQ for IBM i base product, and primary language.

RSTLICPGM LICPGM (5724H72) DEV (installation device) OPTION (*BASE) OUTPUT (*PRINT)

where the parameters of RSTLICPGM are,

LICPGM(5724H72)
The product identifier for IBM i.
DEV(installation device)
The device from which the product is to be loaded, typically an optical drive, for example, OPT01.

70 Installing IBM MQ
 OPTION (*BASE)
Install the IBM MQ for IBM i base product.
Unspecified parameters
Unspecified parameters, such as RSTOBJ (*ALL), revert to defaults. The command installs both
IBM MQ and the language files for the primary language of your system. For installing additional
languages, see step 4.
4. Optional: Install the samples using the command:

RSTLICPGM LICPGM (5724H72) DEV (installation device) OPTION (1) OUTPUT (*PRINT)

Where the parameters of RSTLICPGM are,

LICPGM (5724H72)
The product identifier for IBM i.
DEV (installation device)
The device from which the product is to be loaded, typically an optical drive, for example, OPT01.
OPTION (1)
Install the samples for IBM i.
OUTPUT (*PRINT)
The output is printed with the spooled output of the job.
5. Optional: To install additional languages, sign on to the system with a user profile that has *ALLOBJ
special authority. Choose a language code from the table.

Table 9. Globalizations of IBM MQ for IBM i.

Language ID Language
2909 Belgian English
2966 Belgian French MNCS (Multi-National Character Set)
2980 Brazilian Portuguese
2981 Canadian French MNCS
2975 Czech
2924 English uppercase and lowercase
2984 English US DBCS
2938 English US uppercase DBCS
2928 French
2940 French MNCS
2929 German
2939 German MNCS
2976 Hungarian
2932 Italian
2942 Italian MNCS
2962 Japanese
2930 Japanese Universal
2986 Korean
2978 Polish

Installing and uninstalling IBM MQ 71

 Table 9. Globalizations of IBM MQ for IBM i. (continued)
Language ID Language
2979 Russian
2989 Simplified Chinese
2931 Spanish

• If installing Japanese language feature code 2962, ensure the CCSID of the job installing the
product is set to 939 and not 930. Do this to avoid problems with invariant lowercase characters
in CCSID 930

CHGJOB CCSID(939)

• If the language feature code is not in the table then the product has not been translated into your
language. You must choose one of the available language feature codes and install that version
instead. You must manually change the system library list to use IBM MQ in that language load.

CHGSYSLIBL LIB(QSYS2924)

See also How a language of your choice is displayed for licensed programs in How a language is
displayed for IBM i functions in the IBM i product documentation.
• If you are using Korean DBCS and you configure your terminal emulators to 24*80 sessions you
might find that EDTF incorrectly displays DBCS characters in MQ error log messages that extend
beyond 80 columns. To avoid this, configure your terminal emulators to use sessions capable of
displaying 132 columns, for example 27*132.
• Issue the following command specifying the appropriate language ID:

RSTLICPGM LICPGM(5724H72) DEV( installation device ) RSTOBJ(*LNG) LNG( language ID )

This installs the commands, message file, and panel groups into the relevant QSYS library for the
language. For example, library QSYS2928 is used for French. If this QSYS29nn library does not
exist, it is created by the RSTLICPGM command.
6. To ensure that the product has loaded correctly, issue the Display Software Resources (DSPSFWRSC)
command and check that the licensed program 5724H72 is listed. If you have installed the base and
the optional samples, you see:

Resource
ID Option Feature Description
5724H72 *BASE 5050 IBM MQ for IBM i
5724H72 *BASE 2924 IBM MQ for IBM i
5724H72 1 5050 IBM MQ for IBM i - Samples

7. Press F11, while viewing the Display Software Resources screen, and you see the library and version
number of the products installed:

Resource Feature
ID Option Feature Type Library Release
5724H72 *BASE 5050 *CODE QMQM V9R2M0
5724H72 *BASE 2924 *LNG QMQM V9R2M0
5724H72 1 5050 *CODE QMQMSAMP V9R2M0

8. If you have installed additional language versions, you also see entries for these versions. For
example, if you have installed the French version, for which the language ID is 2928, you see:
a)
Resource
ID Option Feature Description
5724H72 *BASE 2928 IBM MQ for IBM i

72 Installing IBM MQ
 b) and when you press F11:

Resource Feature
ID Option Feature Type Library Release
5724H72 *BASE 2928 *LNG QSYS2928 V9R2M0

9. Use the command DSPMQMVER to check exactly what version you have installed. For V9R2M0, it
reports:

Version: 9.2.0.0

10. Do the post installation tasks of checking for updates, checking program authorities and starting the
IBM MQ subsystem, see “Performing post installation tasks for IBM MQ on IBM i” on page 77.

What to do next
If you want to see how the installation went in more detail, perform one or more of the following tasks:
• View the log file using the DSPJOBLOG command.
• View the spoolfile generated from the RSTLICPGM command.
If the installation of IBM MQ fails, see “Handling installation failures for IBM i” on page 78.

Installing Managed File Transfer on IBM i

Install IBM MQ Managed File Transfer for IBM i by installing IBM MQ Java Messaging and Web Services
server in its primary language, and installing additional options.

Before you begin

Note: Installing the latest version of IBM MQ Managed File Transfer includes client capabilities.
You have completed planning the installation, obtained the installation DVD and set the system values,
see “Configuring and tuning the operating system on IBM i” on page 65.
You have installed the following components:

Table 10. Software requirements for IBM MQ Managed File Transfer

Program Option Description
5761JV1 14 or 15 Java SE 7 32 bit or Java SE 7 64 bit
5770SS1 39 International Components for Unicode
5724L26 *BASE IBM MQ Java Messaging and Web Services

About this task

How to install base Managed File Transfer in its primary language, and install the other options.
You can install only one instance of Managed File Transfer for IBM i in each partition of your server.

Procedure
1. Sign on to the system with a user profile that has *ALLOBJ special authority, for example QSECOFR.
2. Install Managed File Transfer for IBM i, base product.

RSTLICPGM LICPGM (5725M50) DEV (installation device) OPTION (*BASE) OUTPUT (*PRINT)

where the parameters of RSTLICPGM are,

Installing and uninstalling IBM MQ 73

 LICPGM (5725M50)
The product identifier for Managed File Transfer for IBM i.
DEV (installation device)
The device from which the product is to be loaded, typically an optical drive, for example, OPT01.
OPTION (*BASE)
Install Managed File Transfer for IBM i for the IBM MQ base product.
Unspecified parameters
Unspecified parameters such as RSTOBJ (*ALL), revert to defaults. The command installs both
IBM MQ and the language files for the primary language of your system.
3. Optional: Install the tools using the command:

RSTLICPGM LICPGM(5725M50) DEV(installation device) OPTION(2) OUTPUT(*PRINT)

Where the parameters of RSTLICPGM are,

LICPGM (5725M50)
The product identifier for Managed File Transfer for IBM i.
DEV (installation device)
The device from which the product is to be loaded, typically an optical drive, for example, OPT01.
OPTION (2)
Install the tools for Managed File Transfer for IBM i.
OUTPUT (*PRINT)
The output is printed with the spooled output of the job.
Repeat step “3” on page 74 for options 3 (agent) and 4 (services)
4. To ensure that the product has loaded correctly, issue the Display Software Resources (DSPSFWRSC)
command and check that the licensed program 5725M50 is listed. If you have installed the base and
the optional tools, you see:

Resource
ID Option Feature Description
5725M50 *BASE 5050 Managed File Transfer for IBM i
5725M50 *BASE 2924 Managed File Transfer for IBM i
5725M50 2 5050 Managed File Transfer for IBM i - Tools

5. Press F11, while viewing the Display Software Resources screen, and you see the library and version
number of the products installed:

Resource
ID Option Feature Type Library Release
5725M50 *BASE 5050 *CODE QMQMMFT V9R2M0
5725M50 *BASE 2924 *LNG QMQMMFT V9R2M0
5725M50 2 5050 *CODE MFTTOOL V9R2M0

6. Do the post installation tasks of checking for updates, checking program authorities, and starting the
Managed File Transfer subsystem.

What to do next
If you want to see how the installation went in more detail, perform one or more of the following tasks:
• View the log file using the DSPJOBLOG command.
• View the spoolfile generated from the RSTLICPGM command.
If the installation of IBM MQ fails, see “Handling installation failures for IBM i” on page 78.

74 Installing IBM MQ
 Installing IBM MQ for IBM i from an Electronic Software Download
You can perform an installation of IBM MQ for IBM i from an installation image downloaded from IBM.

Before you begin

Before you start the installation procedure, make sure that you have completed the necessary steps
outlined in “Preparing the system on IBM i” on page 65.

About this task

Two installation images are provided as zip files, a client and server image. These images contain all the
licensed programs, and a client only image for the clients only.
The client and server image contains all seven compressed IBM i save files ( SAVF ), while the client
image contains four save files. The save files are:
• MQ92BASE - IBM MQ client and server base program objects
• MQ92SAMP - IBM MQ client & server samples
• MQ92EN24 - IBM MQ client and server English US (2924) language objects
plus the client only images:
• MQ92CBASE - IBM MQ client
• MQ92CSAMP - IBM MQ client samples
• MQ92JBASE - IBM MQ Java
• MQ92JSAMP - IBM MQ Java samples

Procedure
1. Download one of the installation images and extract it to a temporary directory.
2. On IBM i, create a library containing sufficient empty save files to hold the uploaded files by using the
commands:

CRTLIB LIB(MQ92PROD)
CRTSAVF FILE(MQ92PROD/MQ92BASE) /* Server and Client */
CRTSAVF FILE(MQ92PROD/MQ92SAMP) /* Server and Client Samples */
CRTSAVF FILE(MQ92PROD/MQ92EN24) /* 2924 English */
CRTSAVF FILE(MQ92PROD/MQ92CBASE) /* Standalone Client */
CRTSAVF FILE(MQ92PROD/MQ92CSAMP) /* Standalone Client Samples */
CRTSAVF FILE(MQ92PROD/MQ92JBASE) /* Java and JMS Classes */
CRTSAVF FILE(MQ92PROD/MQ92JSAMP) /* Java and JMS Samples */

For additional languages

Installing and uninstalling IBM MQ 75

 CRTSAVF FILE(MQ92PROD/MQ92EN09) /* 2929 Belgian English */
CRTSAVF FILE(MQ92PROD/MQ92FR28) /* 2928 French */
CRTSAVF FILE(MQ92PROD/MQ92JA30) /* 2930 Japanese */
CRTSAVF FILE(MQ92PROD/MQ92ES31) /* 2931 Spanish */
CRTSAVF FILE(MQ92PROD/MQ92IT32) /* 2932 Italian */
CRTSAVF FILE(MQ92PROD/MQ92EN38) /* 2938 English DBCS UPPERCASE */
CRTSAVF FILE(MQ92PROD/MQ92FR40) /* 2940 French MNCS */
CRTSAVF FILE(MQ92PROD/MQ92IT42) /* 2942 Italian MNCS */
CRTSAVF FILE(MQ92PROD/MQ92FR66) /* 2966 French MNCS */
CRTSAVF FILE(MQ92PROD/MQ92FR81) /* 2981 French MNCS */
CRTSAVF FILE(MQ92PROD/MQ92EN84) /* 2984 English DBCS */
CRTSAVF FILE(MQ92PROD/MQ92CZ75) /* 2975 Czech */
CRTSAVF FILE(MQ92PROD/MQ92HU76) /* 2976 Hungarian */
CRTSAVF FILE(MQ92PROD/MQ92PL78) /* 2978 Polish */
CRTSAVF FILE(MQ92PROD/MQ92RU79) /* 2979 Russian */
CRTSAVF FILE(MQ92PROD/MQ92PT80) /* 2980 Portugese/Brazilian */
CRTSAVF FILE(MQ92PROD/MQ92JA62) /* 2962 Japanese */
CRTSAVF FILE(MQ92PROD/MQ92KO86) /* 2986 Korean */
CRTSAVF FILE(MQ92PROD/MQ92ZH89) /* 2989 Chinese */
CRTSAVF FILE(MQ92PROD/MQ92DE29) /* 2929 German */
CRTSAVF FILE(MQ92PROD/MQ92DE39) /* 2939 German */

3. Start an ftp session to your IBM i machine and upload the required save files with the commands:

ftp (your_ibmi_hostname)
bin
put MQ92BASE MQ92PROD/MQ92BASE
put MQ92SAMP MQ92PROD/MQ92SAMP
put MQ92EN24 MQ92PROD/MQ92EN24
put MQ92CBASE MQ92PROD/MQ92CBASE
put MQ92CSAMP MQ92PROD/MQ92CSAMP
put MQ92JBASE MQ92PROD/MQ92JBASE
put MQ92JSAMP MQ92PROD/MQ92JSAMP

For additional language loads:

put MQ92EN09 MQ92PROD/MQ92EN09

put MQ92FR28 MQ92PROD/MQ92FR28
put MQ92JA30 MQ92PROD/MQ92JA30
put MQ92ES31 MQ92PROD/MQ92ES31
put MQ92IT32 MQ92PROD/MQ92IT32
put MQ92EN38 MQ92PROD/MQ92EN38
put MQ92FR40 MQ92PROD/MQ92FR40
put MQ92IT42 MQ92PROD/MQ92IT42
put MQ92FR66 MQ92PROD/MQ92FR66
put MQ92FR81 MQ92PROD/MQ92FR81
put MQ92EN84 MQ92PROD/MQ92EN84
put MQ92CZ75 MQ92PROD/MQ92CZ75
put MQ92HU76 MQ92PROD/MQ92HU76
put MQ92PL78 MQ92PROD/MQ92PL78
put MQ92RU79 MQ92PROD/MQ92RU79
put MQ92PT80 MQ92PROD/MQ92PT80
put MQ92JA62 MQ92PROD/MQ92JA62
put MQ92KO86 MQ92PROD/MQ92KO86
put MQ92ZH89 MQ92PROD/MQ92ZH89
put MQ92DE29 MQ92PROD/MQ92DE29
put MQ92DE39 MQ92PROD/MQ92DE39

4. To prepare for installation of IBM MQ for IBM i, sign on to your IBM i machine and ensure that you have
followed the instructions detailed in “Preparing the system on IBM i” on page 65.
5. Enter the RSTLICPGM commands, specifying the installation device as *SAVF and naming the save file
containing the options that you want to install.
The IBM MQ Java licensed program can be installed stand-alone or can coexist with any of the other
licensed programs.
The IBM MQ client can be installed standalone, but it can only coexist with the IBM MQ Java on the
same system.
Attempting to install the IBM MQ server on a system where the IBM MQ client is already installed
performs a slip installation upgrade, replacing the client with the server licensed program.
Attempting to install the IBM MQ client stand-alone over the top of an existing server licensed program
is not possible, and the installation fails.

76 Installing IBM MQ
 For example:

/* IBM MQ Client and Server program objects */

RSTLICPGM LICPGM(5724H72) DEV(*SAVF) SAVF(MQ92PROD/MQ92BASE) +
RSTOBJ(*PGM) OPTION(*BASE) OUTPUT(*PRINT)

/* IBM MQ Client & Server English 2924 Language Load */

RSTLICPGM LICPGM(5724H72) DEV(*SAVF) SAVF(MQ92PROD/MQ92EN24) +
RSTOBJ(*LNG) LNG(2924) OUTPUT(*PRINT)

/* Additional languages - alter SAVF and LNG parameters... */

/* IBM MQ Client & Server Japanese 2930 Language Load */
RSTLICPGM LICPGM(5724H72) DEV(*SAVF) SAVF(MQ92PROD/MQ92JA30) +
RSTOBJ(*LNG) LNG(2930) OUTPUT(*PRINT)

/* IBM MQ Client & Server Samples */

RSTLICPGM LICPGM(5724H72) DEV(*SAVF) SAVF(MQ92PROD/MQ92SAMP) +
OPTION(1) OUTPUT(*PRINT)

/* IBM MQ Java */
RSTLICPGM LICPGM(5724L26) DEV(*SAVF) SAVF(MQ92PROD/MQ92JBASE) +
OPTION(*BASE) OUTPUT(*PRINT)

/* IBM MQ Java Samples */

RSTLICPGM LICPGM(5724L26) DEV(*SAVF) SAVF(MQ92PROD/MQ92JSAMP) +
OPTION(1) OUTPUT(*PRINT)

/* IBM MQ Client */
RSTLICPGM LICPGM(5725A49) DEV(*SAVF) SAVF(MQ92PROD/MQ92CBASE) +
OPTION(*BASE) OUTPUT(*PRINT)

/* IBM MQ Client Samples */

RSTLICPGM LICPGM(5725A49) DEV(*SAVF) SAVF(MQ92PROD/MQ92CSAMP) +
OPTION(1) OUTPUT(*PRINT)

6. Do the post installation tasks of checking for updates, checking program authorities and starting the
IBM MQ subsystem, see “Performing post installation tasks for IBM MQ on IBM i” on page 77.

What to do next
If you want to see how the installation went in more detail, perform one or more of the following tasks:
• View the log file using the DSPJOBLOG command.
• View the spoolfile generated from the RSTLICPGM command.
If the installation of IBM MQ fails, see “Handling installation failures for IBM i” on page 78.

Performing post installation tasks for IBM MQ on IBM i

Tasks to perform after you have installed IBM MQ for IBM i, and before using it.

About this task

When you have correctly installed IBM MQ for IBM i on your system:

Procedure
1. See the IBM MQ website at IBM MQ product page for the latest product information.
2. Install and apply all fix packs.
3. Where you have more than one system and a mixture of releases of OS/400 or IBM i, and IBM MQ, you
must take care when compiling CL programs. You must compile CL programs either on the system they
are to run on, or on one with an identical combination of releases of OS/400 or IBM i, and IBM MQ.
When you install later versions of IBM MQ, delete all IBM MQ commands from previous releases in any
QSYSVvRrMm libraries using the QSYS/DLTCMD command.
4. If you have not installed IBM MQ on your system before, you must add user profiles to the QMQMADM
group profile. Make all user profiles that are to be used for creating and administering queue managers
members of the QMQMADM group profile, using the command CHGUSRPRF.

Installing and uninstalling IBM MQ 77

 a) Start the IBM MQ subsystem, by issuing the command:

STRSBS SBSD(QMQM/QMQM)

Note: The subsystem must be started after each IPL of the system, so you might choose to start it
as part of your system startup process.

5. Create the system-default objects. The system-default objects are created automatically
when you issue the CRTMQM command to create a queue manager. For example: CRTMQM
MQMNAME(QMGRNAME) ASP(*SYSTEM). You can refresh them using the STRMQM command
(Warning: this command will replace any existing default objects). For example: STRMQM
MQMNAME(QMGRNAME) RDEFSYS(*YES). Refer to the onscreen help for information about using this
command.
Note: on the command STRMQM MQMNAME(QMGRNAME) RDEFSYS(*YES):
• The command does not re-create the objects, it performs a CRTxxxx REPLACE(*YES) for all of the
SYSTEM.* objects.
• This means that it refreshes the parameters on the objects back to their defaults. So if, for example,
on the SYSTEM.DEFAULT.LOCAL.QUEUE object, TRGENBL had previously been changed to *YES,
then, when the command is run, it is changed back to TRGENBL(*NO).
• If any messages exist on a queue, they are not removed, because the queues are not physically
deleted.
• The contents of the SYSTEM.AUTH.DATA.QUEUE are untouched when this command is run.
• So, if the contents of this (or any other significant queue) become corrupt, it must be physically
deleted and re-created either from scratch, or from a backup.

Results
You are now ready to start using IBM MQ for IBM i.
Note: When you install IBM MQ for IBM i, two user profiles are created:
• QMQM
• QMQMADM
These two objects are central to the correct running of IBM MQ for IBM i. Do not alter or delete them. If
you do, IBM cannot guarantee correct behavior of your product.
If you uninstall IBM MQ and data, these profiles are deleted. If you uninstall IBM MQ only, these profiles
are retained.

Handling installation failures for IBM i

If the installation of IBM MQ Server or Client for IBM i fails, you must remove the installed and partially
installed objects before attempting reinstallation.

Procedure
1. Delete installed options using DLTLICPGM LICPGM(5725A49)OPTION(*ALL).
2. Delete partially installed options by deleting the QMQM library (and the QMQMSAMP libraries if
necessary).
3. Delete the IFS directory /QIBM/ProdData/mqm and its subdirectories using the EDTF command, for
example: EDTF STMF('/QIBM/ProdData') and select option 9 for the mqm directory.
If the installation of IBM MQ Java fails, remove the partly installed objects before attempting
reinstallation:

78 Installing IBM MQ
 a. Delete the QMQMJAVA library.
b. Delete the IFS directory /QIBM/ProdData/mqm/java and its subdirectories using the EDTF
command, for example:

EDTF STMF ('/QIBM/ProdData/mqm')

Select option 9 against the Java directory.

Converting a trial license on IBM i

Convert a trial license to a full license without reinstalling IBM MQ.
When the trial license expires, the "count-down" displayed by the strmqm command informs you the
license has expired, and the command does not run.

Before you begin

1. IBM MQ is installed with a trial license.
2. You have access to the installation media of a fully licensed copy of IBM MQ.

About this task

Run the setmqprd command to convert a trial license to a full license.
If you do not want to apply a full license to your trial copy of IBM MQ, you can uninstall it at any time.

Procedure
1. Obtain the full license from the fully licensed installation media.
The full license file is amqpcert.lic.
2. Run the setmqprd command from the installation that you are upgrading:

CALL PGM(QMQM/SETMQPRD) PARM('LICENSE_PATH/amqpcert.lic')

where LICENSE_PATH is the path to the amqpcert.lic file that you obtained.
Related reference
setmqprd

Installing an IBM MQ client on IBM i

The IBM MQ client for IBM i is a part of the IBM MQ product.

Before you begin

Attention: If you have already installed the IBM MQ server, you already have a client and must not
attempt to install the stand-alone client.
You can install only one instance of IBM MQ client for IBM i in each partition of your server.
When you install IBM MQ client for IBM i two user profiles are created:
• QMQM
• QMQMADM
These two objects are central to the correct running of IBM MQ for IBM i. Do not alter or delete them.
If you do, IBM cannot guarantee correct behavior of your product. These profiles are retained when the
product is deleted.

Installing and uninstalling IBM MQ 79

 About this task
This procedure covers the installation of both the client and the client samples. If you do not want to
install the client samples, then do not complete the steps specific to the samples.
After following the optional step to pre-agree the license, and then issuing the RSTLICPGM command, the
installation runs without requiring any interactive input.

Procedure
1. Sign on to the system with a user profile that has *ALLOBJ special authority, for example QSECOFR.
2. Optional: Pre-agree the license terms and conditions. If you do not choose to pre-agree the license,
the license agreement is displayed for you to accept. Run the following commands to pre-agree the
license terms and conditions:
a) For the client:

CALL PGM (QSYS/QLPACAGR) PARM ('5725A49' 'V9R2M0' '0000' 0)

The parameters of PARM are:

5725A49
The product identifier for IBM MQ client for IBM i
V9R2M0
The version, release, and modification level
0000
The option number for the base IBM MQ client for IBM i product
0
Unused error structure
b) For the client samples:

CALL PGM (QSYS/QLPACAGR) PARM ('5725A49' 'V9R2M0' '0001' 0)

The parameters of PARM are:

5725A49
The product identifier for IBM MQ client for IBM i
V9R2M0
The version, release, and modification level
0001
The option number for the samples
0
Unused error structure
3. Issue the installation command to run the installation without requiring any interactive input:
a) Install the client by issuing the following command:

RSTLICPGM LICPGM (5725A49) DEV (installation device) OPTION (*BASE) OUTPUT (*PRINT)

The parameters of RSTLICPGM are:

LICPGM (5725A49)
The product identifier for IBM MQ client for IBM i
DEV (installation device)
The device from which the product is to be loaded, typically an optical drive, for example,
OPT01

80 Installing IBM MQ
 OPTION (*BASE)
The level of IBM MQ client for IBM i product installed
OUTPUT (*PRINT)
Whether the spooled output of the job is printed
b) Install the samples by issuing the following command:

RSTLICPGM LICPGM (5725A49) DEV (installation device) OPTION (1) OUTPUT (*PRINT)

The parameters of RSTLICPGM are:

LICPGM (5725A49)
The product identifier for IBM MQ client for IBM i
DEV (installation device)
The device from which the product is to be loaded, typically an optical drive, for example,
OPT01
OPTION (1)
The samples option
OUTPUT (*PRINT)
Whether the spooled output of the job is printed
4. To ensure that the product has loaded correctly, issue the Display Software Resources ( DSPSFWRSC )
command and check that the licensed program 5725A49 is listed. If you have installed the base and
the optional samples, you see:

Resource
ID Option Feature Description
5725A49 *BASE 5050 IBM MQ client for IBM i
5725A49 1 5050 IBM MQ client for IBM i -Samples

5. To see the library and version number of the products installed, press F11, while viewing the Display
Software Resources screen. The following screen is displayed:

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

6. To check exactly what version you have installed, use the DSPMQMVER program.
For example, /QSYS.LIB/QMQM.LIB/DSPMQVER.PGM -a in a qshell.

What to do next
If you want to see how the installation went in more detail, perform one or more of the following tasks:
• View the log file using the DSPJOBLOG command.
• View the spoolfile generated from the RSTLICPGM command.
If the installation of IBM MQ client for IBM i failed, see “Handling installation failures for IBM i” on page
78
Related concepts
“Uninstalling IBM MQ for IBM i” on page 89

Installing and uninstalling IBM MQ 81

 There are two ways of uninstalling IBM MQ for IBM i.

Installation of IBM MQ client and IBM MQ server for IBM i

When you install an IBM MQ server on an IBM i system, the client is also automatically installed.
The installed version of the IBM MQ client for IBM i can be refreshed by using a "slip installation" which
replaces an existing installation with a fresh image.
Installing a client over an existing client results in a successful installation.
Installing a client over an existing server results in a failure with a CPDB6A4 error.
Installing a server over an existing client results in a successful upgrade of the client to both server and
client capabilities.

Installing IBM MQ Java messaging and web services for IBM i

Install IBM MQ Java messaging and web services for IBM i from the server DVD, using the RSTLICPGM
command.

Before you begin

You can install only one instance of IBM MQ Client for IBM i in each partition of your server.
If you have an older version of Java messaging and web services (5724L26) installed and want to install a
newer version, you can install the new version without uninstalling the older one.
If you have MA88 installed (5648C60), and try to install anyway, the installation fails with a warning
requesting you to uninstall the old client. To uninstall MA88, issue the following command:

DLTLICPGM LICPGM(5648C60) OPTION(*ALL)

If this command fails to delete the IFS directory /QIBM/ProdData/mqm/java and its subdirectories,
use the EDTF command and select option 9 against the Java directory. For example:

EDTF STMF('/QIBM/ProdData/mqm')

About this task

This procedure covers the installation of both the Java messaging and web services, and the Java
messaging and web services samples. If you do not want to install the samples, then do not complete the
steps specific to the samples.
After following the optional step to pre-agree the license, and then issuing the RSTLICPGM command, the
installation runs without requiring any interactive input.

Procedure
1. Sign on to the system with a user profile that has *ALLOBJ special authority, for example QSECOFR.
2. Optional: Pre-agree the license terms and conditions. If you do not choose to pre-agree the license,
the license agreement is displayed for you to accept. Run the following commands to pre-agree the
license terms and conditions:
a) For Java messaging and web services:

CALL PGM (QSYS/QLPACAGR) PARM ('5724L26' 'V9R2M0' '0000' 0)

The parameters of PARM are:

82 Installing IBM MQ
 5724L26
The product identifier for IBM MQ Java messaging and web services for IBM i
V9R2M0
The version, release, and modification level
0000
The option number for the base IBM MQ Java messaging and web services product.
0
Unused error structure
b) For the samples:

CALL PGM (QSYS/QLPACAGR) PARM ('5724L26' 'V9R2M0' '0001' 0)

The parameters of PARM are:

5724L26
The product identifier for IBM MQ Java messaging and web services for IBM i
V9R2M0
The version, release, and modification level
0001
The option number for the samples.
0
Unused error structure
3. Issue the installation command to run the installation without requiring any interactive input:
a) Install the IBM MQ Java messaging and web services by issuing the following command:

RSTLICPGM LICPGM (5724L26) DEV (installation device) OPTION (*BASE) OUTPUT (*PRINT)

The parameters of RSTLICPGM are:

LICPGM (5724L26)
The product identifier for IBM MQ Java messaging and web services for IBM i
DEV (installation device)
The device from which the product is to be loaded, typically an optical drive, for example,
OPT01
OPTION (*BASE)
Install the base IBM MQ Java messaging and web services for IBM i
OUTPUT (*PRINT)
Whether the spooled output of the job is printed
b) Install the samples by issuing the following command:

RSTLICPGM LICPGM (5724L26) DEV (installation device) OPTION (1) OUTPUT (*PRINT)

The parameters of RSTLICPGM are:

LICPGM (5724L26)
The product identifier for IBM MQ Java messaging and web services for IBM i
DEV (installation device)
The device from which the product is to be loaded, typically an optical drive, for example,
OPT01
OPTION (1)
Install the samples
OUTPUT (*PRINT)
Whether the spooled output of the job is printed

Installing and uninstalling IBM MQ 83

 4. To ensure that the product has loaded correctly, issue the Display Software Resources (DSPSFWRSC)
command and check that the licensed program 5724L26 is listed. If you have installed the base and
the optional samples, you see:

Resource
ID Option Feature Description
5724L26 *BASE 5050 IBM MQ Java Messaging and Web Services
5724L26 1 5050 IBM MQ Java Messaging and Web Services - Samp

5. Press F11 while viewing the Display Software Resources screen, and you see the library and version
number of the products installed:

Resource Feature
ID Option Feature Type Library Release
5724L26 *BASE 5050 *CODE QMQMJAVA V9R2M0
5724L26 1 5050 *CODE QMQMJAVA V9R2M0

6. Check what versions you have installed by using the following commands:
IBM MQ Classes for Java:

java com.ibm.mq.MQJavaLevel

Note: For this command to work, you might have to set your environment classpath to:
• /QIBM/ProdData/mqm/java/lib/com.ibm.mq.jar
IBM MQ Classes for Java Message Service:

java com.ibm.mq.jms.MQJMSLevel

Note: For this command to work, you might need to set your environment classpath to:
• /QIBM/ProdData/mqm/java/lib/com.ibm.mqjms.jar
See Environment variables relevant to IBM MQ classes for Java and Environment variables used by
IBM MQ classes for JMS.
For IBM MQ for IBM i 9.2, both report:

Version: 9.2.0.0

Note: The command uses the Java classes, and so it reports the version and also performs some
verification that the classes are installed and working.
7. See the following topics for full details of verification of both:
• Using IBM MQ classes for Java
• Using IBM MQ classes for JMS

Verifying an IBM MQ installation on IBM i

The topics in this section provide instructions on how to verify a client installation of IBM MQ on IBM i
systems.

Verifying a client installation using the command line on IBM i

You can verify a client installation using the command line. On the server you create a queue manager,
a local queue, a listener, and a server-connection channel. You must also apply security rules to allow
the client to connect and make use of the queue defined. On the client you create a client-connection
channel, and then use the sample PUT and GET programs to complete the verification procedure.
The verification procedure shows how to create a queue manager called queue.manager.1, a local
queue called QUEUE1, and a server-connection channel called CHANNEL1 on the server.

84 Installing IBM MQ
It shows how to create the client-connection channel on the IBM MQ MQI client workstation. It then
shows how to use the sample programs to put a message onto a queue, and get the message from the
queue.
The example does not address any client security issues. See Setting up IBM MQ MQI client security for
details if you are concerned with IBM MQ MQI client security issues.
The verification procedure assumes that:
• The full IBM MQ server product has been installed on a server.
• The server installation is accessible on your network.
• The IBM MQ MQI client software has been installed on a client system.
• The IBM MQ sample programs have been installed.
• TCP/IP has been configured on the server and client systems. For more information, see Configuring
connections between the server and client.
First, set up the server using the command line, using the instructions in “Setting up the server using the
command line IBM i” on page 85.
Once you have set up the server, you must set up the client, using the instructions in “Connecting to a
queue manager, using the MQSERVER environment variable on IBM i” on page 87.
Finally, you can test the communications between client and server, using the instructions in “Testing
communication between a client and a server on IBM i” on page 88.

Setting up the server using the command line IBM i

Follow these instructions to create a queue manager, queue, and channel on the server. You can then use
these objects to verify the installation.

About this task

These instructions assume that no queue manager or other IBM MQ objects have been defined.
IBM MQ object definitions are case-sensitive. Any text entered as an MQSC command in lowercase is
converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that you
type the examples exactly as shown.

Procedure
1. Create a user ID on the server that is not in the mqm group.
This user ID must exist on the server and client. This is the user ID that the sample applications must
be run as, otherwise a 2035 error is returned.
2. Log in as a user in the MQM group.
3. Create a queue manager called QUEUE.MANAGER.1 by entering the following command:

crtmqm QUEUE.MANAGER.1

You see messages telling you that the queue manager has been created.
4. Start the queue manager by entering the following command:

strmqm QUEUE.MANAGER.1

A message tells you when the queue manager has started.

5. Define a local queue called QUEUE1 by entering the following command:

CRTMQMQ QNAME(QUEUE1) QTYPE(*LCL)

A message tells you when the queue has been created.

Installing and uninstalling IBM MQ 85

 6. Allow the user ID that you created in step 1 to use QUEUE1 by entering the following command:

SET AUTHREC PROFILE(QUEUE1) OBJTYPE(QUEUE) PRINCIPAL(' non_mqm_user ') AUTHADD(PUT,GET)

where non_mqm_user is the user ID created in step 1. A message tells you when the authorization
has been set. You must also run the following command to give the user ID authority to connect:

SET AUTHREC OBJTYPE(QMGR) PRINCIPAL(' non_mqm_user ') AUTHADD(CONNECT)

If this command is not run, a 2305 stop error is returned.

7. Define a server-connection channel by entering the following command:

CRTMQMCHL CHLNAME(CHANNEL1) CHLTYPE(*SVRCN) TRPTYPE(*TCP)

MCAUSRID('QMQM')

A message tells you when the channel has been created.

8. Allow your client channel to connect to the queue manager and run under the user ID that you
created in step 1, by entering the following MQSC command:

SET CHLAUTH(CHANNEL1) TYPE(ADDRESSMAP) ADDRESS(' client_ipaddr ') MCAUSER(' non_mqm_user ')

where client_ipaddr is the IP address of the client system, and non_mqm_user is the user ID created
in step 1. A message tells you when the rule has been set.
9. Define a listener by entering the following command:

DEFINE LISTENER (LISTENER1) TRPTYPE (TCP) CONTROL (QMGR) PORT (port_number)

where port_number is the number of the port the listener is to run on. This number must be the same
as the number used when defining your client-connection channel in “Installing an IBM MQ client on
IBM i” on page 79.
Note: If you omit the port parameter from the command, a default value of 1414 is used for the
listener port. If you want to specify a port other than 1414, you must include the port parameter in
the command, as shown.
10. Start the listener by entering the following command:

STRMQMLSR MQMNAME('QUEUE.MANAGER.1') PORT(1414)

11. Stop MQSC by entering:

end

You see some messages, followed by the command prompt.

What to do next
Follow the instructions to set up the client. See “Connecting to a queue manager, using the MQSERVER
environment variable on IBM i” on page 87.

86 Installing IBM MQ
 Connecting to a queue manager, using the MQSERVER environment variable
on IBM i
When an IBM MQ application is run on the IBM MQ MQI client, it requires the name of the MQI channel,
the communication type, and the address of the server to be used. Provide these parameters by defining
the MQSERVER environment variable.

Before you begin

Before you start this task, you must complete the task, “Setting up the server using the command line
IBM i” on page 85, and save the following information:
• The host name or IP address of the server and port number that you specified when creating the
listener.
• The channel name of the server-connection channel.

About this task

This task describes how to connect an IBM MQ MQI client, by defining the MQSERVER environment
variable on the client.

Procedure
1. Log in as the userid that you created in Step 1 of “Setting up the server using the command line IBM i”
on page 85.
2. Check the TCP/IP connection. From the client, enter one of the following commands:
• ping server-hostname
• ping n.n.n.n
n.n.n.n represents the network address. You can set the network address in IPv4 dotted decimal
form, for example, 192.0.2.0. Alternatively, set the address in IPv6 hexadecimal form, for
example 2001:0DB8:0204:acff:fe97:2c34:fde0:3485.
If the ping command fails, correct your TCP/IP configuration.
3. Set the MQSERVER environment variable. From the client, enter one the following command:

ADDENVVAR ENVVAR(MQSERVER) VALUE('CHANNEL1/TCP/server-address (port)')

Where:
• CHANNEL1 is the server-connection channel name.
• server-address is the TCP/IP host name of the server.
• port is the TCP/IP port number the server is listening on.
If you do not give a port number, IBM MQ uses the one specified in the qm.ini file, or the client
configuration file. If no value is specified in these files, IBM MQ uses the port number identified in the
TCP/IP services file for the service name MQSeries. If an MQSeries entry in the services file does not
exist, a default value of 1414 is used. It is important that the port number used by the client and the
port number used by the server listener program are the same.

What to do next
Use the sample programs to test communication between the client and server; see “Testing
communication between a client and a server on IBM i” on page 88.

Installing and uninstalling IBM MQ 87

 Testing communication between a client and a server on IBM i
On the IBM MQ MQI client workstation, use the amqsputc sample program to put a message on the
queue at the server workstation. Use the amqsgetc sample program to get the message from the queue
back to the client.

Before you begin

Complete the previous topics in this section:
• Set up a queue manager, channels, and queue.
• Open a command window.
• Set system environment variables.

About this task

Note that IBM MQ object definitions are case-sensitive. Text entered as an MQSC command in lowercase
is converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that
you type the examples exactly as shown.

Procedure
1. Start the PUT program for QUEUE1 on QUEUE.MANAGER.1 by entering the following command:

CALL PGM(QMQM/AMQSPUTC) PARM(QUEUE1 QUEUE.MANAGER.1)

If the command is successful, the following messages are displayed:

Sample AMQSPUT0 start target queue is QUEUE1

Tip: You might get the error, MQRC_NOT_AUTHORIZED ( 2035 ). By default, channel authentication
is enabled when a queue manager is created. Channel authentication prevents privileged users
accessing a queue manager as an IBM MQ MQI client. For verifying the installation, you can either
change the MCA user ID to a non-privileged user, or disable channel authentication. To disable channel
authentication run the following MQSC command:

ALTER QMGR CHLAUTH(DISABLED)

When you finish the test, if you do not delete the queue manager, re-enable channel authentication:

ALTER QMGR CHLAUTH(ENABLED)

2. Type some message text, then press Enter twice.

The following message is displayed:

Sample AMQSPUT0 end

Your message is now on the queue that is on the server queue manager.
3. Start the GET program for QUEUE1 on QUEUE.MANAGER.1 by entering the following command:

CALL PGM(QMQM/AMQSGETC) PARM(QUEUE1 QUEUE.MANAGER.1)

The sample program starts, and your message is displayed. After a short pause (approximately 30
seconds), the sample ends and the command prompt is displayed again.

Results
You have now successfully verified the client installation.

88 Installing IBM MQ
What to do next
1. On the server, stop the queue manager by entering the following command:

ENDMQM MQMNAME(QUEUE.MANAGER.1)

2. On the server, delete the queue manager by entering the following command:

DLTMQM MQMNAME(QUEUE.MANAGER.1)

Uninstalling IBM MQ for IBM i

There are two ways of uninstalling IBM MQ for IBM i.
To uninstall IBM MQ for IBM i, perform one of the following tasks:
• A standard deletion removes IBM MQ product code but preserves user data.
• An entire deletion removes both IBM MQ product code and user data.
Both types of deletion require you to be signed on to the system with a user profile that has *ALLOBJ
special authority, for example, QSECOFR. Security administrator (*SECADM) special authority is also
required to delete the QMQM and QMQMADM user profiles.
Related concepts
“Reinstalling IBM MQ for IBM i” on page 94
You can reinstall IBM MQ for IBM i without losing any of your data.
Related tasks
“Uninstalling IBM MQ but retaining data on IBM i” on page 89
If you want to retain your user data, for example, because you intend to reinstall IBM MQ for IBM i at a
later date, you must perform a standard deletion of the product.
“Uninstalling IBM MQ and data on IBM i” on page 91
You can delete IBM MQ entirely, including all user data.
“Uninstalling IBM MQ Java Messaging and Web Services on IBM i” on page 92
Follow these instructions to uninstall IBM MQ Java.
“Uninstalling IBM MQ MQI client for IBM i” on page 93
If the IBM MQ MQI client for IBM i must be uninstalled, follow the correct procedure to ensure that all the
relevant directories and files are removed.

Uninstalling IBM MQ but retaining data on IBM i

If you want to retain your user data, for example, because you intend to reinstall IBM MQ for IBM i at a
later date, you must perform a standard deletion of the product.

About this task

To perform a standard deletion of IBM MQ for IBM i, so that your user data is retained, complete the
following steps:

Procedure
1. Quiesce IBM MQ for IBM i.
For more information, see Quiescing IBM MQ for IBM i .
2. End the IBM MQ subsystem, by issuing the command:

ENDSBS SBS(QMQM)

3. Ensure that no locks are held on the library QMQM, by issuing the command:

Installing and uninstalling IBM MQ 89

 WRKOBJLCK OBJ(QMQM) OBJTYPE(*LIB)

4. Use the Delete Licensed Program (DLTLICPGM) command to delete the base product (and also the
samples, AMS, and WEB components if you chose to install them).
To delete only the samples, issue the command:

DLTLICPGM LICPGM( 5724H72 ) OPTION(1)

To delete only the AMS component, issue the command:

DLTLICPGM LICPGM( 5724H72 ) OPTION(2)

To delete only the WEB component, issue the command:

DLTLICPGM LICPGM( 5724H72 ) OPTION(3)

To delete only extra language versions installed, issue the command:

DLTLICPGM LICPGM(5724H72) LNG(nnnn)

where nnnn is the language number, as in the list here:

Table 11. Globalizations of IBM MQ for IBM i.

Language ID Language
2909 Belgian English
2966 Belgian French MNCS (Multi-National Character Set)
2981 Canadian French MNCS
2975 Czech
2950 English uppercase
2924 English uppercase and lowercase
2984 English US DBCS
2938 English US uppercase DBCS
2928 French
2940 French MNCS
2929 German
2939 German MNCS
2976 Hungarian
2932 Italian
2942 Italian MNCS
2962 Japanese
2986 Korean
2978 Polish
2979 Russian

90 Installing IBM MQ
 Table 11. Globalizations of IBM MQ for IBM i. (continued)
Language ID Language
2989 Simplified Chinese
2931 Spanish

To delete the base product and all other installed components, issue the command:

DLTLICPGM LICPGM( 5724H72 ) OPTION(*ALL)

Results
Deleting IBM MQ for IBM i in this way deletes only the objects that belong to IBM MQ: the QMQM
library, the QMQM samp library, and the subdirectories that belong to IBM MQ server within the /QIBM/
ProdData/mqm directory.
If that leaves no other subdirectories (for example, if IBM MQ Java is installed it uses subdirectories
there) then the /QIBM/ProdData/mqm directory itself is deleted.
None of the queue manager journal libraries, or IFS directories based upon /QIBM/UserData are
removed.

Uninstalling IBM MQ and data on IBM i

You can delete IBM MQ entirely, including all user data.

About this task

Important: If you are going to delete IBM MQ entirely, including all user data, save your user data first. It
cannot be recovered.
To delete IBM MQ for IBM i entirely, complete the following steps:

Procedure
1. Quiesce IBM MQ for IBM i.
For more information, see Quiescing IBM MQ for IBM i .
2. Delete each queue manager in turn by using the command WRKMQM and selecting option 4.
3. End the IBM MQ subsystem, by issuing the command:

ENDSBS SBS(QMQM)

4. Ensure that no locks are held on the library QMQM, by issuing the command:

WRKOBJLCK OBJ(QMQM) OBJTYPE(*LIB)

5. Optional: If you want to also uninstall IBM MQ Java, you can do it now, using the command:

DLTLICPGM LICPGM( 5724L26 ) OPTION(*ALL)

This will also uninstall the Java Samples, if they were installed.
6. Use the Delete Licensed Program (DLTLICPGM) command to delete the base product (and also
the samples if you chose to install them). To delete the base product and the samples issue the
command:

Installing and uninstalling IBM MQ 91

 DLTLICPGM LICPGM( 5724H72 ) OPTION(*ALL)

7. Delete the directory /QIBM/UserData/mqm and its subdirectories. Do this using the EDTF command
and selecting option 9 (recursive delete) for the mqm directory, as follows,

Note: If you do this, you no longer have any information regarding your installation. Use this
command with extreme caution.
The format of the command is:

EDTF STMF('/QIBM/UserData')

Alternatively, you can delete the /QIBM/UserData/mqm directory and its subdirectories by repeated
use of the RMVLNK and RMVDIR commands.
8. Identify all the users who belong to the QMQMADM group. Use the DSPUSRPRF command to display
a list of them. You must remove the QMQMADM group profile from their user profiles before you can
delete the QMQMADM user profile. The format of the command is:

DSPUSRPRF USRPRF(QMQMADM) TYPE(*GRPMBR)

9. You must alter the ownership or delete the objects. For each of the user profiles QMQM and
QMQMADM, use the WRKOBJOWN command to list all the objects owned by the profile. The format
of the command is:

WRKOBJOWN USRPRF( PROFILE )

10. Delete the two user profiles. The format of the command is:

DLTUSRPRF USRPRF(QMQM) OWNOBJOPT(*DLT)

DLTUSRPRF USRPRF(QMQMADM) OWNOBJOPT(*DLT)

Uninstalling IBM MQ Java Messaging and Web Services on IBM i

Follow these instructions to uninstall IBM MQ Java.

About this task

To uninstall the IBM MQ Java product.

Procedure
1. Make sure you are signed on to the system with a user profile that has *ALLOBJ special authority, for
example QSECOFR.
2. Issue the command:

DLTLICPGM LICPGM(5724L26) OPTION(*ALL)

Results
Deleting IBM MQ Java for IBM i deletes the objects that belong to it: the QMQMJAVA library, and the
subdirectories that belong to IBM MQ Java within the /QIBM/ProdData/mqm directory.
If that leaves no other subdirectories (for example if the IBM MQ Server is installed it uses subdirectories
there) then the /QIBM/ProdData/mqm directory itself is deleted.

92 Installing IBM MQ
 Uninstalling IBM MQ MQI client for IBM i
If the IBM MQ MQI client for IBM i must be uninstalled, follow the correct procedure to ensure that all the
relevant directories and files are removed.

Procedure
1. Make sure you are signed on to the system with a user profile that has *ALLOBJ special authority, for
example QSECOFR.
2. Use the Delete Licensed Program ( DLTLICPGM ) command to delete the IBM MQ MQI client for IBM i
product (and also the samples if you chose to install them):
To delete only the samples, issue the command

DLTLICPGM LICPGM(5725A49) OPTION(1)

To delete IBM MQ MQI client and the samples, issue the command:

DLTLICPGM LICPGM(5725A49) OPTION(*ALL)

Results
Deleting IBM MQ MQI client for IBM i deletes the objects that belong to it - the QMQM library, and the
subdirectories that belong to IBM MQ MQI client for IBM i within the /QIBM/ProdData/mqm directory.
If that leaves no other subdirectories (for example if the IBM MQ Java Client for IBM i is installed it uses
subdirectories there) then the /QIBM/ProdData/mqm directory itself is deleted.

Uninstalling Managed File Transfer on IBM i

Follow these instructions to uninstall Managed File Transfer on IBM i.

Before you begin

To uninstall IBM MQ Managed File Transfer for IBM i, perform one of the following tasks:
• A standard deletion removes Managed File Transfer product code but preserves user data.
• An entire deletion removes both Managed File Transfer product code and user data.
Note that an entire deletion requires that you manually remove the configuration data in the /QIBM/
UserData/mqm/mqft directory.
Both types of deletion require you to be signed on to the system with a user profile that has *ALLOBJ
special authority, for example, QSECOFR.

About this task

To uninstall the Managed File Transfer product.

Procedure
1. Make sure you are signed on to the system with a user profile that has *ALLOBJ special authority, for
example QSECOFR.
2. Issue the command:

DLTLICPGM LICPGM(5725M50) OPTION(*ALL)

Installing and uninstalling IBM MQ 93

 Results
Deleting Managed File Transfer for IBM i deletes the objects that belong to it: the QMQMMFT library, and
the subdirectories that belong to Managed File Transfer within the /QIBM/ProdData/mqm directory.
Note that licence files are copied to /QIBM/ProdData/mqm/properties/version, and an
uninstallation will delete files in this directory. However, files are left in /QIBM/ProdData/mqm/
properties/5725M50 as trash. For a clean uninstallation, you must delete the files in this directory.

Reinstalling IBM MQ for IBM i

You can reinstall IBM MQ for IBM i without losing any of your data.

When you reinstall IBM MQ for IBM i, the system checks whether the IBM MQ configuration file (mqs.ini)
exists. If the file exists, it is kept and used with the newly installed system. If the file does not exist, an
empty mqs.ini file is placed in the directory /QIBM/UserData/mqm.
All data that you have in the UserData directory is referenced by the newly installed system. In addition,
all the queue manager-associated libraries containing journal and receiver information are referenced by
the new system.
Related tasks
“Installing IBM MQ server on IBM i” on page 66
You install IBM MQ for IBM i by installing the IBM MQ server in its primary language, installing samples
and installing additional languages.

Installing and uninstalling IBM MQ on Linux

Installation tasks that are associated with installing IBM MQ on Linux are grouped in this section.

About this task

To prepare for installation and to install IBM MQ, complete the following tasks.
If product fixes or updates are made available, see Applying maintenance to IBM MQ .

Procedure
• To install IBM MQ on Linux using rpm, see “Installing IBM MQ on Linux using rpm” on page 108.
• To install IBM MQ on Linux Ubuntu using a Debian installer , see “Installing IBM MQ on Linux Ubuntu
using Debian” on page 126.

Checking requirements on Linux

Before you install IBM MQ on Linux, you must check for the latest information and system requirements.

About this task

A summary of the tasks that you must complete to check system requirements are listed here with links
to further information.

Procedure
1. Check that you have the latest information, including information on hardware and software
requirements.
See “Where to find product requirements and support information” on page 9.
2. Check that your systems meet the initial hardware and software requirements for Linux.
See “Hardware and software requirements on Linux systems” on page 95.

94 Installing IBM MQ
3. Check that your systems have sufficient disk space for the installation.
See Disk space requirements.
4. Check that you have the correct licenses.
See “License requirements” on page 8 and IBM MQ license information.

What to do next
When you have completed these tasks, you are ready to start preparing your system for installation. For
the next steps in installing IBM MQ, see “Preparing the system on Linux” on page 99.
Related concepts
“IBM MQ installation overview” on page 5
An overview of concepts and considerations for installing IBM MQ, with links to instructions on how to
install, verify, and uninstall IBM MQ on each of the supported platforms.
Related tasks
Applying maintenance to IBM MQ

Hardware and software requirements on Linux systems

Before you install IBM MQ, check that your system meets the hardware and operating system software
requirements for the particular components you intend to install.
For basic hardware and software requirements, see System Requirements for IBM MQ.

Host names
IBM MQ does not support host names that contain spaces. If you install IBM MQ on a system with a host
name that contains spaces, you are unable to create any queue managers.

64-bit Linux distributions might no longer support 32-bit applications by default

Attention: From IBM MQ 9.0.0, there is no separate 32-bit client installation package. The client
installation package and redistributable client contain both 32-bit and 64-bit IBM MQ client
libraries. The included 32-bit libraries can be used by 32-bit applications on supported platforms
where 32-bit support is offered by the operating system.
If the 32-bit Linux support libraries are not installed, 32-bit applications will not run. If you need this
functionality, install the 32-bit support libraries. Here are the names of the packages that contain the
required libraries:
For Red Hat.

Red Hat Enterprise Linux for System x (64 bit):

glibc.i686
libstdc++.i686
Red Hat Enterprise Linux Server for IBM Z:
glibc.s390
libstdc++.s390

For Ubuntu.

Ubuntu Linux for System x (64 bit):

libc6:i386
libstdc++6:i386
Ubuntu Linux for IBM Z:
libc6-s390
lib32stdc++6

For SUSE Linux.

SUSE Linux Enterprise Server for System x (64 bit):

Installing and uninstalling IBM MQ 95

 glibc-32bit
libstdc++6-32bit
SUSE Linux Enterprise Server for IBM Z:
glibc-32bit
libstdc++6-32bit

Check the System Requirements for IBM MQ to see which Linux distributions are supported on IBM MQ.
For example there is no 32-bit support for SUSE Linux Enterprise Server 15 (all architectures), or for Red
Hat Enterprise Linux Server for IBM Z 8.

Java Message Service

Java 8 is bundled with IBM MQ 9.0 but client components are built with Java 7 compatibility flags on.
For development, a JDK is required, and a JRE is required for running. The JRE does not need to be the
JRE installed with IBM MQ, but has to be one from the supported list.
For a list of supported JDKs, see System Requirements for IBM MQ.
On Linux: On the Power platform, the 32 bit and 64 bit JDKs are typically installed to different locations,
for example, the 32 bit JDK is located in /opt/IBMJava2-ppc-50 and the 64 bit JDK is located
in /opt/IBMJava2-ppc64-50. Ensure that the PATH variable is correctly set for your applications that
use Java.
You can check the version installed using the following command:

java -version

Transport Layer Security (TLS)

If you want to use the TLS support, you need the IBM Global Security Kit (GSKit) V8 package. This
package is supplied with IBM MQ as one of the components available for installation.
Installing the g++ version runtime support
If you intend to run TLS channels then you must have the g++ runtime libraries installed. The GNU g++
libraries are called libgcc_s.so and libstdc++.so.6. On RPM based systems these are installed
as part of the libgcc and libstdc++ software packages.
The version of these libraries installed must be compatible with g++ version 3.4.
See System Requirements for IBM MQ for further details on the required packages for TLS support.
On 64 bit platforms, install both the 32 bit and the 64 bit versions of the package so that 32 bit and 64
bit processes can both use TLS functions.

IBM MQ Explorer requirements

On Linux, IBM MQ Explorer can be installed either as part of the product installation, or by downloading
and installing the stand-alone IBM MQ Explorer from Fix Central. See IBM MQ Explorer Requirements for
the minimum requirements that your system needs, if you want to use the IBM MQ Explorer.
Note: IBM MQ Explorer is available for use only with IBM MQ for Linux, x86 and x86-64 platforms.

RDQM (replicated data queue manager)

Pacemaker is one of the prerequisites for RDQM. Pacemaker requires that certain Linux packages are
installed on the system. The list for RHEL 7.6 assumes that a minimal set of system packages has been
installed that includes of all the mandatory and default packages from the @core package group and
mandatory packages from the @base package group. The list for RHEL 8.2 and RHEL 9 assumes that a
minimal set of system packages has been installed that includes the mandatory and default packages
from the mandatory groups of the Server environment group.

The prerequisites for supported levels of RHEL 7 (Pacemaker 1) are:

96 Installing IBM MQ
• cifs-utils
• libcgroup
• libtool-ltdl
• lm_sensors-libs
• lvm2
• net-snmp-agent-libs
• net-snmp-libs
• nfs-utils
• perl-TimeDate
• psmisc
• redhat-lsb-core

The prerequisites for supported levels of RHEL 8 (Pacemaker 2) are:

• cifs-utils
• libtool-ltdl
• libxslt
• net-snmp-libs
• nfs-utils
• perl-TimeDate
• psmisc
• python36
• python3-lxml

The prerequisites for supported levels of RHEL 9 (Pacemaker 2) are:

• libxslt
• net-snmp-libs
• nfs-utils
• nfs-utils-coreos
• perl-TimeDate
• python3-lxml
• python-unversioned-command
These packages in turn have their own requirements (which are not listed here). When Pacemaker is
installed, it reports any missing packages that also need to be installed before installation can complete
successfully.

Requirements for IBM MQ classes for .NET

See Prerequisites for .NET Core on Linux for the dependencies required to run .NET on Linux.

Installing and uninstalling IBM MQ 97

 Planning to install IBM MQ on Linux
Before you install IBM MQ on Linux, you must choose which components to install and where to install
them. You must also make some platform-specific choices.

About this task

The following steps provide links to additional information to help you with planning your installation of
IBM MQ on Linux.
As part of your planning activities, make sure that you review the information on hardware and software
requirements for the platform on which you are planning to install IBM MQ. For more information, see
“Checking requirements on Linux” on page 94.

Procedure
1. Decide which IBM MQ components and features to install.
See “IBM MQ components and features” on page 6 and “Where to find downloadable installation
images” on page 9.
Important: Ensure that your enterprise has the correct license, or licenses, for the components that
you are going to install. For more information, see “License requirements” on page 8 and IBM MQ
license information.
2. Review the options for naming your installation.
In some cases, you can choose an installation name to use instead of the default name. See
“Installation name on AIX, Linux, and Windows” on page 14.
3. Review the options and restrictions for choosing an installation location for IBM MQ.
For more information, see “Installation location on Multiplatforms” on page 15.
4. If you plan to install multiple copies of IBM MQ, see “Multiple installations on AIX, Linux, and
Windows” on page 17.
5. If you already have a primary installation, or plan to have one, see “Primary installation on AIX, Linux,
and Windows” on page 18.
6. Make sure that the communications protocol needed for server-to-server verification is installed and
configured on both systems that you plan to use.
For more information, see “Server-to-server links on AIX, Linux, and Windows” on page 26.
7. Determine whether you need to install the Java Runtime Environment (JRE).
From IBM MQ 9.1.0, if you are not using Java in your messaging applications, and you are not using
portions of IBM MQ that are written in Java, you have the option to not install the JRE (or to remove the
JRE if it was already installed).

Attention: If you choose not to install the JRE, or to remove the JRE if it was already installed:
• You must perform your key management by using the runmqakm command line tool rather
than the strmqikm GUI tool, or the runmqckm command line tool.
• The IBM Key Management shortcut is still installed. Clicking the shortcut has no effect. You
should use the runmqakm command line tool instead.
• Use of the runmqras command fails unless a JRE at version 7, or later, is available on the
system path.
On Linux, you can install IBM MQ without installing the MQSeriesJRE RPM, unless you are installing
the portions of the product that require the presence of the JRE, in which case the RPM prerequisites
test fails. From IBM MQ 9.1.0, you can also install the MQSeriesGSKit RPM without the JRE.
Upgrading from an earlier version of IBM MQ to IBM MQ 9.1.0 (or later) adds the separately installed
JRE feature to the installed product.
For more information, see Using runmqckm, runmqakm, and strmqikm to manage digital certificates.

98 Installing IBM MQ
 Preparing the system on Linux
On Linux systems, you might have to complete several tasks before you install IBM MQ. You might also
want to complete other tasks, depending on your installation intentions.

About this task

The tasks that you perform to prepare your systems for installation are listed here. Complete the
appropriate tasks for your platform before installing.

Procedure
1. Set up a user ID of the name mqm, with a primary group of mqm.
See “Setting up the user and group on Linux” on page 99.
Note: If the group mqm and/or user mqm do not exist, during the installation of the product, the installer
creates group mqm and user mqm with a home directory of /var/mqm.
2. Create file systems for both the product code and working data to be stored. See “Creating file systems
on Linux” on page 100.
3. Configure any additional settings needed for your Linux system.
See “Configuring and tuning the operating system on Linux” on page 102.

What to do next
When you have completed the tasks to prepare the system, you are ready to start installing IBM MQ. To
install a server using rpm , see “Installing the first IBM MQ installation on Linux using the rpm command”
on page 113. To install a client using rpm, see “Installing an IBM MQ client on Linux using rpm” on page
120.
To install a server using a Debian installer, see “Installing an IBM MQ server on Linux Ubuntu using Debian
packages” on page 131. To install a client using a Debian installer, see “Installing an IBM MQ client on
Linux Ubuntu using Debian packages ” on page 137
Important: Having both Debian and rpm installed versions of IBM MQ on the same system is not
supported.
Related tasks
Planning
Maintaining and migrating
Applying maintenance to IBM MQ

Setting up the user and group on Linux

On Linux systems, IBM MQ requires a user ID of the name mqm, with a primary group of mqm. The mqm user
ID owns the directories and files that contain the resources associated with the product.

Using Active Directory

If you are using Active Directory to provide centralized user and group definitions to your Linux system, it
is not possible to have both an mqm user and mqm group definition in Active Directory because that service
does not permit users and groups to have the same name.
You should:
• Put an mqm group definition in the Active Directory before installing IBM MQ, so that other users in the
directory can later be made part of the shared group definition.
• Create the mqm user locally, or allow it to be created during the installation process.

Installing and uninstalling IBM MQ 99

 Creating the user ID and group
Set the primary group of the mqm user to the group mqm.
If you are installing IBM MQ on multiple systems you might want to ensure each UID and GID of mqm
has the same value on all systems. If you are planning to configure multi-instance queue managers, it is
essential the UID and GID are the same from system to system. It is also important to have the same UID
and GID values in virtualization scenarios.
RPM creates the mqm user ID and group mqm, with a home directory of /var/mqm, as part of the
installation procedure if they do not exist.
If you have special requirements for these IDs ( for example they need to have the same values as other
machines you are using, or your users and group ID are centrally managed) you should create the IDs
before running the installation procedure, using the groupadd and useradd commands to set the UID
and GID the same on each machine.
Note: The only IBM MQ requirement, is that the mqm user should have the mqm group as its primary group.

Adding existing user IDs to the group on Linux systems

If you want to run administration commands, for example crtmqm (create queue manager) or strmqm
(start queue manager), your user ID must be a member of the mqm group. This user ID must not be longer
than 12 characters.
Users do not need mqm group authority to run applications that use the queue manager; it is needed only
for the administration commands.

Log files created by MQ Telemetry service

The umask setting of the user ID that creates a queue manager will determine the permissions of the
Telemetry log files generated for that queue manager. Even though the ownership of the log files will be
set to mqm.
Related concepts
“Creating file systems on AIX” on page 39
Before installing IBM MQ, you might need to create file systems for both the product code and working
data to be stored. There are minimum storage requirements for these file systems. The default installation
directory for the product code can be changed at installation time, but the working data location cannot
be changed.
“Configuring and tuning the operating system on Linux” on page 102
Use this topic when you are configuring IBM MQ on Linux systems.
Related tasks
“Configuring and tuning the operating system on AIX” on page 41
When installing IBM MQ on AIX systems, there are some additional settings that must be configured.

Creating file systems on Linux

Before installing IBM MQ, you might need to create file systems for both the product code and working
data to be stored. There are minimum storage requirements for these file systems. The default installation
directory for the product code can be changed at installation time, but the working data location cannot
be changed.

Determining the size of a server installations file system

To determine the size of the /var/mqm file system for a server installation, consider:
• The maximum number of messages in the system at one time.
• Contingency for message buildups, if there is a system problem.
• The average size of the message data, plus 500 bytes for the message header.

100 Installing IBM MQ

• The number of queues.
• The size of log files and error messages.
• The amount of trace that is written to the /var/mqm/trace directory.
Storage requirements for IBM MQ also depend on which components you install, and how much working
space you need. For more details, see Disk space requirements.

Creating a file system for the working data

Before you install IBM MQ, create and mount a file system called /var/mqm which is owned by the user
mqm in the group mqm ; see “Setting up the user and group on Linux” on page 99. This file system is used
by all installations of IBM MQ on a system. If possible, use a partition strategy with a separate volume
for the IBM MQ data. This means that other system activity is not affected if a large amount of IBM
MQ work builds up. Configure the directory permissions to permit the mqm user to have full control, for
example, file mode 755. These permissions will then be updated during the IBM MQ installation to match
the permissions required by the queue manager.

Creating separate file systems for errors and logs

You can also create separate file systems for your log data ( /var/mqm/log ) and error files ( /var/mqm/
errors ). If possible, place these directories on different physical disks from the queue manager data
( /var/mqm/qmgrs ) and from each other.
If you create separate file systems the /var/mqm/errors directory can be NFS mounted. However, if
you choose to NFS-mount /var/mqm/errors, the error logs might be lost if the network fails.
You can protect the stability of your queue manager by having separate file systems for:
• /var/mqm/errors
• /var/mqm/trace
• /var/mqm/qmgrs
• /var/mqm/log
In the case of /var/mqm/errors, it is rare that this directory receives large quantities of data. But it
is sometimes seen, particularly if there is a severe system problem leading to IBM MQ writing a lot of
diagnostic information in to .FDC files. In the case of /var/mqm/trace, files are only written here when
you use strmqtrc to start tracing IBM MQ.
You can obtain better performance of normal IBM MQ operations (for example, syncpoints, MQPUT,
MQGET of persistent messages) by placing the following on separate disks:
• /var/mqm/qmgrs
• /var/mqm/log
In the rare event that you need to trace an IBM MQ system for problem determination, you can reduce
performance impact by placing the /var/mqm/trace file system on a separate disk.
If you are creating separate file systems, allow a minimum of 30 MB of storage for /var/mqm, 100 MB
of storage for /var/mqm/log, and 10 MB of storage for /var/mqm/errors. The 100 MB minimum
allowance of storage for /var/mqm/log is the absolute minimum required for a single queue manager
and is not a recommended value. The size of a file system must be scaled according to the number of
queue managers that you intend to use, the number of pages per log file, and the number of log files per
queue manager.
For more information about file systems, see File system support.
The size of the log file depends on the log settings that you use. The minimum sizes are for circular logging
using the default settings. For more information about log sizes, see Calculating the size of the log.
Linux
For a client installation, the file system can be mounted on a remote network device, for example NFS.

Installing and uninstalling IBM MQ 101

 If you are performing both a client and a server installation, the requirements of the server installation
take precedence over the requirements of the client installation.
Allow 15 MB as a minimum for an IBM MQ client.
A new sample IBM MQ MQI client configuration file is created in the var/mqm directory, by the client
package, during installation, but only if this file does not exist. This file contains the ClientExitPath
stanza. An example mqclient.ini file is shown in Configuring a client using a configuration file.
If you are using a common configuration file for multiple clients, either in the IBM MQ installation
directory or in another location using the MQCLNTCF environment variable, you must grant read
access to all user identifiers under which the IBM MQ client applications run. If, for any reason, the file
cannot be read the failure is traced, and the search logic continues as if the file had not existed.
Related concepts
“Setting up the user and group on Linux” on page 99
On Linux systems, IBM MQ requires a user ID of the name mqm, with a primary group of mqm. The mqm user
ID owns the directories and files that contain the resources associated with the product.
“Configuring and tuning the operating system on Linux” on page 102
Use this topic when you are configuring IBM MQ on Linux systems.

Configuring and tuning the operating system on Linux

Use this topic when you are configuring IBM MQ on Linux systems.
Note: The information in this topic principally concerns global kernel tuning parameters, and applies to all
Linux systems. The exception to this statement are the sections described in “Configuring the users who
start IBM MQ” on page 105, which are specific to the user.

Shell interpreter
Ensure that /bin/sh shell is a valid shell interpreter compatible with the Bourne shell, otherwise the
post-installation configuration of IBM MQ does not complete successfully. If the shell was not installed
using RPM, you might see a prerequisites failure of /bin/sh shell when you try to install IBM MQ . The
failure is because the RPM tables do not recognize that a valid shell interpreter is installed. If the failure
occurs, you can reinstall the /bin/sh shell by using RPM, or specify the RPM option --nodeps to disable
dependency checking during installation of IBM MQ .
Note: The --dbpath option is not supported when installing IBM MQ on Linux.

Swap space
During high load IBM MQ can use virtual memory (swap space). If virtual memory becomes full it could
cause IBM MQ processes to fail or become unstable, affecting the system.
To prevent this situation your IBM MQ administrator should ensure that the system has been allocated
enough virtual memory as specified in the operating system guidelines.

System V IPC kernel configuration

IBM MQ uses System V IPC resources, in particular shared memory. However, a limited number of
semaphores are also used.
The minimum configuration for IBM MQ for these resources is as follows:

Table 12. Minimum tunable kernel parameters values

Increa
Name Kernel-name Value se Description
shmmni kernel.shmmni 4096 Yes Maximum number of shared memory
segments

102 Installing IBM MQ

Table 12. Minimum tunable kernel parameters values (continued)
Increa
Name Kernel-name Value se Description
shmmax kernel.shmmax 268435456 No Maximum size of a shared-memory
segment (bytes)
shmall kernel.shmall 2097152 Yes Maximum amount of shared memory
(pages)
semmsl kernel.sem 32 No Maximum amount of semaphores
permitted per set
semmns kernel.sem 4096 Yes Maximum number of semaphores
semopm kernel.sem 32 No Maximum number of operations in single
operations
semmni kernel.sem 128 Yes Maximum number of semaphore sets
thrmax kernel.threads-max 32768 Yes Maximum number of threads
pidmax kernel.pid_max 32768 Yes Maximum number of process identifiers

Notes:
1. These values are sufficient to run two moderate sized queue managers on the system. If you intend to
run more than two queue managers, or the queue managers are to process a significant workload, you
might need to increase the values displayed as Yes in the Increase column.
2. The kernel.sem values are contained within a single kernel parameter containing the four values in
order.
To view the current value of the parameter log on, as a user with root authority, and type:

sysctl Kernel-name

To add or alter these values, log on as a user with root authority. Open the file /etc/sysctl.conf with a
text editor, then add or change the following entries to your chosen values:

kernel.shmmni = 4096
kernel.shmall = 2097152
kernel.shmmax = 268435456
kernel.sem = 32 4096 32 128

Then save and close the file.

To load these sysctl values immediately, enter the following command sysctl -p.
If you do not issue the sysctl -p command, the new values are loaded when the system is rebooted.
By default the Linux kernel has a maximum process identifier, that can also be used with threads, and
might limit the allowed number of threads.
The operating system reports when the system lacks the necessary resources to create another thread, or
the system-imposed limit on the total number of threads in a process {PTHREAD_THREADS_MAX} would
be exceeded.
For more information on kernel.threads-max and kernel.pid-max, see Resource shortage in IBM
MQ queue manager when running a large number of clients

Installing and uninstalling IBM MQ 103

 Setting RemoveIPC on IBM MQ
Attention: Leaving the setting of RemoveIPC on its default value of Yes in the login manager
configuration files (logind.con and logind.conf.d) might cause IBM MQ owned IPC resources
being removed outside the control of IBM MQ.
You should set the value to No. For more information on RemoveIPC see the login.conf man page.

TCP/IP configuration
If you want to use keepalive for IBM MQ channels, you can configure the operation of the KEEPALIVE
using the kernel parameters:

net.ipv4.tcp_keepalive_intvl
net.ipv4.tcp_keepalive_probes
net.ipv4.tcp_keepalive_time

See Using the TCP/IP SO_KEEPALIVE option for further information.

To view the current value of the parameter log on, as a user with root authority, and type sysctl
Kernel-name.
To add or alter these values, log on as a user with root authority. Open the file /etc/sysctl.conf with a
text editor, then add or change the following entries to your chosen values.
To load these sysctl values immediately, enter the following command sysctl -p.
If you do not issue the sysctl -p command, the new values are loaded when the system is rebooted.

RDQM - configuring resource limits and environment variables

For replicated data queue managers (RDQMs), configure the nproc and nofile values for the mqm user
in /etc/security/limits.conf. Alternatively set LimitNOFILE and LimitNPROC variables in the
Pacemaker systemd service unit file for RDQM, named rdqm.conf. If the resource limits (nproc and/or
nofile) are configured in both limits.conf and rdqm.conf, the higher value of the limits configured
is used by the RDQM queue manager. You can use rdqm.conf to configure other resource limits (for
example, stack size) and environment variables. Note that the rdqm.conf file is only read when the
queue manager is started automatically by Pacemaker. This might be at system startup, or when the
queue manager fails over to the node where the rdqm.conf file exists. If the queue manager is started
manually with the strmqm command, it will inherit the environment where strmqm is run.
The following steps create a sample configuration in rdqm.conf:
1. Log in as root on the RDQM node.
2. Create the directory /etc/systemd/system/pacemaker.service.d.
3. Create the file rdqm.conf in that directory. The rdqm.conf file contains the required environment
variables and resource limits in the following format:

[Service]
Environment="MQ_ENV_VAR=1"
LimitNOFILE=65536
LimitNPROC=32768
LimitSTACK=16777216

For more details on configuring the systemd unit file, consult your operating system documentation.
4. Restart the pacemaker service:

systemctl daemon-reload
systemctl restart pacemaker.service

Any RDQM queue managers running on this node move to another node while pacemaker is restarted.
5. Repeat the procedure on the other two RDQM nodes so that the same configuration is used by the
RDQM queue manager when it fails over or switches over to other nodes.

104 Installing IBM MQ

Note: You should use qm.ini attributes in preference to environment variables to control queue manager
behavior because the qm.ini file is replicated between RDQM nodes.

RDQM - configuring the kernel console log level

The DRBD kernel module (kmod-drbd) can sometimes write many messages at the KERN_ERR (3) log
level. To prevent these messages being copied to the system console, which can cause significant
processing delays affecting the entire system, reduce the first number of the kernel.printk parameter
to 3. For more information about kernel message priorities, see https://www.kernel.org/doc/html/latest/
core-api/printk-basics.html.
To view the current value of the parameter, log on as a user with root authority and type sysctl
kernel.printk.
To add or alter this value, log on as a user with root authority. Open the file /etc/sysctl.conf with a
text editor, then add or change the following entry to your chosen value:

kernel.printk = 3 4 1 7

To load these sysctl values immediately, enter the command sysctl -p. If you do not issue the
sysctl -p command, the new values are loaded when the system is rebooted.

32-bit support on 64-bit Linux platforms

Some 64-bit Linux distributions no longer support 32-bit applications by default. For details of affected
platforms, and guidance on enabling 32-bit applications to run on these platforms, see “Hardware and
software requirements on Linux systems” on page 95.

Configuring the users who start IBM MQ

You must make the configuration changes described in Maximum open files and Maximum processes for
all users who start IBM MQ. This usually includes the mqm user ID, but the same changes must be made
for any other user IDs who start queue managers.
For queue managers started with systemd, specify equivalent NOFILE and NPROC values in the unit file
that contains the queue manager service configuration.

Maximum open files

The maximum number of open file-handles in the system is controlled by the parameter fs.file-max
The minimum value for this parameter for a system with two moderate sized queue managers is 524288.
Note: If the operating system default is higher, you should leave the higher setting, or consult your
operating system provider.
You are likely to need a higher value if you intend to run more than two queue managers, or the queue
managers are to process a significant workload.
To view the current value of a parameter, log on as a user with root authority, and type sysctl
fs.file-max.
To add or alter these values, log on as a user with root authority. Open the file /etc/sysctl.conf with a
text editor, then add or change the following entry to your chosen value:

fs.file-max = 524288

Then save and close the file.

To load these sysctl values immediately, enter the following command sysctl -p.

Installing and uninstalling IBM MQ 105

 If you do not issue the sysctl -p command, the new values are loaded when the system is rebooted.
If you are using a pluggable security module such as PAM (Pluggable Authentication Module), ensure that
this module does not unduly restrict the number of open files for the mqm user. To report the maximum
number of open file descriptors per process for the mqm user, login as the mqm user and enter the following
values:

ulimit -n

For a standard IBM MQ queue manager, set the nofile value for the mqm user to 10240 or more. To set
the maximum number of open file descriptors for processes running under the mqm user, add the following
information to the /etc/security/limits.conf file:

mqm hard nofile 10240

mqm soft nofile 10240

The pluggable security module limits are not applied to queue managers started with systemd. To start
an IBM MQ queue manager with systemd set LimitNOFILE to 10240 or more in the unit file that
contains the queue manager service configuration.
For instructions on how to configure nofile for RDQM queue managers, see RDQM - configuring resource
limits and environment variables.

Maximum processes
A running IBM MQ queue manager consists of a number of thread programs. Each connected application
increases the number of threads running in the queue manager processes. It is normal for an operating
system to limit the maximum number of processes that a user runs. The limit prevents operating system
failures due to an individual user or subsystem creating too many processes. You must ensure that the
maximum number of processes that the mqm user is allowed to run is sufficient. The number of processes
must include the number of channels and applications that connect to the queue manager.
The following calculation is useful when determining the number of processes for the mqm user:

nproc = 2048 + clientConnections * 4 + qmgrChannels * 4 +

localBindingConnections

where:
• clientConnections is the maximum number of connections from clients on other machines connecting to
queue managers on this machine.
• qmgrChannels is the maximum number of running channels (as opposed to channel definitions) to other
queue managers. This includes cluster channels, sender/receiver channels, and so on.
• localBindingConnections does not include application threads.
The following assumptions are made in this algorithm:
• 2048 is a large enough contingency to cover the queue manager threads. This might need to be
increased if a lot of other applications are running.
• When setting nproc, take into account the maximum number of applications, connections, channels and
queue managers that might be run on the machine in the future.
• This algorithm takes a pessimistic view and the actual nproc needed might be slightly lower for later
versions of IBM MQ and fastpath channels.
• On Linux, each thread is implemented as a light-weight process (LWP) and each LWP is counted as one
process against nproc.

106 Installing IBM MQ

You can use the PAM_limits security module to control the number of processes that users run. You can
configure the maximum number of processes for the mqm user as follows:

mqm hard nproc 4096

mqm soft nproc 4096

For more details on how to configure the PAM_limits security module type, enter the following
command:

man limits.conf

The pluggable security module limits are not applied to queue managers started with systemd. To start
an IBM MQ queue manager with systemd set LimitNPROC to a suitable value in the unit file that
contains the queue manager service configuration.
For instructions on how to configure nproc for RDQM queue managers, see RDQM - configuring resource
limits and environment variables.
You can check your system configuration using the mqconfig command.
For more information on configuring your system, see How to configure AIX and Linux systems for IBM
MQ.
Related concepts
“Setting up the user and group on Linux” on page 99
On Linux systems, IBM MQ requires a user ID of the name mqm, with a primary group of mqm. The mqm user
ID owns the directories and files that contain the resources associated with the product.
“Creating file systems on Linux” on page 100
Before installing IBM MQ, you might need to create file systems for both the product code and working
data to be stored. There are minimum storage requirements for these file systems. The default installation
directory for the product code can be changed at installation time, but the working data location cannot
be changed.
Related reference
mqconfig

License acceptance on IBM MQ for Linux

Previously, you had to accept the license before installing the product on Linux platforms. From IBM MQ
9.2.0 you can choose to accept the license before or after product installation.

Why you would accept the license after installation

Accepting the IBM MQ license before you install the product causes the following issues for Linux users:
• It stops you adding the IBM MQ RPM to a yum repository.
• It does not fit well with working in the cloud, where the RPM is installed as part of building the image.
• It does not fit well with unzippable packages, where no code is run before installation.
Accepting the license after installation lets you set up your own repository to install from.
Notes:
• You still have to accept the license before you use the product.
• You must have the correct license, or licenses, for the components you want to install. See license
requirements.
• If you have installed a trial license, follow the instructions for converting a trial license. See “Converting
a trial license on Linux” on page 140.

Installing and uninstalling IBM MQ 107

 Accepting the license before installing the product
For all IBM MQ versions, you can accept the license before installing the product on Linux platforms.
Follow the instructions for installing the server by preparing your system, and then following the
appropriate instructions for your operating system:
rpm
See “Installing the first IBM MQ installation on Linux using the rpm command” on page 113.
yum
See “Installing IBM MQ on Linux Red Hat using yum” on page 123.
Ubuntu using Debian
See “Installing IBM MQ on Linux Ubuntu using Debian” on page 126.

Accepting the license after installing the product

From IBM MQ 9.2.0, you can install the license or licenses after installing the product on Linux platforms.
To install the license or licenses after installing the product, use the mqlicense command or the
MQLICENSE environment variable. To view the license or licenses, use the dspmqlic command or the
MQLICENSE environment variable.
Attention: Do not use the mqlicense.sh script from the installation media, because this script
can only be used to accept the license before installation.
Related reference
MQLICENSE
dspmqlic (display IBM MQ license)
mqlicense (accept license post installation)

Installing IBM MQ on Linux using rpm

Installation tasks that are associated with installing IBM MQ on Linux systems using rpm are grouped in
this section.

About this task

To install IBM MQ using rpm, complete the following tasks.
For information about how to uninstall IBM MQ, see “Uninstalling or modifying IBM MQ on Linux using
rpm” on page 155.
If product fixes or updates are made available, see Applying maintenance to IBM MQ .

Procedure
1. Check the system requirements.
See “Checking requirements on Linux” on page 94.
2. Plan your installation.
• As part of the planning process, you must choose which components to install and where to install
them. See “IBM MQ rpm components for Linux systems” on page 109.
• You must also make some platform-specific choices. See “Planning to install IBM MQ on Linux” on
page 98.
3. Prepare your system for installation of IBM MQ.
See “Preparing the system on Linux” on page 99.
4. Install IBM MQ server.
See “Installing the first IBM MQ installation on Linux using the rpm command” on page 113, and
“Installing additional IBM MQ installations on Linux using the rpm command” on page 117.

108 Installing IBM MQ

5. Optional: Install an IBM MQ client.
See “Installing an IBM MQ client on Linux using rpm” on page 120.
6. Verify your installation. See “Verifying an IBM MQ installation on Linux” on page 142.

IBM MQ rpm components for Linux systems

You can select the components that you require when you install IBM MQ.
Important:
1. See IBM MQ license information for details of what each purchase of IBM MQ entitles you to install.
2. From IBM MQ 9.2.0 you require the RPM package MQSeriesGSKit file be installed for server and
client installation.
To display these components you can use, for example, the following command:

rpm -qa | grep MQ | xargs rpm -q --info

Table 13 on page 109 shows the components that are available when installing an IBM MQ server or
client on a Linux system:

Table 13. IBM MQ components for Linux systems

Component Description Serve Client RPM package name
r media
media
Runtime Contains files that are common to both MQSeriesRuntime
server and client installations.
Note: MQSeriesRuntime component
must be installed.

Server You can use the server to run queue MQSeriesServer

managers on your system and connect
to other systems over a network.
Provides messaging and queuing
services to applications, and support
for IBM MQ client connections.
Standard The IBM MQ MQI client is a MQSeriesClient
Client small subset of IBM MQ, without a
queue manager, that uses the queue
manager and queues on other (server)
systems. It can be used only when the
system it is on is connected to another
system that is running a full server
version of IBM MQ. The client and the
server can be on the same system if
required.
SDK The SDK is required for compiling MQSeriesSDK
applications. It includes sample
source files, and the bindings
(files .H, .LIB, .DLL, and others), that
you need to develop applications to
run on IBM MQ.

Installing and uninstalling IBM MQ 109

 Table 13. IBM MQ components for Linux systems (continued)
Component Description Serve Client RPM package name
r media
media
Sample The sample application programs are MQSeriesSamples
programs needed if you want to check your IBM
MQ installation using the verification
procedures.
Java The files needed for messaging using MQSeriesJava
messaging Java (includes Java Message Service).
Man pages AIX man pages, in U.S. English, for: MQSeriesMan
control commands
MQI calls
MQSC commands

Java JRE A Java Runtime Environment that is MQSeriesJRE

used by those parts of IBM MQ that
are written in Java.
Message For available languages, see the table
Catalogs of message catalogs that follows.
IBM Global IBM Global Security Kit V8 Certificate MQSeriesGSKit
Security Kit and TLS, Base Runtime.
Telemetry MQ Telemetry supports the MQSeriesXRService
Service connection of Internet Of Things
(IOT) devices (that is, remote sensors,
actuators and telemetry devices) that
use the IBM MQ Telemetry Transport
(MQTT) protocol. The telemetry
(MQXR) service enables a queue
manager to act as an MQTT server, and
communicate with MQTT client apps.
Note: The telemetry service is only
available on Linux for x86-64 (64 bit)
and Linux for IBM Z.
A set of MQTT clients is available
from the Eclipse Paho downloads
page. These sample clients help you
write your own MQTT client apps that
IOT devices use to communicate with
MQTT servers.
See also “Installation considerations
for MQ Telemetry” on page 259.

IBM MQ Use IBM MQ Explorer to administer MQSeriesExplorer

Explorer and monitor resources on Linux
x86-64 systems. Also available using a
stand-alone installer from Fix Central.
Note: IBM MQ Explorer is available
only on Linux for x86-64 (64 bit).

110 Installing IBM MQ

Table 13. IBM MQ components for Linux systems (continued)
Component Description Serve Client RPM package name
r media
media
Managed File MQ Managed File Transfer transfers MQSeriesFTAgent
Transfer files between systems in a managed MQSeriesFTBase
and auditable way, regardless of file MQSeriesFTLogger
size or the operating systems used. MQSeriesFTService
For information about the function of MQSeriesFTTools
each component, see “Managed File
Transfer product options” on page
254.
Advanced Provides a high level of protection for MQSeriesAMS
Message sensitive data flowing through the IBM
Security MQ network, while not impacting the
end applications. You must install this
component on all IBM MQ installations
that host queues you want to protect.
You must install the IBM Global
Security Kit component on any IBM
MQ installation that is used by a
program that puts or gets messages to
or from a protected queue, unless you
are using only Java client connections.
You must install the Java JRE
component to install this component.

AMQP Service Install this component to make AMQP MQSeriesAMQP

channels available. AMQP channels
support AMQP 1.0 APIs. You can
use AMQP channels to give AMQP
applications access to the enterprise-
level messaging facilities provided by
IBM MQ.
REST API and Adds HTTP based administration for MQSeriesWeb
Console IBM MQ through the REST API and
IBM MQ Console.
IBM MQ Install this component to configure MQSeriesSFBridge“1” on page
Bridge to the connections to Salesforce and IBM 112
Salesforce MQ, then run the runmqsfb command
(Deprecated) to subscribe to events from Salesforce
and publish them to an IBM MQ
network.
Note: The IBM MQ Bridge to
Salesforce is available only on Linux
for x86-64 (64 bit).

Installing and uninstalling IBM MQ 111

 Table 13. IBM MQ components for Linux systems (continued)
Component Description Serve Client RPM package name
r media
media
IBM MQ Install this component to configure MQSeriesBCBridge“2” on page
Bridge to the connections to your blockchain 112
blockchain network and IBM MQ. You can then
(Deprecated) run the runmqbcb command to start
the bridge and send queries and
updates to, and receive responses
from your blockchain network. The
queue manager that the bridge
connects to must be an IBM MQ
Advanced queue manager. For more
information, see What is IBM MQ
Advanced?.
Note:
The IBM MQ Bridge to blockchain is
available only on Linux for x86-64 (64
bit).
This component is not supported for
use with Docker.

RDQM Install this component to make the MQSeriesRDQM

(replicated replicated data queue manager high
data queue availability configuration available. See
manager) “Installing RDQM (replicated data
queue managers)” on page 265 for
more information.
Note:
This component is available only on
Linux for x86-64 (64 bit), on RHEL 7.3
or later.
This component is not supported for
use with Docker.

Notes:
1. The rpm components required for the IBM MQ Bridge to Salesforce are:

MQSeriesRuntime = 9.2.2-0 is needed by MQSeriesSFBridge-9.2.2-0.x86_64

MQSeriesJava = 9.2.2-0 is needed by MQSeriesSFBridge-9.2.2-0.x86_64
MQSeriesJRE = 9.2.2-0 is needed by MQSeriesSFBridge-9.2.2-0.x86_64

2. The rpm components required for the IBM MQ Bridge to blockchain are:

MQSeriesRuntime = 9.2.2-0 is needed by MQSeriesBCBridge-9.2.2-0.x86_64

MQSeriesJava = 9.2.2-0 is needed by MQSeriesBCBridge-9.2.2-0.x86_64
MQSeriesJRE = 9.2.2-0 is needed by MQSeriesBCBridge-9.2.2-0.x86_64

112 Installing IBM MQ

Table 14. IBM MQ message catalogs for Linux systems
Message catalog language RPM package name
Brazilian Portuguese MQSeriesMsg_pt
Czech MQSeriesMsg_cs
French MQSeriesMsg_fr
German MQSeriesMsg_de
Hungarian MQSeriesMsg_hu
Italian MQSeriesMsg_it
Japanese MQSeriesMsg_ja
Korean MQSeriesMsg_ko
Polish MQSeriesMsg_pl
Russian MQSeriesMsg_ru
Spanish MQSeriesMsg_es
Simplified Chinese MQSeriesMsg_Zh_CN
Traditional Chinese MQSeriesMsg_Zh_TW
U.S. English not applicable

Related concepts
“IBM MQ components and features” on page 6
You can select the components or features that you require when you install IBM MQ.
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.

Installing the first IBM MQ installation on Linux using the rpm

command
You can install an IBM MQ server on a 64-bit Linux system using rpm. The instructions in this topic are for
the first installation of IBM MQ on a Linux system.

Before you begin

• The instructions in this topic are for the first installation of IBM MQ on a Linux system. For instructions
on how to install additional IBM MQ installations, see “Installing additional IBM MQ installations on
Linux using the rpm command” on page 117.
• Before you start the installation procedure, ensure that you have completed the necessary steps
outlined in “Preparing the system on Linux” on page 99.

About this task

Install the server by using the RPM Package Manager installer to select the components you want to
install. The components and package names are listed in “IBM MQ rpm components for Linux systems”
on page 109.
Attention: Unless you install all your required packages in the same operation, you must install the
packages in the following order:

Installing and uninstalling IBM MQ 113

 MQSeriesRuntime
MQSeriesJRE
MQSeriesJava
MQSeriesGSKit
MQSeriesServer
MQSeriesWeb
MQSeriesFTBase
MQSeriesFTAgent
MQSeriesFTService
MQSeriesFTLogger
MQSeriesFTTools
MQSeriesAMQP
MQSeriesAMS
MQSeriesXRService
MQSeriesExplorer
MQSeriesClient
MQSeriesMan
MQSeriesMsg
MQSeriesSamples
MQSeriesSDK
MQSeriesSFBridge (Deprecated)
MQSeriesBCBridge (Deprecated)

Procedure
1. Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux.
2. Optional: If your installation media is an Electronic Software Download, obtained from Passport
Advantage, you must decompress the tar.gz file and extract the installation files from the tar file:
a) For example, if you download part number CC7K6ML, you decompress the file by using the
following command:

gunzip CC7K6ML.tar.gz

b) Similarly, extract the installation files from the tar file by using the following command:

tar -xvf CC7K6ML.tar

Important: You must use GNU tar (also known as gtar) to unpack any tar images.
3. Set your current directory to the location of the installation packages.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.
4. From IBM MQ 9.2.0, you have the option of accepting the license before or after installing the product.
To accept the license before installing, run the mqlicense.sh script. The license agreement is
displayed in a language appropriate to your environment and you are prompted to accept or decline
the terms of the license:
• To display the license agreement in the default manner, which uses an X-window where possible,
use the following command:

./mqlicense.sh

• To display the license agreement as text in the current shell, which can be read by a screen reader,
use the following command:

114 Installing IBM MQ

 ./mqlicense.sh -text_only

See License acceptance for more information about license acceptance.

5.
Optional: Obtain the IBM MQ public signing gpg key and install it into rpm.

rpm --import ibm_mq_public.pgp

The IBM-provided RPMs are signed with a digital signature, and your system will not recognize
that signature without further steps. This only needs to be done once for each system. For more
information, see “IBM MQ code signatures” on page 12.
The validity of any of the IBM MQ RPMs can then be verified, for example:

# rpm -Kv MQSeriesRuntime-9.2.4-0.x86_64.rpm

MQSeriesRuntime-9.2.4-0.x86_64.rpm:
Header V3 RSA/SHA256 Signature, key ID 0209b828: OK
Header SHA1 digest: OK
V3 RSA/SHA256 Signature, key ID 0209b828: OK
MD5 digest: OK

Note: If you skip this step, then a harmless warning might be issued during RPM installation to indicate
there is a signature but the system does not recognize the signing key, for example:
warning: MQSeriesRuntime-9.2.4-0.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID 0209b828:
NOKEY
6. Install IBM MQ.
To support the running of a queue manager, you must install at least the MQSeriesRuntime and the
MQSeriesServer components.
Important: The components that you need to install might not all be in the same folder on the
installation media. Some components might be under the /Advanced folder. For more information
about installing IBM MQ Advanced components, see “Installing IBM MQ Advanced for Multiplatforms”
on page 245.
• For IBM MQ 9.2.1 and later, install IBM MQ in the default location /opt/mqm by using the rpm
-Uvh command:
For example, to install all components that are available in your current location on the installation
media to the default location, use the following command:

rpm -Uvh MQSeries*.rpm

To install the runtime and server components to the default location, use the following command:

rpm -Uvh MQSeriesRuntime-*.rpm MQSeriesServer-*.rpm

• Install IBM MQ in a non-default location by using the --prefix option. All of the IBM MQ
components that you require must be installed in the same location:
The installation path specified must be either an empty directory, the root of an unused file system,
or a path that does not exist. The length of the path is limited to 256 bytes and must not contain
spaces.
For example, enter the following installation path to install the runtime and server components to
the /opt/customLocation directory on a 64-bit Linux system:

rpm --prefix /opt/customLocation -Uvh MQSeriesRuntime-*.rpm MQSeriesServer-*.rpm

• Install IBM MQ in the default location /opt/mqm by using the rpm -ivh command:
For example, to install all components that are available in your current location on the installation
media to the default location, use the following command:

Installing and uninstalling IBM MQ 115

 rpm -ivh MQSeries*.rpm

To install the runtime and server components to the default location, use the following command:

rpm -ivh MQSeriesRuntime-*.rpm MQSeriesServer-*.rpm

• Install IBM MQ in a non-default location by using the --prefix option. All of the IBM MQ
components that you require must be installed in the same location:
The installation path specified must be either an empty directory, the root of an unused file system,
or a path that does not exist. The length of the path is limited to 256 bytes and must not contain
spaces.
For example, enter the following installation path to install the runtime and server components to
the /opt/customLocation directory on a 64-bit Linux system:

rpm --prefix /opt/customLocation -ivh MQSeriesRuntime-*.rpm

MQSeriesServer-*.rpm

Results
You installed IBM MQ on your Linux system.

What to do next
• If required, you can now set this installation to be the primary installation. Enter the following command
at the command prompt:

MQ_INSTALLATION_PATH/bin/setmqinst -i -p MQ_INSTALLATION_PATH

where MQ_INSTALLATION_PATH represents the directory where IBM MQ is installed.

You can have only one primary installation on a system. If there is already a primary installation on the
system, you must unset it before you can set another installation as the primary installation. For more
information, see Changing the primary installation.
• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ . For
more information, see setmqenv and crtmqenv.
• If you want to confirm that the installation was successful, you can verify your installation. See
“Verifying an IBM MQ installation on Linux” on page 142, for more information.
• Only a user with a UID that is a member of the mqm group can issue administration commands. If you
want to enable users to issue administration commands, they must be added to the mqm group. For
more information, see “Setting up the user and group on Linux” on page 99 and Authority to administer
IBM MQ on AIX, Linux, and Windows systems.
Related concepts
“Multiple installations on AIX, Linux, and Windows” on page 17
On AIX, Linux, and Windows, it is possible to have more than one copy of IBM MQ on a system.
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
Related tasks
“Uninstalling or modifying IBM MQ on Linux using rpm” on page 155
On Linux, you can uninstall the IBM MQ server or client using the rpm command. You can also modify an
installation by removing selected packages (components) currently installed on your system.
Changing the primary installation

116 Installing IBM MQ

Related reference
setmqinst

Installing additional IBM MQ installations on Linux using the rpm

command
You can install additional IBM MQ servers on a 64-bit Linux system by using the crtmqpkg command
during the installation process.

Before you begin

CAUTION: The instructions in this topic do not apply to Linux Ubuntu or Linux on POWER® Systems
- Little Endian. For information about these platforms, see “Installing IBM MQ on Linux Ubuntu
using Debian” on page 126.
• The instructions in this topic are for additional installations of IBM MQ on a Linux system. For
instructions on how to install the first IBM MQ installation, see “Installing the first IBM MQ installation
on Linux using the rpm command” on page 113.
• Before you start the installation procedure, ensure that you have completed the necessary steps
outlined in “Preparing the system on Linux” on page 99.
• To run the crtmqpkg command used in this task, you must have the pax command or rpmbuild
installed. pax and rpmbuild are not supplied as part of the product. You must obtain these from your
Linux distribution supplier.

About this task

Install the server by using the RPM Package Manager installer to select the components you want to
install. The components and package names are listed in “IBM MQ rpm components for Linux systems”
on page 109.
Attention: Unless you install all your required packages in the same operation, you must install the
packages in the following order:

MQSeriesRuntime
MQSeriesJRE
MQSeriesJava
MQSeriesGSKit
MQSeriesServer
MQSeriesWeb
MQSeriesFTBase
MQSeriesFTAgent
MQSeriesFTService
MQSeriesFTLogger
MQSeriesFTTools
MQSeriesAMQP
MQSeriesAMS
MQSeriesXRService
MQSeriesExplorer
MQSeriesClient
MQSeriesMan
MQSeriesMsg
MQSeriesSamples
MQSeriesSDK
MQSeriesSFBridge (Deprecated)
MQSeriesBCBridge (Deprecated )

Installing and uninstalling IBM MQ 117

 Procedure
1. Optional: Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux.
2. Optional: If your installation media is an Electronic Software Download, obtained from Passport
Advantage, you must decompress the tar.gz file and extract the installation files from the tar file:
a) For example, if you download part number CC7K6ML, you decompress the file by using the
following command:

gunzip CC7K6ML.tar.gz

b) Similarly, extract the installation files from the tar file by using the following command:

tar -xvf CC7K6ML.tar

Important: You must use GNU tar (also known as gtar) to unpack any tar images.
3. Set your current directory to the location of the installation files. The location might be the mount point
of the server DVD, a network location, or a local file system directory.
4. Run the crtmqpkg command to create a unique set of packages to install on the system. To run the
crtmqpkg command to run on Linux, you must install the pax command and rpmbuild, which is
located in the rpm-build package.
The crtmqpkg command is required only if this is not the first installation of IBM MQ on the system. If
you have earlier versions of IBM MQ installed on your system, then installing the latest version works
correctly if you install it in a different location.
To run the crtmqpkg command on a Linux system:
a) Enter the following command:

./crtmqpkg suffix

where suffix is a name of your choosing that uniquely identifies the installation packages on the
system. suffix is not the same as an installation name, although the names can be identical. suffix is
limited to 16 characters in the ranges A-Z, a-z, and 0-9.
Note: This command creates a full copy of the installation packages in a temporary directory. By
default, the temporary directory is located at /var/tmp. You must ensure that the system has
enough free space before you run this command. To use a different location, you can set the
TMPDIR environment variable before you run the crtmqpkg command. For example:

$ TMPDIR=/test ./crtmqpkg suffix

b) Set your current directory to the location specified when the crtmqpkg command operation
completes successfully.
This directory is a subdirectory of the /var/tmp/mq_rpms directory, in which the unique set
of packages is created. The packages have the suffix value contained within the file name. For
example, using a suffix of "1":

./crtmqpkg 1

means there is a subdirectory named /var/tmp/mq_rpms/1/x86_64.

The packages are renamed according to the subdirectory, for example:

From: MQSeriesRuntime-8.0.0-0.x86_64.rpm
To: MQSeriesRuntime-1-8.0.0-0.x86_64.rpm

5. From IBM MQ 9.2.0, you have the option of accepting the license before or after installing the product.
To accept the license before installing, run the mqlicense.sh script. The license agreement is

118 Installing IBM MQ

 displayed in a language appropriate to your environment and you are prompted to accept or decline
the terms of the license:
• To display the license agreement in the default manner, which uses an X-window where possible,
use the following command:

./mqlicense.sh

• To display the license agreement as text in the current shell, which can be read by a screen reader,
use the following command:

./mqlicense.sh -text_only

See License acceptance for more information about license acceptance.

6. Install IBM MQ.
To support the running of a queue manager, you must install at least the MQSeriesRuntime and the
MQSeriesServer components.
Important: The components that you need to install might not all be in the same folder on the
installation media. Some components might be under the /Advanced folder. For more information
about installing IBM MQ Advanced components, see “Installing IBM MQ Advanced for Multiplatforms”
on page 245.
• For IBM MQ 9.2.1 and later, install IBM MQ in the default location /opt/mqm:
For example, to install all components that are available in your current location on the installation
media to the default location, use the following command:

rpm -Uvh MQSeries*.rpm

To install the runtime and server components to the default location, use the following command:

rpm -Uvh MQSeriesRuntime-*.rpm MQSeriesServer-*.rpm

• Install IBM MQ in a non-default location by using the --prefix option. For each installation, all of
the IBM MQ components that you require must be installed in the same location.
The installation path specified must be either an empty directory, the root of an unused file system,
or a path that does not exist. The length of the path is limited to 256 bytes and must not contain
spaces.
For example, enter the following installation path to install the runtime and server components to
the /opt/customLocation directory on a 64-bit Linux system:

rpm --prefix /opt/customLocation -Uvh MQSeriesRuntime-*.rpm

MQSeriesServer-*.rpm

• Install IBM MQ in the default location /opt/mqm:

For example, to install all components that are available in your current location on the installation
media to the default location, use the following command:

rpm -ivh MQSeries*.rpm

To install the runtime and server components to the default location, use the following command:

rpm -ivh MQSeriesRuntime-*.rpm MQSeriesServer-*.rpm

• Install IBM MQ in a non-default location by using the --prefix option. For each installation, all of
the IBM MQ components that you require must be installed in the same location.
The installation path specified must be either an empty directory, the root of an unused file system,
or a path that does not exist. The length of the path is limited to 256 bytes and must not contain
spaces.

Installing and uninstalling IBM MQ 119

 For example, enter the following installation path to install the runtime and server components to
the /opt/customLocation directory on a 64-bit Linux system:

rpm --prefix /opt/customLocation -ivh MQSeriesRuntime-*.rpm

MQSeriesServer-*.rpm

Results
You installed IBM MQ on your Linux system.

What to do next
• If required, you can now set this installation to be the primary installation. Enter the following command
at the command prompt:

MQ_INSTALLATION_PATH/bin/setmqinst -i -p MQ_INSTALLATION_PATH

where MQ_INSTALLATION_PATH represents the directory where IBM MQ is installed.

You can have only one primary installation on a system. If there is already a primary installation on the
system, you must unset it before you can set another installation as the primary installation. For more
information, see Changing the primary installation.
• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ . For
more information, see setmqenv and crtmqenv.
• If you want to confirm that the installation was successful, you can verify your installation. See
“Verifying an IBM MQ installation on Linux” on page 142, for more information.
• Only a user with a UID that is a member of the mqm group can issue administration commands. If you
want to enable users to issue administration commands, they must be added to the mqm group. For
more information, see “Setting up the user and group on Linux” on page 99 and Authority to administer
IBM MQ on AIX, Linux, and Windows systems.
Related concepts
“Multiple installations on AIX, Linux, and Windows” on page 17
On AIX, Linux, and Windows, it is possible to have more than one copy of IBM MQ on a system.
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
Related tasks
“Uninstalling or modifying IBM MQ on Linux using rpm” on page 155
On Linux, you can uninstall the IBM MQ server or client using the rpm command. You can also modify an
installation by removing selected packages (components) currently installed on your system.
Changing the primary installation
Related reference
setmqinst

Installing an IBM MQ client on Linux using rpm

Installing an IBM MQ client on a 64 bit Linux system.

Before you begin

• Before you start the installation procedure, make sure that you have completed the necessary steps
outlined in “Preparing the system on Linux” on page 99.
• If this installation is not the only installation on the system, you must ensure that you have write access
to /var/tmp.

120 Installing IBM MQ

About this task
This task describes the installation of the client, using the RPM Package Manager installer to select
which components you want to install. You must install at least the Runtime and Client components. The
components are listed in “IBM MQ rpm components for Linux systems” on page 109.

Procedure
1. Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux.
2. Set your current directory to the location of the installation packages.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.

3.
From IBM MQ 9.2.0, you have the option of accepting the license before or after installing the product.
To accept the license before installing, run the mqlicense.sh script:

./mqlicense.sh

The license agreement is displayed in a language appropriate to your environment and you are
prompted to accept or decline the terms of the license.
If possible, mqlicense.sh opens an X-window to display the license.
If you need the license to be presented as text in the current shell, which can be read by a screen
reader, type the following command:

./mqlicense.sh -text_only

See “License acceptance on IBM MQ for Linux” on page 107 for more information about license
acceptance.
4. If you have multiple installations on this system, you must run crtmqpkg to create a unique set of
packages to install on the system:
a) Enter the following command:

./crtmqpkg suffix

where suffix is a name of your choosing, that will uniquely identify the installation packages on the
system. suffix is not the same as an installation name, although the names can be identical. suffix is
limited to 16 characters in the ranges A-Z, a-z, and 0-9.
b) Set your current directory to the location specified when the crtmqpkg command completes.
This directory is a sub-directory of /var/tmp/mq_rpms, in which the unique set of packages is
created. The packages have the suffix value contained within the filename.

5.
Optional: Obtain the IBM MQ public signing gpg key and install it into rpm.

rpm --import ibm_mq_public.pgp

The IBM-provided RPMs are signed with a digital signature, and your system will not recognize
that signature without further steps. This only needs to be done once for each system. For more
information, see “IBM MQ code signatures” on page 12.
The validity of any of the IBM MQ RPMs can then be verified, for example:

# rpm -Kv MQSeriesRuntime-9.2.4-0.x86_64.rpm

MQSeriesRuntime-9.2.4-0.x86_64.rpm:

Installing and uninstalling IBM MQ 121

 Header V3 RSA/SHA256 Signature, key ID 0209b828: OK
Header SHA1 digest: OK
V3 RSA/SHA256 Signature, key ID 0209b828: OK
MD5 digest: OK

Note: If you skip this step, then a harmless warning might be issued during RPM installation to indicate
there is a signature but the system does not recognize the signing key, for example:
warning: MQSeriesRuntime-9.2.4-0.x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID 0209b828:
NOKEY
6. Install IBM MQ.
The minimum components you must install are the MQSeriesRuntime and the MQSeriesClient.
• To install to the default location, /opt/mqm, use the rpm -ivh command to install each component
that you require.
For example, to install all components to the default location use the following command:

rpm -ivh MQSeries*.rpm

If you are using Ubuntu, add the --force-debian attribute. For example, to install all components
to the default location use the following command:

rpm --force-debian -ivh MQSeries*.rpm

You must include this option to prevent seeing warning messages from the version of RPM for your
platform, which indicates that the RPM packages are not intended to be directly installed using RPM.
• To install to a non-default location use the rpm --prefix option. For each installation, all of the
IBM MQ components that you require must be installed in the same location.
The installation path specified must either be an empty directory, the root of an unused file system,
or a path that does not exist. The length of the path is limited to 256 bytes and must not contain
spaces.
For example, to install the runtime and server components to /opt/customLocation on a 64-bit
Linux system:

rpm --prefix /opt/customLocation -ivh MQSeriesRuntime-V.R.M-F.x86_64.rpm MQSeriesClient-V.R.M-

F.x86_64.rpm

where:
V
Represents the version of the product that you are installing
R
Represents the release of the product that you are installing
M
Represents the modification of the product that you are installing
F
Represents the fix pack level of the product that you are installing

What to do next
• If you have chosen this installation to be the primary installation on the system, you must now set it as
the primary installation. Enter the following command at the command prompt:

MQ_INSTALLATION_PATH/bin/setmqinst -i -p MQ_INSTALLATION_PATH

122 Installing IBM MQ

 You can have only one primary installation on a system. If there is already a primary installation on the
system, you must unset it before you can set another installation as the primary installation. For more
information, see Changing the primary installation.
• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ. For
more information, see setmqenv and crtmqenv.
• For instructions on how to verify your installation, see “Testing communication between a client and a
server on Linux” on page 153
Related tasks
“Uninstalling or modifying IBM MQ on Linux using rpm” on page 155
On Linux, you can uninstall the IBM MQ server or client using the rpm command. You can also modify an
installation by removing selected packages (components) currently installed on your system.

Installing IBM MQ on Linux Red Hat using yum

From IBM MQ 9.2.0 you can install IBM MQ on Linux Red Hat by using the yum installer.

About this task

• Before you start the installation procedure, ensure that you have completed the necessary steps
outlined in “Preparing the system on Linux” on page 99.
• To install IBM MQ in a non default location, you must run the crtmqpkg command. This command
requires that the system has the following commands installed:
– pax or rpmbuild
– createrepo
– yum-utils
These commands are not supplied as part of the product. You must obtain these from your Linux
distribution supplier.

Procedure
1. Optional: Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux.
2. Optional: If your installation media is an Electronic Software Download, obtained from Passport
Advantage, you must decompress the tar.gz file and extract the installation files from the tar file:
a) For example, if you download part number CC7K6ML, you decompress the file by using the
following command:

gunzip CC7K6ML.tar.gz

b) Similarly, extract the installation files from the tar file by using the following command:

tar -xvf CC7K6ML.tar

Important: You must use GNU tar (also known as gtar) to unpack any tar images.
3. Optional: If this is not the first installation on the system, or if you want to install IBM MQ to a non
default location, run the crtmqpkg to create a unique set of packages to install on the system:

./crtmqpkg suffix installationPath

where:

Installing and uninstalling IBM MQ 123

 • suffix specifies a name of your choosing that uniquely identifies the installation packages on the
system. suffix is not the same as an installation name, although the names can be identical. suffix is
limited to 16 characters in the ranges A-Z, a-z, and 0-9.
• installationPath specifies the path where you want to install IBM MQ.
Note: This command creates a full copy of the installation packages in a temporary directory. By
default, the temporary directory is located at /var/tmp. You must ensure that the system has
enough free space before you run this command. To use a different location, you can set the TMPDIR
environment variable before you run the crtmqpkg command. For example:

$ TMPDIR=/test ./crtmqpkg suffix installationPath

4. Set your current directory to the location of the installation packages. If you used the crtmqpkg
command, this directory is the location that is specified when the crtmqpkg command operation
completes successfully.
5. Configure the yum repository:
A sample repository file is available in the MQServer directory of the installation packages. You can
use this sample to assist you in configuring the yum repository.
a) Create or update the repository:
• If this is the first IBM MQ installation on the system, create a file with the suffix .repo, for
example, IBM_MQ.repo, in the /etc/yum.repos.d directory.
• If this is an additional IBM MQ installation on the system, append the details of the additional
installation to the appropriate .repo file in the /etc/yum.repos.d directory.
b) Add the following contents to the repository file:

[IBM-MQ-v.r.m-architecture]
name=IBM MQ v.r.m architecture
baseurl=file://installationFilesLocation
enabled=1
gpgcheck=0

c) Replace the installationFilesLocation variable with the location of the installation files.
d) Replace the v.r.m variable with the version, release, and modification number for the version of IBM
MQ that you want to install.
e) Replace the architecture variable with the architecture of the system you are installing on. This
value is one of the following values:
• x86_64
• ppc64le
• s390x

f)
Optional: Enable gpg key verification.
Replace gpgcheck=0 with gpgcheck=1 and add an additional gpgkey=<uri> line pointing to the
certificate provided, for example:

gpgcheck=1
gpgkey=file:///directory/to/ibm_mq_public.pgp

g) Optional: If you appended contents to the repository file, clear the repository cache by using the
following command:

yum clean all

h) Check that the IBM MQ repository is available by using the following command:

yum repolist

124 Installing IBM MQ

6. From IBM MQ 9.2.0, you have the option of accepting the license before or after installing the product.
To accept the license before installing, run the mqlicense.sh script. The license agreement is
displayed in a language appropriate to your environment and you are prompted to accept or decline
the terms of the license:
• To display the license agreement in the default manner, which uses an X-window where possible,
use the following command:

./mqlicense.sh

• To display the license agreement as text in the current shell, which can be read by a screen reader,
use the following command:

./mqlicense.sh -text_only

See License acceptance for more information about license acceptance.

7. Install IBM MQ:
• To install all available components in the default location, use the following command:

yum -y install MQSeries*

• To install all available components in a non default location, use the following command:

yum -y install MQSeries*suffix*

where suffix specifies the suffix that was chosen when you ran crtmqpkg in step “3” on page 123.
• To install a subset of components, specify the components that you want to install. Any
dependencies are automatically installed. To support the running of a queue manager, you must
install at least the MQSeriesRuntime and the MQSeriesServer components. For example, to install
the server component in the default location, use the following command:

yum -y install MQSeriesServer*

• To install an older version of IBM MQ when multiple versions are available in the repository file, use
the following command:

yum -y install MQSeries*-v.r.m-f

where v.r.m-f specifies the version, release, modification, and fix pack level to install.

Results
You installed IBM MQ on your Linux system.

What to do next
• If required, you can now set this installation to be the primary installation. Enter the following command
at the command prompt:

MQ_INSTALLATION_PATH/bin/setmqinst -i -p MQ_INSTALLATION_PATH

where MQ_INSTALLATION_PATH represents the directory where IBM MQ is installed.

You can have only one primary installation on a system. If there is already a primary installation on the
system, you must unset it before you can set another installation as the primary installation. For more
information, see Changing the primary installation.
• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ . For
more information, see setmqenv and crtmqenv.
• If you want to confirm that the installation was successful, you can verify your installation. See
“Verifying an IBM MQ installation on Linux” on page 142, for more information.

Installing and uninstalling IBM MQ 125

 • Only a user with a UID that is a member of the mqm group can issue administration commands. If you
want to enable users to issue administration commands, they must be added to the mqm group. For
more information, see “Setting up the user and group on Linux” on page 99 and Authority to administer
IBM MQ on AIX, Linux, and Windows systems.
Related concepts
“Multiple installations on AIX, Linux, and Windows” on page 17
On AIX, Linux, and Windows, it is possible to have more than one copy of IBM MQ on a system.
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
Related tasks
“Uninstalling or modifying IBM MQ on Linux Red Hat using yum” on page 157
On Linux Red Hat, you can uninstall the IBM MQ server or client using the yum command. You can also
modify an installation by removing selected packages (components) currently installed on your system.
Changing the primary installation
Related reference
setmqinst

Installing IBM MQ on Linux Ubuntu using Debian

Installation tasks that are associated with installing IBM MQ on Linux systems using a Debian installer are
grouped in this section.

About this task

To install IBM MQ using a Debian installer, complete the following tasks.
If product fixes or updates are made available, see Applying maintenance to IBM MQ .

Procedure
1. Check the system requirements.
See “Checking requirements on Linux” on page 94.
2. Plan your installation.
As part of the planning process, you must choose which components to install and where to install
them. See “IBM MQ Debian components for Linux Ubuntu systems” on page 127.
3. Prepare your system for installation of IBM MQ.
See “Preparing the system on Linux” on page 99.
4. Install IBM MQ server.
See “Installing an IBM MQ server on Linux Ubuntu using Debian packages” on page 131.
5. Optional: Install an IBM MQ client.
See “Installing an IBM MQ client on Linux Ubuntu using Debian packages ” on page 137.
6. Verify your installation. See “Verifying an IBM MQ installation on Linux” on page 142.

126 Installing IBM MQ

 Overview of the Debian installer for IBM MQ on Linux Ubuntu
An overview of the concepts and considerations for installing IBM MQ, on Linux Ubuntu, using the Debian
installer.

Installation tools
Use apt, dpkg, or a higher level installation tool, to install and uninstall the product. The installed product
on disk appears identical to an rpm-installed copy.
Attention: The Debian installation tools have no provision for overriding the installation directory.
This means that there is no relocatable or multi-version support. Therefore the product will be
installed to /opt/mqm, but this can be set as the primary installation if you require.

Package names
The package names have been changed to use an IBM MQ derived name.
For example, the Debian equivalent of the existing rpm server component, MQSeriesServer, is ibmmq-
server.
On a single system, you can have a single version of IBM MQ installed by Debian, or you can achieve
multi-version installation with Debian through the use of container based technologies, such as Docker.

IBM MQ Debian components for Linux Ubuntu systems

You can select the components that you require when you install IBM MQ.
Important: See IBM MQ license information for details of what each purchase of IBM MQ entitles you to
install.
Table 15 on page 127 shows the components that are available when installing an IBM MQ server or
client on a Linux Ubuntu system using the Debian installer:

Table 15. IBM MQ Debian components for Linux Ubuntu systems

Component Description Serve Client Debian package name
r media
media
Runtime Contains files that are common to both ibmmq-runtime
server and client installations.
Note: ibmmq-runtime component
must be installed.

Server You can use the server to run queue ibmmq-server

managers on your system and connect
to other systems over a network.
Provides messaging and queuing
services to applications, and support
for IBM MQ client connections.

Installing and uninstalling IBM MQ 127

 Table 15. IBM MQ Debian components for Linux Ubuntu systems (continued)
Component Description Serve Client Debian package name
r media
media
Standard The IBM MQ MQI client is a ibmmq-client
Client small subset of IBM MQ, without a
queue manager, that uses the queue
manager and queues on other (server)
systems. It can be used only when the
system it is on is connected to another
system that is running a full server
version of IBM MQ. The client and the
server can be on the same system if
required.
SDK The SDK is required for compiling ibmmq-sdk
applications. It includes sample
source files, and the bindings
(files .H, .LIB, .DLL, and others), that
you need to develop applications to
run on IBM MQ.
Sample The sample application programs are ibmmq-samples
programs needed if you want to check your IBM
MQ installation using the verification
procedures.
Java The files needed for messaging using ibmmq-java
messaging Java (includes Java Message Service).
Man pages AIX man pages, in U.S. English, for: ibmmq-man
control commands
MQI calls
MQSC commands

Java JRE A Java Runtime Environment that is ibmmq-jre

used by those parts of IBM MQ that
are written in Java.
Message For available languages, see the table
Catalogs of message catalogs that follows.
IBM Global IBM Global Security Kit V8 Certificate ibmmq-gskit
Security Kit and TLS, Base Runtime.

128 Installing IBM MQ

Table 15. IBM MQ Debian components for Linux Ubuntu systems (continued)
Component Description Serve Client Debian package name
r media
media
Telemetry MQ Telemetry supports the ibmmq-xrservice
Service connection of Internet Of Things
(IOT) devices (that is, remote sensors,
actuators and telemetry devices) that
use the IBM MQ Telemetry Transport
(MQTT) protocol. The telemetry
service, which is also know as the
MQXR service, enables a queue
manager to act as an MQTT server, and
communicate with MQTT client apps.
Note: The telemetry service is only
available on Linux for x86-64 (64 bit)
and Linux for IBM Z.
The Eclipse Paho project, and
MQTT.org, have free downloads of the
latest telemetry clients and samples
for a range of programming languages.
Use these resources to help you
write the MQTT client apps that IOT
devices use to communicate with
MQTT servers.
See also “Installation considerations
for MQ Telemetry” on page 259.

IBM MQ Use IBM MQ Explorer to administer ibmmq-explorer

Explorer and monitor resources on Linux
x86-64 systems. Also available using a
stand-alone installer from Fix Central.
Note: IBM MQ Explorer is available
only on Linux for x86-64 (64 bit).

Managed File MQ Managed File Transfer transfers ibmmq-ftagent

Transfer files between systems in a managed ibmmq-ftbase
and auditable way, regardless of file ibmmq-ftlogger
size or the operating systems used. ibmmq-ftservice
For information about the function of ibmmq-fttools
each component, see “Managed File
Transfer product options” on page
254.

Installing and uninstalling IBM MQ 129

 Table 15. IBM MQ Debian components for Linux Ubuntu systems (continued)
Component Description Serve Client Debian package name
r media
media
Advanced Provides a high level of protection for ibmmq-ams
Message sensitive data flowing through the IBM
Security MQ network, while not impacting the
end applications. You must install this
component on all IBM MQ installations
that host queues you want to protect.
You must install the IBM Global
Security Kit component on any IBM
MQ installation that is used by a
program that puts or gets messages to
or from a protected queue, unless you
are using only Java client connections.
You must install the Java JRE
component to install this component.

AMQP Service Install this component to make AMQP ibmmq-amqp

channels available. AMQP channels
support AMQP 1.0 APIs. You can
use AMQP channels to give AMQP
applications access to the enterprise-
level messaging facilities provided by
IBM MQ.
REST API and Adds HTTP based administration for ibmmq-web
Console IBM MQ through the REST API and
IBM MQ Console.
IBM MQ Install the IBM MQ Bridge ibmmq-sfbridge
Bridge to to Salesforce to configure the
Salesforce connections to Salesforce and IBM
(Deprecated) MQ, then run the command runmqsfb
to subscribe to events from Salesforce
and publish them to an IBM MQ
network.
Note: The IBM MQ Bridge to
Salesforce is available only on Linux
for x86-64 (64 bit).

IBM MQ Install the IBM MQ Bridge to ibmmq-bcbridge

Bridge to blockchain to send queries and
blockchain updates to, and receive responses
(Deprecated) from your blockchain network.
Note: The IBM MQ Bridge to
blockchain is available only on Linux
for x86-64 (64 bit).

Table 16. IBM MQ message catalogs for Linux systems

Message catalog language Component name
Brazilian Portuguese ibmmq-msg-pt

130 Installing IBM MQ

Table 16. IBM MQ message catalogs for Linux systems (continued)
Message catalog language Component name
Czech ibmmq-msg-cs
French ibmmq-msg-fr
German ibmmq-msg-de
Hungarian ibmmq-msg-hu
Italian ibmmq-msg-it
Japanese ibmmq-msg-ja
Korean ibmmq-msg-ko
Polish ibmmq-msg-pl
Russian ibmmq-msg-ru
Spanish ibmmq-msg-es
Simplified Chinese ibmmq-msg-zh-cn
Traditional Chinese ibmmq-msg-zh-tw
U.S. English not applicable

Related concepts
“IBM MQ components and features” on page 6
You can select the components or features that you require when you install IBM MQ.

Installing an IBM MQ server on Linux Ubuntu using Debian

packages
You can install an IBM MQ server on a Linux Ubuntu system, using a Debian installer, in accordance with
the system requirements web page.

Before you begin

See System Requirements for IBM MQ for details of the supported software levels.
Before you start the installation procedure, make sure that you first complete the necessary steps that are
outlined in “Preparing the system on Linux” on page 99.
If you have installed IBM MQ 9.0.2, or earlier, on Ubuntu using rpm, you must uninstall all rpm versions of
the product before installing the Debian version of the product.

From IBM MQ 9.2.0 you have the option to accept the license before or after product
installation. See “License acceptance on IBM MQ for Linux” on page 107 for more information.
Note: For Long Term Support before IBM MQ 9.2.0 and Continuous Delivery releases before IBM MQ
9.1.5, you must accept the terms of the license agreement before you can proceed with the installation.
To do this, run the mqlicense.sh script

About this task

Install the server by using a Debian installer to select the components that you want to install. The
components and package names are listed in “IBM MQ Debian components for Linux Ubuntu systems” on
page 127.
Attention: Ensure that you download the Ubuntu version of the tar.gz package, before you
install the product, as this version contains the deb files you need for the apt-get tool.

Installing and uninstalling IBM MQ 131

 You can use various installers. This topic describes the use of the apt-get and dpkg installers.
apt-get
You can use apt-get to install packages, and you do not need to install any dependent packages.
apt-get installs dependency packages for the package that you require.
You must make your files accessible to apt-get, in order to use it.
To do this, issue the command, chmod -R a+rx DIRNAME, where DIRNAME is the directory into
which you unpacked the tar.gz package.
Attention: If you do not make your files accessible to apt-get, you receive the following
errors:
• N: Download is performed unsandboxed as root as file '/sw/9101deb/./InRelease' couldn't
be accessed by user '_apt'. - pkgAcquire::Run (13: Permission denied)
• E: Failed to fetch file:/sw/9101deb/./Packages File not found - /sw/9101deb/./Packages (2:
No such file or directory)
• E: Some index files failed to download. They have been ignored, or old ones used instead.
where /sw/9101deb is the directory from which you are installing IBM MQ.
dpkg
You can use dpkg to install individual packages, but you must ensure you install any dependencies as
dpkg does not install any dependent packages for the package you require. Refer to the Table 17 on
page 132 table for information about the dependencies of each package.
To support the running of a queue manager, you must install at least the ibmmq-runtime and the
ibmmq-server components.

Table 17. Package component dependencies

Package
Package Name Component Function Dependencies
ibmmq-runtime Common function for all other components None
Queue Manager ibmmq-runtime
ibmmq-server ibmmq-gskit

C IBM MQ client libraries ibmmq-runtime

ibmmq-client ibmmq-gskit

ibmmq-java Java and JMS IBM MQ APIs ibmmq-runtime

ibmmq-jre Java Runtime Environment ibmmq-runtime
ibmmq-sdk Header files and libraries for non-Java APIs ibmmq-runtime
ibmmq-man UNIX man pages for IBM MQ ibmmq-runtime
ibmmq-samples IBM MQ application samples ibmmq-runtime

132 Installing IBM MQ

Table 17. Package component dependencies (continued)
Package
Package Name Component Function Dependencies

ibmmq-msg-cs Additional language message catalog files. English ibmmq-runtime

message catalog files are installed by default. For
ibmmq-msg-de more information about these message catalogs,
ibmmq-msg-es see “Displaying messages in your national
language on Linux” on page 141
ibmmq-msg-fr
ibmmq-msg-hu
ibmmq-msg-it
ibmmq-msg-ja
ibmmq-msg-ko
ibmmq-msg-pl
ibmmq-msg-pt
ibmmq-msg-ru
ibmmq-msg-zh-cn
ibmmq-msg-zh-tw

ibmmq-mqexplorer IBM MQ Explorer. Only on Linux x86-64 systems. ibmmq-runtime

ibmmq-jre

ibmmq-gskit IBM Global Security Kit ibmmq-runtime

ibmmq-web REST API and IBM MQ Console. ibmmq-runtime

ibmmq-server
ibmmq-java
ibmmq-jre

ibmmq-ftbase Managed File Transfer component ibmmq-runtime

ibmmq-java
ibmmq-jre

ibmmq-ftlogger Managed File Transfer component ibmmq-runtime

ibmmq-server
ibmmq-ftbase
ibmmq-java
ibmmq-jre

ibmmq-fttools Managed File Transfer components ibmmq-runtime

ibmmq-ftagent ibmmq-ftbase
ibmmq-java
ibmmq-jre

Installing and uninstalling IBM MQ 133

 Table 17. Package component dependencies (continued)
Package
Package Name Component Function Dependencies
ibmmq-ftservice Managed File Transfer component ibmmq-runtime
ibmmq-server
ibmmq-ftagent
ibmmq-ftbase
ibmmq-java
ibmmq-jre

ibmmq-amqp Advanced Message Queuing Protocol component ibmmq-runtime

ibmmq-xrservice Telemetry Service component ibmmq-runtime

Note: The telemetry service is only available on
Linux for x86-64 (64 bit) and Linux for IBM Z.

ibmmq-ams Advanced Message Security component ibmmq-runtime

ibmmq-server

ibmmq-sfbridge (Deprecated) Install the IBM MQ Bridge to Salesforce to ibmmq-runtime

configure the connections to Salesforce and
IBM MQ, then run the command runmqsfb to ibmmq-java
subscribe to events from Salesforce and publish ibmmq-jre
them to an IBM MQ network.
Note:
The IBM MQ Bridge to Salesforce is available only
on Linux for x86-64 (64 bit).

ibmmq-bcbridge Install the IBM MQ Bridge to blockchain to send ibmmq-runtime

(Deprecated) queries and updates to, and receive responses
ibmmq-java
from your blockchain network.
ibmmq-jre
Note:
The IBM MQ Bridge to blockchain is available only
on Linux for x86-64 (64 bit).

Procedure
1. Open a shell terminal. Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux.
2. Set your current directory to the location of the installation packages.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.

3.
From IBM MQ 9.2.0, you have the option of accepting the license before or after installing the product.
To accept the license before installing, run the mqlicense.sh script:

134 Installing IBM MQ

 ./mqlicense.sh

The license agreement is displayed in a language appropriate to your environment and you are
prompted to accept or decline the terms of the license.
If possible, mqlicense.sh opens an X-window to display the license.
If you need the license to be presented as text in the current shell, which can be read by a screen
reader, type the following command:

./mqlicense.sh -text_only

See “License acceptance on IBM MQ for Linux” on page 107 for more information about license
acceptance.
4. Choose how to install the IBM MQ packages:
Either use the apt management tool to install the IBM MQ packages that you want, or use the dpkg
command to install the IBM MQ packages that you want along with their dependency packages.
• To use the apt-get management tool to install the IBM MQ packages that you want along with
their dependency packages:
a. Create a file with the suffix .list, for example, IBM_MQ.list, in the /etc/apt/
sources.list.d directory.
This file should contain a deb entry for the location of the directory that contains the IBM MQ
packages.
For example:

# Local directory containing IBM MQ packages

deb [trusted=yes] file:/var/tmp/mq ./

The inclusion of the [trusted=yes] statement (including the brackets) is optional and
suppresses warnings and prompts during subsequent operations.
b. Run the command apt-get update to add this directory, and the list of packages the directory
contains, to the apt cache.
Refer to the Attention note in “apt-get” on page 132 for possible errors you might receive.
You can now use apt to install IBM MQ. For example, you can install the complete product by
issuing the following command:

apt-get install "ibmmq-*"

You can install the server package and all its dependencies by issuing the following command:

apt-get install ibmmq-server

Attention: Do not run the apt-get install ibmmq-* command in the directory
which holds the .deb files, unless you are using quotation characters in the shell.
If you are using tools such as aptitude or synaptic, the install packages can be found in the
misc\non-free category.
• To use the dpkg command to install the IBM MQ packages that you want, issue the dpkg command
for each IBM MQ package that you want to install. For example, issue the following command to
install the run time package:

dpkg -i ibmmq-runtime_9.2.0.0_amd64.deb

Important: Although dpkg permits multiple package files in the same command, this will not
work as expected because of IBM MQ inter-package dependencies. You must install the packages
individually in the order shown below. You may find that using apt-get is a better option.

Installing and uninstalling IBM MQ 135

 – ibmmq-runtime
– ibmmq-jre
– ibmmq-java
– ibmmq-gskit
– ibmmq-server
– ibmmq-web
– ibmmq-ftbase
– ibmmq-ftagent
– ibmmq-ftservice
– ibmmq-ftlogger
– ibmmq-fttools
– ibmmq-amqp
– ibmmq-ams
– ibmmq-xrservice
– ibmmq-explorer
– ibmmq-client
– ibmmq-man
– ibmmq-msg_language
– ibmmq-samples
– ibmmq-sdk
– ibmmq-sfbridge (Deprecated)
– ibmmq-bcbridge (Deprecated)

Results
You have installed the packages you require.

What to do next
• If required, you can now set this installation to be the primary installation. Enter the following command
at the command prompt:

MQ_INSTALLATION_PATH/bin/setmqinst -i -p MQ_INSTALLATION_PATH

where MQ_INSTALLATION_PATH represents the directory where IBM MQ is installed.

• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ . For
more information, see setmqenv and crtmqenv.
• If you want to confirm that the installation was successful, you can verify your installation. See
“Verifying an IBM MQ installation on Linux” on page 142, for more information.
Related tasks
“Uninstalling or modifying IBM MQ on Linux Ubuntu using Debian packages” on page 159

136 Installing IBM MQ

You can uninstall an IBM MQ server or client that was installed using the Debian package manager. You
can also modify an installation by removing selected packages (components) currently installed on your
system.

Installing an IBM MQ client on Linux Ubuntu using Debian packages

You can install an IBM MQ client on a Linux Ubuntu system, using a Debian package, in accordance with
the system requirements web page.

Before you begin

See System Requirements for IBM MQ for details of the supported software levels.
Before you start the installation procedure, make sure that you have completed the necessary steps
outlined in “Preparing the system on Linux” on page 99.

About this task

Install the client by using a Debian installer to select the components that you want to install. The
components and package names are listed in “IBM MQ Debian components for Linux Ubuntu systems” on
page 127.

Procedure
1. Open a shell terminal. Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux.
2. Set your current directory to the location of the installation packages.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.

3.
From IBM MQ 9.2.0, you have the option of accepting the license before or after installing the product.
To accept the license before installing, run the mqlicense.sh script:

./mqlicense.sh

The license agreement is displayed in a language appropriate to your environment and you are
prompted to accept or decline the terms of the license.
If possible, mqlicense.sh opens an X-window to display the license.
If you need the license to be presented as text in the current shell, which can be read by a screen
reader, type the following command:

./mqlicense.sh -text_only

See “License acceptance on IBM MQ for Linux” on page 107 for more information about license
acceptance.
4. Install the IBM MQ client.
You can use any Debian installer. “Installing an IBM MQ server on Linux Ubuntu using Debian
packages” on page 131 describes the use of the apt-get and dpkg packages to install a server.
At a minimum, you must install the ibmmq-runtime component.
If you are installing a subset of components, you must ensure that any dependencies are first installed,
as listed in Table 18 on page 138.
To install and use the package listed in the Package Name column, you must also install the
components listed in the Package Dependencies column.

Installing and uninstalling IBM MQ 137

 Table 18. Package component dependencies
Package
Package Name Component Function Dependencies
ibmmq-runtime Common function for all other components None
ibmmq-client C IBM MQ client libraries ibmmq-runtime
ibmmq-java Java and JMS IBM MQ APIs ibmmq-runtime
ibmmq-jre Java Runtime Environment ibmmq-runtime
ibmmq-sdk Header files and libraries for non-Java APIs ibmmq-runtime
ibmmq-man UNIX man pages for IBM MQ ibmmq-runtime
ibmmq-samples IBM MQ application samples ibmmq-runtime

ibmmq-msg-cs Language specific message catalog files ibmmq-runtime

ibmmq-msg-de
ibmmq-msg-es
ibmmq-msg-fr
ibmmq-msg-hu
ibmmq-msg-it
ibmmq-msg-ja
ibmmq-msg-ko
ibmmq-msg-pl
ibmmq-msg-pt
ibmmq-msg-ru
ibmmq-msg-zh-cn
ibmmq-msg-zh-tw

ibmmq-gskit IBM Global Security Kit ibmmq-runtime

ibmmq-jre

ibmmq-sfbridge IBM MQ Bridge to Salesforce ibmmq-runtime

(Deprecated)
Note: ibmmq-java
The IBM MQ Bridge to Salesforce is available only ibmmq-jre
on Linux for x86-64 (64 bit).

ibmmq-bcbridge IBM MQ Bridge to blockchain ibmmq-runtime

(Deprecated)
Note: ibmmq-java
The IBM MQ Bridge to blockchain is available only ibmmq-jre
on Linux for x86-64 (64 bit).

Results
You have installed the packages you require.

138 Installing IBM MQ

What to do next
• If you have chosen this installation to be the primary installation on the system, you must now set it as
the primary installation. Enter the following command at the command prompt:

MQ_INSTALLATION_PATH/bin/setmqinst -i -p MQ_INSTALLATION_PATH

• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ. For
more information, see setmqenv and crtmqenv.
• For instructions on how to verify your installation, see “Testing communication between a client and a
server on Linux” on page 153
Related concepts
“Multiple installations on AIX, Linux, and Windows” on page 17
On AIX, Linux, and Windows, it is possible to have more than one copy of IBM MQ on a system.
“Primary installation on AIX, Linux, and Windows” on page 18
On systems that support multiple installations of IBM MQ ( AIX, Linux, and Windows ), the primary
installation is the one to which IBM MQ system-wide locations refer. Having a primary installation is
optional, but convenient.
Related tasks
“Uninstalling or modifying IBM MQ on Linux using rpm” on page 155
On Linux, you can uninstall the IBM MQ server or client using the rpm command. You can also modify an
installation by removing selected packages (components) currently installed on your system.
Changing the primary installation
Related reference
setmqinst

Redistributable clients on Linux

The Linux x86-64 image is shipped in a LinuxX64.tar.gz file.

File names
The archive or .zip file names describe the file contents and equivalent maintenance levels.
For IBM MQ 9.2.0 the client images are available under the following file names:
Long Term Support: 9.2.0 IBM MQ C redistributable client for Linux x86-64
9.2.0.0-IBM-MQC-Redist-LinuxX64.tar.gz
Long Term Support: 9.2.0 IBM MQ JMS and Java redistributable client
9.2.0.0-IBM-MQC-Redist-Java.zip

Choosing the runtime files to distribute with an application

A script file named genmqpkg is provided by the redistributable client under the bin directory.
You can use the genmqpkg script to generate a smaller subset of files that are tailored to the needs of the
application, for which the files are intended to be distributed.
You are asked a series of interactive Yes or No questions to determine the runtime requirements for an
IBM MQ application.
Finally, genmqpkg asks you to supply a new target directory, where the script duplicates the required
directories and files.
Important: A fully qualified path should be supplied to genmqpkg, as genmqpkg will not expand or
evaluate shell variables.

Installing and uninstalling IBM MQ 139

 Important: IBM support is only able to provide assistance with the full, unmodified set of files contained
within the redistributable client packages.

Other considerations
On Linux, the default data path of a non-installed client is:
Linux x86-64
$HOME/IBM/MQ/data
You can change the default directory of the data path, by using the MQ_OVERRIDE_DATA_PATH
environment variable.
Note: You must create the directory first, as the directory is not created automatically.
A redistributable client runtime co-exists with a full IBM MQ client or server installation, provided that
they are installed in different locations.
Important: Unpacking a redistributable image into the same location as a full IBM MQ installation is not
supported.
On Linux the ccsid.tbl used to define the supported CCSID conversions is traditionally expected to be
found in the UserData directory structure, along with error logs, trace files, and so on.
The UserData directory structure is populated by unpacking the redistributable client, and so, if the
file is not found in its usual location, the redistributable client falls back to locate the file in the /lib
subdirectory of the installation.

Classpath changes
The classpath used by dspmqver, setmqenv, and crtmqenv commands, add the
com.ibm.mq.allclient.jar to the environment, immediately following the com.ibm.mq.jar and
com.ibm.mqjms.jar.
An example of dspmqver output from the redistributable client on Linux:

Name: IBM MQ
Version: 9.2.0.0
Level: p920-920-L150909
BuildType: IKAP - (Production)
Platform: IBM MQ for Linux (x86-64 platform)
Mode: 64-bit
O/S: Linux 2.6.32.59-0.7-default
InstName: MQNI09200004
InstDesc: IBM MQ V9.2.0.0 (Redistributable)
Primary: No
InstPath: /Development/johndoe/unzip/unpack
DataPath: /u/johndoe/IBM/MQ/data
MaxCmdLevel: 920

Related concepts
“Redistributable IBM MQ clients” on page 27
The IBM MQ redistributable client is a collection of runtime files that are provided in a .zip or .tar file
that can be redistributed to third parties under redistributable license terms, which provides a simple way
of distributing applications and the runtime files that they require in a single package.

Converting a trial license on Linux

Convert a trial license to a full license without reinstalling IBM MQ.
When the trial license expires, the "count-down" displayed by the strmqm command informs you the
license has expired, and the command does not run.

Before you begin

1. IBM MQ is installed with a trial license.

140 Installing IBM MQ

2. You have access to the installation media of a fully licensed copy of IBM MQ.

About this task

Run the setmqprd command to convert a trial license to a full license.
If you do not want to apply a full license to your trial copy of IBM MQ, you can uninstall it at any time.

Procedure
1. Obtain the full license from the fully licensed installation media.
The full license file is amqpcert.lic. On Linux, it is in the /MediaRoot/licenses directory on the
installation media.
2. Run the setmqprd command from the installation that you are upgrading:

MQ_INSTALLATION_PATH/bin/setmqprd /MediaRoot/licenses/amqpcert.lic

Related reference
setmqprd

Displaying messages in your national language on Linux

To display messages from a different national language message catalog, you must install the appropriate
catalog and set the LANG environment variable.

About this task

Messages in U.S. English are automatically installed with IBM MQ
Message catalogs for all languages are installed in MQ_INSTALLATION_PATH/msg/language
identifier , where language identifier is one of the identifiers in Table 19 on page 141.
If you require messages in a different language, perform the following steps:

Procedure
1. Install the appropriate message catalog (see “IBM MQ components and features” on page 6 ).
2. To select messages in a different language, ensure the LANG environment variable is set to the
identifier for the language you want to install:

Table 19. Language identifiers

Identifier Language
cs_CZ Czech
de_DE German
es_ES Spanish
fr_FR French
hu_HU Hungarian
it_IT Italian
ja_JP Japanese
ko_KR Korean
pl_PL Polish
pt_BR Brazilian Portuguese

Installing and uninstalling IBM MQ 141

 Table 19. Language identifiers (continued)
Identifier Language
ru_RU Russian
zh_CN Simplified Chinese
zh_TW Traditional Chinese

Verifying an IBM MQ installation on Linux

The topics in this section provide instructions on how to verify a server or a client installation of IBM MQ
on Linux systems.

About this task

You can verify a local (stand-alone) server installation or a server-to-server installation of the IBM MQ
server:
• A local server installation has no communication links with other IBM MQ installations.
• A server-to-server installation does have links to other installations.
You can also verify that your IBM MQ MQI client installation completed successfully and that the
communication link is working.

Procedure
• To verify a local server installation, see “Verifying a local server installation using the command line on
Linux” on page 142.
• To verify a server-to-server installation, see “Verifying a server-to-server installation using the
command line on Linux” on page 144.
• To verify a client installation, see “Verifying a client installation on Linux” on page 147.

Verifying a local server installation using the command line on

Linux
On Linux systems, you can verify a local installation by using the command line to create a simple
configuration of one queue manager and one queue.

Before you begin

To verify the installation, you must first install the samples package.
Before beginning the verification procedure, you might want to check that you have the latest fixes for
your system. For more information about where to find the latest updates, see “Checking requirements on
Linux” on page 94.

About this task

Use the following steps to configure your default queue manager from the command line. After the queue
manager is configured, use the amqsput sample program to put a message on the queue. You then use
the amqsget sample program to get the message back from the queue.
IBM MQ object definitions are case-sensitive. Any text entered as an MQSC command in lowercase is
converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that you
type the examples exactly as shown.

142 Installing IBM MQ

Procedure
1. On a Linux system, log in as a user in the mqm group.
2. Set up your environment:
a) Set up environment variables for use with a particular installation by entering the following
command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

b) Check that the environment is set up correctly by entering the following command:

dspmqver

If the command completes successfully, and the expected version number and installation name
are returned, the environment is set up correctly.
3. Create a queue manager called QMA by entering the following command:

crtmqm QMA

Messages indicate when the queue manager is created, and when the default IBM MQ objects are
created.
4. Start the queue manager by entering the following command:

strmqm QMA

A message indicates when the queue manager starts.

5. Start MQSC by entering the following command:

runmqsc QMA

A message indicates when MQSC starts. MQSC has no command prompt.

6. Define a local queue called QUEUE1 by entering the following command:

DEFINE QLOCAL (QUEUE1)

A message indicates when the queue is created.

7. Stop MQSC by entering the following command:

end

Messages are shown, followed by the command prompt.

Note: Subsequent steps require that the samples package is installed.
8. Change into the MQ_INSTALLATION_PATH/samp/bin directory, which contains the sample
programs.
MQ_INSTALLATION_PATH represents the high-level directory in which IBM MQ is installed.
9. Put a message on the queue by entering the following commands

./amqsput QUEUE1 QMA

The following messages are shown:

Installing and uninstalling IBM MQ 143

 Sample AMQSPUT0 start
target queue is QUEUE1

10. Type some message text on one or more lines, where each line is a different message. Enter a blank
line to end the message input.
The following message is shown:

Sample AMQSPUT0 end

Your messages are now on the queue and the command prompt is shown.
11. Get the messages from the queue, by entering the following command:

./amqsget QUEUE1 QMA

The sample program starts, and your messages are displayed.

Results
You have successfully verified your local installation.

Verifying a server-to-server installation using the command line on

Linux
You can verify a server-to-server installation using two servers, one as a sender and one as a receiver.

Before you begin

• On Linux, IBM MQ supports TCP on all Linux platforms. On x86 platforms and Power platforms, SNA
is also supported. If you want to use the SNA LU6.2 support on these platforms, you need the IBM
Communications Server for Linux 6.2. The Communications Server is available as a PRPQ product from
IBM. For more details, see Communications Server.
If you are using TCP/IP, make sure that TCP/IP and IBM MQ are installed on both servers.
• The examples in this task use TCP/IP. If you do not use TCP, see Setting up communication on AIX and
Linux.
• Make sure that you are a member of the IBM MQ administrators group (mqm) on each server.
• Decide which installation is the sender server and which installation is the receiver server. The
installations might be on the same system, or on different systems.

About this task

IBM MQ object definitions are case-sensitive. Any text entered as an MQSC command in lowercase is
converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that you
type the examples exactly as shown.

Procedure
1. On the receiver server:
a) On Linux, log in as a user in the mqm group.
b) Check which ports are free, for example by running netstat. For more information about this
command, see the documentation of your operating system.
If port 1414 is not in use, make a note of 1414 to use as the port number in step 2 h. Use the same
number for the port for your listener later in the verification. If it is in use, note a port that is not in
use; for example 1415.

144 Installing IBM MQ

 c) Set up the environment for the installation you are using by entering the following command at the
command prompt:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

d) Create a queue manager called QMB by entering the following command at the command prompt:

crtmqm QMB

Messages tell you that the queue manager has been created, and that the default IBM MQ objects
have been created.
e) Start the queue manager by entering the following command:

strmqm QMB

A message tells you when the queue manager has started.

f) Start MQSC by entering the following command:

runmqsc QMB

A message tells you that MQSC has started. MQSC has no command prompt.
g) Define a local queue called RECEIVER.Q by entering the following command:

DEFINE QLOCAL (RECEIVER.Q)

A message tells you the queue has been created.

h) Define a listener by entering the following command:
DEFINE LISTENER (LISTENER1) TRPTYPE (TCP) CONTROL (QMGR) PORT ( PORT_NUMBER )

Where port_number is the name of the port the listener runs on. This number must be the same as
the number used when defining your sender channel.
i) Start the listener by entering the following command:

START LISTENER (LISTENER1)

Note: Do not start the listener in the background from any shell that automatically lowers the
priority of background processes.
j) Define a receiver channel by entering the following command:

DEFINE CHANNEL (QMA.QMB) CHLTYPE (RCVR) TRPTYPE (TCP)

A message tells you when the channel has been created.

k) End MQSC by typing:

end

Some messages are displayed, followed by the command prompt.

2. On the sender server:
a) As the sender server is an AIX system, log in as a user in the mqm group.
b) Set up the environment for the installation you are using by entering the following command at the
command prompt:

Installing and uninstalling IBM MQ 145

 . MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

c) Create a queue manager called QMA by entering the following command at the command prompt:

crtmqm QMA

Messages tell you that the queue manager has been created, and that the default IBM MQ objects
have been created.
d) Start the queue manager, by entering the following command:

strmqm QMA

A message tells you when the queue manager has started.

e) Start MQSC by entering the following command:

runmqsc QMA

A message tells you that an MQSC session has started. MQSC had no command prompt.
f) Define a local queue called QMB (to be used as a transmission queue) by entering the following
command:

DEFINE QLOCAL (QMB) USAGE (XMITQ)

A message tells you when the queue has been created.

g) Define a local definition of the remote queue with by entering the following command:

DEFINE QREMOTE (LOCAL.DEF.OF.REMOTE.QUEUE) RNAME (RECEIVER.Q) RQMNAME ('QMB') XMITQ (QMB)

h) Define a sender channel by entering one of the following commands:

con-name is the TCP/IP address of the receiver system. If both installations are on the same
system, the con-name is localhost. port is the port you noted in 1 b. If you do not specify a port,
the default value of 1414 is used.
DEFINE CHANNEL (QMA.QMB) CHLTYPE (SDR) CONNAME ('CON-NAME(PORT)') XMITQ (QMB) TRPTYPE (TCP)

i) Start the sender channel by entering the following command:

START CHANNEL(QMA.QMB)

The receiver channel on the receiver server starts automatically when the sender channel starts.
j) Stop MQSC by entering the following command:

end

Some messages are displayed, followed by the command prompt.

k) Change into the MQ_INSTALLATION_PATH/samp/bin directory. This directory contains the
sample programs. MQ_INSTALLATION_PATH represents the high-level directory in which IBM MQ is
installed.
l) If both the sender server and receiver server are installations on the same system, check that the
queue managers have been created on different installations by entering the following command:

146 Installing IBM MQ

 dspmq -o installation

If the queue managers are on the same installation, move either QMA to the sender installation
or QMB to the receiver installation by using the setmqm command. For more information, see
setmqm.
m) Put a message on the local definition of the remote queue, which in turn specifies the name of the
remote queue. Enter the following command:

./amqsput LOCAL.DEF.OF.REMOTE.QUEUE QMA

A message tells you that amqsput has started.

n) Type some message text on one or more lines, followed by a blank line.
A message tells you that amqsput has ended. Your message is now on the queue and the
command prompt is displayed again.
3. On the receiver server:
a) As your receiver server is an AIX system, change into the MQ_INSTALLATION_PATH/samp/bin
directory.
This directory contains the sample programs. MQ_INSTALLATION_PATH represents the high-level
directory in which IBM MQ is installed.
b) Get the message from the queue on the receiver by entering the following command:

./amqsget RECEIVER.Q QMB

The sample program starts, and your message is displayed. After a pause, the sample ends. Then
the command prompt is displayed.

Results
You have now successfully verified the server-to-server installation.

Verifying a client installation on Linux

You can verify that your IBM MQ MQI client installation completed successfully and that the
communication link is working.

About this task

The verification procedure shows how to create a queue manager called queue.manager.1, a local
queue called QUEUE1, and a server-connection channel called CHANNEL1 on the server.
It shows how to create the client-connection channel on the IBM MQ MQI client workstation. It then
shows how to use the sample programs to put a message onto a queue, and get the message from the
queue.
The example does not address any client security issues. See Setting up IBM MQ MQI client security for
details if you are concerned with IBM MQ MQI client security issues.
The verification procedure assumes that:
• The full IBM MQ server product has been installed on a server.
• The server installation is accessible on your network.
• The IBM MQ MQI client software has been installed on a client system.
• The IBM MQ sample programs have been installed.
• TCP/IP has been configured on the server and client systems. For more information, see Configuring
connections between the server and client.

Installing and uninstalling IBM MQ 147

 Procedure
1. Set up the server and client:
• To set up the server and client by using the command line, follow the instructions in “Setting up the
server and client using the command line on Linux” on page 148.
• To set up the server and client by using IBM MQ Explorer, follow the instructions in “Setting up the
server and client using IBM MQ Explorer on Linux” on page 151.
2. Test the communications between client and server, using the instructions in “Testing communication
between a client and a server on Linux” on page 153.
Related tasks
“Installing an IBM MQ client on Linux using rpm” on page 120
Installing an IBM MQ client on a 64 bit Linux system.

Setting up the server and client using the command line on Linux
You can use the command line to create the objects that you need to use to verify a client installation
on Linux. On the server you create a queue manager, a local queue, a listener, and a server-connection
channel. You must also apply security rules to allow the client to connect and make use of the queue
defined. On the client you create a client-connection channel. After setting up the server and client, you
can then use the sample programs to complete the verification procedure.

Before you begin

Before starting this task, review the information in “Verifying a client installation on Linux” on page 147.

About this task

This task explains how to use the command line to set up the server and client so that you can verify your
client installation.
If you prefer to use IBM MQ Explorer, see “Setting up the server and client using IBM MQ Explorer on
Linux” on page 151.

Procedure
1. Set up the server by following the instructions in “Setting up the server using the command line on
Linux” on page 148.
2. Set up the client by following instructions in “Connecting to a queue manager, using the MQSERVER
environment variable on Linux” on page 150.

What to do next
Test the communications between client and server by following the instructions in “Testing
communication between a client and a server on Linux” on page 153.

Setting up the server using the command line on Linux

Follow these instructions to create a queue manager, queue, and channel on the server. You can then use
these objects to verify the installation.

About this task

These instructions assume that no queue manager or other IBM MQ objects have been defined.
IBM MQ object definitions are case-sensitive. Any text entered as an MQSC command in lowercase is
converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that you
type the examples exactly as shown.

148 Installing IBM MQ

 Procedure
1. Create a user ID on the server that is not in the mqm group.
This user ID must exist on the server and client. This is the user ID that the sample applications must
be run as, otherwise a 2035 error is returned.
2. Log in as a user in the mqm group.
3. You must set various environment variables so that the installation can be used in the current shell.
You can set the environment variables by entering the following command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

4. Create a queue manager called QUEUE.MANAGER.1 by entering the following command:

crtmqm QUEUE.MANAGER.1

You see messages telling you that the queue manager has been created.
5. Start the queue manager by entering the following command:

strmqm QUEUE.MANAGER.1

A message tells you when the queue manager has started.

6. Start MQSC by entering the following command:

runmqsc QUEUE.MANAGER.1

A message tells you that an MQSC session has started. MQSC has no command prompt.
7. Define a local queue called QUEUE1 by entering the following command:

DEFINE QLOCAL(QUEUE1)

A message tells you when the queue has been created.

8. Allow the user ID that you created in step 1 to use QUEUE1 by entering the following command:

SET AUTHREC PROFILE(QUEUE1) OBJTYPE(QUEUE) PRINCIPAL(' non_mqm_user ') AUTHADD(PUT,GET)

where non_mqm_user is the user ID created in step 1. A message tells you when the authorization
has been set. You must also run the following command to give the user ID authority to connect:

SET AUTHREC OBJTYPE(QMGR) PRINCIPAL(' non_mqm_user ') AUTHADD(CONNECT)

If this command is not run, a 2305 stop error is returned.

9. Define a server-connection channel by entering the following command:

DEFINE CHANNEL (CHANNEL1) CHLTYPE (SVRCONN) TRPTYPE (TCP)

A message tells you when the channel has been created.

10. Allow your client channel to connect to the queue manager and run under the user ID that you
created in step 1, by entering the following MQSC command:

SET CHLAUTH(CHANNEL1) TYPE(ADDRESSMAP) ADDRESS(' client_ipaddr ') MCAUSER(' non_mqm_user ')

Installing and uninstalling IBM MQ 149

 where client_ipaddr is the IP address of the client system, and non_mqm_user is the user ID created
in step 1. A message tells you when the rule has been set.
11. Define a listener by entering the following command:

DEFINE LISTENER (LISTENER1) TRPTYPE (TCP) CONTROL (QMGR) PORT (port_number)

where port_number is the number of the port the listener is to run on. This number must be the same
as the number used when defining your client-connection channel in “Installing an IBM MQ client on
Linux using rpm” on page 120.
Note: If you omit the port parameter from the command, a default value of 1414 is used for the
listener port. If you want to specify a port other than 1414, you must include the port parameter in
the command, as shown.
12. Start the listener by entering the following command:

START LISTENER (LISTENER1)

13. Stop MQSC by entering:

end

You see some messages, followed by the command prompt.

What to do next
Follow the instructions to set up the client. See “Connecting to a queue manager, using the MQSERVER
environment variable on Linux” on page 150.

Connecting to a queue manager, using the MQSERVER environment variable on Linux

When an IBM MQ application is run on the IBM MQ MQI client, it requires the name of the MQI channel,
the communication type, and the address of the server to be used. Provide these parameters by defining
the MQSERVER environment variable.

Before you begin

Before you start this task, you must complete the task, “Setting up the server using the command line on
Linux” on page 148, and save the following information:
• The host name or IP address of the server and port number that you specified when creating the
listener.
• The channel name of the server-connection channel.

About this task

This task describes how to connect an IBM MQ MQI client, by defining the MQSERVER environment
variable on the client.
You can give the client access to the generated client channel definition table, amqclchl.tab instead;
see Accessing client-connection channel definitions.

Procedure
1. Log in as the userid that you created in Step 1 of “Setting up the server using the command line on
Linux” on page 148.
2. Check the TCP/IP connection. From the client, enter one of the following commands:
• ping server-hostname
• ping n.n.n.n

150 Installing IBM MQ

 n.n.n.n represents the network address. You can set the network address in IPv4 dotted decimal
form, for example, 192.0.2.0. Alternatively, set the address in IPv6 hexadecimal form, for
example 2001:0DB8:0204:acff:fe97:2c34:fde0:3485.
If the ping command fails, correct your TCP/IP configuration.
3. Set the MQSERVER environment variable. From the client, enter the following command:

export MQSERVER=CHANNEL1/TCP/'server-address (port)'

Where:
• CHANNEL1 is the server-connection channel name.
• server-address is the TCP/IP host name of the server.
• port is the TCP/IP port number the server is listening on.
If you do not give a port number, IBM MQ uses the one specified in the qm.ini file, or the client
configuration file. If no value is specified in these files, IBM MQ uses the port number identified in the
TCP/IP services file for the service name MQSeries. If an MQSeries entry in the services file does not
exist, a default value of 1414 is used. It is important that the port number used by the client and the
port number used by the server listener program are the same.

What to do next
Use the sample programs to test communication between the client and server; see “Testing
communication between a client and a server on Linux” on page 153.

Setting up the server and client using IBM MQ Explorer on Linux

You can use IBM MQ Explorer to create the objects that you need to use to verify a client installation
on Linux. On the server, you create a queue manager, a local queue, a listener and a server-connection
channel. On the client system you create a client-connection channel. Then from the command line you
use the sample PUT and GET programs to complete the verification procedure.

Before you begin

Before starting this task, review the information in “Verifying a client installation on Linux” on page 147.

About this task

This task explains how to use IBM MQ Explorer to set up the server and client so that you can verify your
client installation.
If you prefer to use the command line, see “Setting up the server and client using the command line on
Linux” on page 148.

Procedure
1. Set up the server by following the instructions in “Setting up the server using IBM MQ Explorer on
Linux” on page 152.
2. Set up the client by following instructions in “Setting up the client using IBM MQ Explorer on Linux” on
page 152.

What to do next
Test the communications between client and server by following the instructions in “Testing
communication between a client and a server on Linux” on page 153.
Related tasks
“Installing an IBM MQ client on Linux using rpm” on page 120

Installing and uninstalling IBM MQ 151

 Installing an IBM MQ client on a 64 bit Linux system.

Setting up the server using IBM MQ Explorer on Linux

You can use the IBM MQ Explorer to create the server objects that you need to verify your client
installation.

About this task

To verify your installation, you must first create a queue manager, a local queue, a listener and a server-
connection channel on the server.

Procedure
1. Create a queue manager:
a) Open IBM MQ Explorer.
b) Right-click the folder called Queue Managers, select New > Queue Manager.
c) In the first entry field, type the queue manager name, QUEUE.MANAGER.1, and click Finish.
2. Create a local queue:
a) Expand the queue manager you have just created and right-click queues.
b) Select New > Local Queue.
c) Enter the queue name, QUEUE1, and click Finish.
3. Define the server-connection channel:
a) Right-click Channels.
b) Select New > Server Connection Channel.
c) Enter the channel name, CHANNEL1, and click Next.
d) In the dialog navigation pane, click MCA to open the MCA page.
e) In the MCA User ID field, enter a userid that is a member of the mqm group, typically your own.
f) Click Finish.
4. Run the listener.
The listener is automatically started when the queue manager is configured. To check that the listener
is running, open Listeners and look for LISTENER.TCP.

What to do next
Set up the client. See “Setting up the client using IBM MQ Explorer on Linux” on page 152.
Related tasks
“Installing an IBM MQ client on Linux using rpm” on page 120
Installing an IBM MQ client on a 64 bit Linux system.

Setting up the client using IBM MQ Explorer on Linux

You can use IBM MQ Explorer to define the client-connection if you are setting up the client and server on
the same workstation on a Linux system.

Procedure
1. Select the queue manager, QUEUE.MANAGER.1
2. Open the Channels folder, then right-click Client Connections > New > Client-connection Channel...
3. Enter the channel name, CHANNEL1, for the client connection, and click Next.
4. Enter the queue manager name, QUEUE.MANAGER.1
5. Enter the following string as the connection name:

152 Installing IBM MQ

 server-address (port)

Where:
• server-address is the TCP/IP host name of the server
• port is the TCP/IP port number the server is listening on
6. Click Finish.
7. From the command line, set the MQCHLLIB environment variable:
Enter the following command:

export MQCHLLIB=var/mqm/qmgrs/QUEUE!MANAGER!1/@ipcc

Note: The queue manager name contains ".". IBM MQ creates the queue manager directory with the
name, QUEUE!MANAGER!1

What to do next
Use the sample programs to test communication between the client and server. See “Testing
communication between a client and a server on Linux” on page 153.
Related tasks
“Installing an IBM MQ client on Linux using rpm” on page 120
Installing an IBM MQ client on a 64 bit Linux system.

Testing communication between a client and a server on Linux

On the IBM MQ MQI client workstation, use the amqsputc sample program to put a message on the
queue at the server workstation. Use the amqsgetc sample program to get the message from the queue
back to the client.

Before you begin

Complete the previous topics in this section:
• Set up a queue manager, channels, and queue.
• Open a command window.
• Set system environment variables.

About this task

Note that IBM MQ object definitions are case-sensitive. Text entered as an MQSC command in lowercase
is converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that
you type the examples exactly as shown.
You must be logged in with the appropriate authority. For example, user ivtid in the mqm group.

Procedure
1. Change to the MQ_INSTALLATION_PATH/samp/bin directory, which contains the sample
programs.
MQ_INSTALLATION_PATH represents the high-level directory in which IBM MQ is installed.
2. You must set certain environment variables so that the installation can be used in the current shell.
You can set the environment variables by entering the following command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

3. Start the PUT program for QUEUE1 on QUEUE.MANAGER.1 by entering the following command:

Installing and uninstalling IBM MQ 153

 ./amqsputc QUEUE1 QUEUE.MANAGER.1

If the command is successful, the following messages are displayed:

Sample AMQSPUT0 start

target queue is QUEUE1

Tip: You might get the error, MQRC_NOT_AUTHORIZED (2035). By default, channel authentication
is enabled when a queue manager is created. Channel authentication prevents privileged users
accessing a queue manager as an IBM MQ MQI client. For verifying the installation, you can either
change the MCA user ID to a non-privileged user, or disable channel authentication. To disable channel
authentication run the following MQSC command:

ALTER QMGR CHLAUTH(DISABLED)

When you finish the test, if you do not delete the queue manager, re-enable channel authentication:

ALTER QMGR CHLAUTH(ENABLED)

4. Type some message text, then press Enter twice.

The following message is displayed:

Sample AMQSPUT0 end

Your message is now on the queue that is on the server queue manager.
5. Start the GET program for QUEUE1 on QUEUE.MANAGER.1 by entering the following command:

./amqsgetc QUEUE1 QUEUE.MANAGER.1

The sample program starts, and your message is displayed. After a short pause (approximately 30
seconds), the sample ends and the command prompt is displayed again.

Results
You have now successfully verified the client installation.

What to do next
1. You must set various environment variables on the server so that the installation can be used in the
current shell. You can set the environment variables by entering the following command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

2. On the server, stop the queue manager by entering the following command:

endmqm QUEUE.MANAGER.1

3. On the server, delete the queue manager by entering the following command:

dltmqm QUEUE.MANAGER.1

154 Installing IBM MQ

 Uninstalling or modifying IBM MQ on Linux
You can uninstall an IBM MQ server or client. You can also modify an installation by removing selected
packages (components) currently installed on your system.

Procedure
• For information on how to uninstall or modify IBM MQ on Linux, see the following subtopics:
– “Uninstalling or modifying IBM MQ on Linux using rpm” on page 155
– “Uninstalling or modifying IBM MQ on Linux Ubuntu using Debian packages” on page 159

Uninstalling or modifying IBM MQ on Linux using rpm

On Linux, you can uninstall the IBM MQ server or client using the rpm command. You can also modify an
installation by removing selected packages (components) currently installed on your system.

Before you begin

If you have applied one or more fix packs to the version of IBM MQ that you want to uninstall, you need to
remove the fix packs in reverse chronological installation order before you remove the base packages.
You must remove any updates before starting the uninstallation procedure. For more information, see
Restoring the previous maintenance level on IBM MQ on Linux .
Important: You must stop all IBM MQ queue managers, other objects, and applications, before you begin
the process to uninstall or modify IBM MQ.

Procedure
1. Stop all IBM MQ applications associated with the installation you are uninstalling or modifying, if you
have not already done so.
2. For a server installation, end any IBM MQ activity associated with the installation you are uninstalling
or modifying:
a) Log in as a user in the group mqm.
b) Set up your environment to work with the installation you want to uninstall or modify. Enter the
following command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

c) Display the state of all queue managers on the system. Enter the following command:

dspmq -o installation

d) Stop all running queue managers associated with the installation you want to uninstall or modify.
Enter the following command for each queue manager:

endmqm QMgrName

e) Stop any listeners associated with the queue managers. Enter the following command for each
queue manager:

endmqlsr -m QMgrName

3. Log in as root.
4. Uninstall or modify IBM MQ using the rpm command:

Installing and uninstalling IBM MQ 155

 a) On a system with a single installation:
• Find out the names of the packages (components) currently installed on your system, by entering
the following command:

rpm -qa | grep MQSeries

• Remove all components by appending all the package names to the rpm command arguments.
For example:

rpm -qa | grep MQSeries | xargs rpm -ev

• Modify your installation by appending individual package names to the rpm command arguments.
For example, to remove the runtime, Server and SDK components enter the following command:

rpm -ev MQSeriesRuntime MQSeriesServer MQSeriesSDK

• If you are using Ubuntu, add the --force-debian attribute. For example, to remove the
runtime, Server and SDK components enter the following command:

rpm --force-debian -ev MQSeriesRuntime MQSeriesServer MQSeriesSDK

b) On a system with multiple installations:

• Find out the names of the packages (components) currently installed on your system, by entering
the following command:

rpm -qa | grep suffix

where suffix is the unique name given to the packages when crtmqpkg was run at installation
time. suffix is included in each of the package names that belong to a particular installation.
• Remove all components by appending all the package names to the rpm command arguments.
For example, to remove all components from an installation with the suffix MQ80 enter the
following command:

rpm -qa | grep '\<MQSeries.*MQ80\>' | xargs rpm -ev

• Modify your installation by appending individual package names to the rpm command arguments.
For example, to remove the runtime, Server and SDK components from an installation with the
suffix MQ80 enter the following command:

rpm -ev MQSeriesRuntime-MQ80 MQSeriesServer-MQ80 MQSeriesSDK-MQ80

• If you are using Ubuntu, add the --force-debian attribute. For example, to remove the
runtime, Server and SDK components for an installation with the suffix MQ80, enter the following
command:

rpm --force-debian -ev MQSeriesRuntime-MQ80 MQSeriesServer-MQ80 MQSeriesSDK-MQ80

Results
After uninstallation, certain files under the directory trees /var/mqm and /etc/opt/mqm are not
removed. These files contain user data and remain so subsequent installations can reuse the data.
Most of the remaining files contain text, such as INI files, error logs, and FDC files. The directory
tree /var/mqm/shared contains files that are shared across installations, including the executable
shared libraries libmqzsd.so and libmqzsd_r.so.

156 Installing IBM MQ

What to do next
• If the product successfully uninstalled, you can delete any files and directories contained in the
installation directory.
• If there are no other IBM MQ installations on the system, and you are not planning to reinstall
or migrate, you can delete the /var/mqm and /etc/opt/mqm directory trees, including the files
libmqzsd.so and libmqzsd_r.so. Deleting these directories destroys all queue managers and their
associated data.

Uninstalling or modifying IBM MQ on Linux Red

Hat using yum
On Linux Red Hat, you can uninstall the IBM MQ server or client using the yum command. You can also
modify an installation by removing selected packages (components) currently installed on your system.

Before you begin

If you have applied one or more fix packs to the version of IBM MQ that you want to uninstall, you need to
remove the fix packs in reverse chronological installation order before you remove the base packages.
You must remove any updates before starting the uninstallation procedure. For more information, see
Restoring the previous maintenance level on IBM MQ on Linux .
Important: You must stop all IBM MQ queue managers, other objects, and applications, before you begin
the process to uninstall or modify IBM MQ.

Procedure
1. Stop all IBM MQ applications associated with the installation you are uninstalling or modifying, if you
have not already done so.
2. For a server installation, end any IBM MQ activity associated with the installation you are uninstalling
or modifying:
a) Log in as a user in the group mqm.
b) Set up your environment to work with the installation you want to uninstall or modify. Enter the
following command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

c) Display the state of all queue managers on the system. Enter the following command:

dspmq -o installation

d) Stop all running queue managers associated with the installation you want to uninstall or modify.
Enter the following command for each queue manager:

endmqm QMgrName

e) Stop any listeners associated with the queue managers. Enter the following command for each
queue manager:

endmqlsr -m QMgrName

3. Log in as root.
4. Uninstall or modify IBM MQ using the yum remove command:
• On a system with a single installation:

Installing and uninstalling IBM MQ 157

 – Remove the installation by using the following command:

yum remove MQSeries*

– Modify the installation to add a component by using the following command:

yum install packageName

where packageName specifies the component you want to add.

– Modify the installation to remove a component by using the following command:

yum remove packageName

where packageName specifies the component you want to remove.

• On a system with a multiple installations:
– Remove an installation by using the following command:

yum remove MQSeries*suffix*

where suffix specifies the suffix that uniquely identifies the installation.
– Modify the installation to add a component by using the following command:

yum install packageName*suffix*

where packageName specifies the component you want to add, and suffix specifies the suffix
that uniquely identifies the installation.
– Modify the installation to remove a component by using the following command:

yum remove packageName*suffix*

where packageName specifies the component you want to remove, and suffix specifies the suffix
that uniquely identifies the installation.

Results
After uninstallation, certain files under the directory trees /var/mqm and /etc/opt/mqm are not
removed. These files contain user data and remain so subsequent installations can reuse the data.
Most of the remaining files contain text, such as INI files, error logs, and FDC files. The directory
tree /var/mqm/shared contains files that are shared across installations, including the executable
shared libraries libmqzsd.so and libmqzsd_r.so.

What to do next
• If the product successfully uninstalled, you can delete any files and directories contained in the
installation directory.
• If there are no other IBM MQ installations on the system, and you are not planning to reinstall
or migrate, you can delete the /var/mqm and /etc/opt/mqm directory trees, including the files
libmqzsd.so and libmqzsd_r.so. Deleting these directories destroys all queue managers and their
associated data.
Related tasks
“Installing IBM MQ on Linux Red Hat using yum” on page 123
From IBM MQ 9.2.0 you can install IBM MQ on Linux Red Hat by using the yum installer.
Upgrading IBM MQ on Linux
“Uninstalling or modifying IBM MQ on Linux using rpm” on page 155

158 Installing IBM MQ

On Linux, you can uninstall the IBM MQ server or client using the rpm command. You can also modify an
installation by removing selected packages (components) currently installed on your system.

Uninstalling or modifying IBM MQ on Linux Ubuntu using Debian

packages
You can uninstall an IBM MQ server or client that was installed using the Debian package manager. You
can also modify an installation by removing selected packages (components) currently installed on your
system.

Before you begin

If you have applied one or more fix packs to the version of IBM MQ that you want to uninstall, you need to
remove the fix packs in reverse chronological installation order before you remove the base packages.
You must remove any updates before starting the uninstallation procedure. For more information, see
Restoring the previous maintenance level on IBM MQ on Linux .
Important: You must stop all IBM MQ queue managers, other objects, and applications, before you begin
the process to uninstall or modify IBM MQ.

Procedure
1. Stop all IBM MQ applications associated with the installation you are uninstalling or modifying, if you
have not already done so.
2. For a server installation, end any IBM MQ activity associated with the installation you are uninstalling
or modifying:
a) Log in as a user in the group mqm.
b) Set up your environment to work with the installation you want to uninstall or modify. Enter the
following command:

. MQ_INSTALLATION_PATH/bin/setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

c) Display the state of all queue managers on the system. Enter the following command:

dspmq -o installation

d) Stop all running queue managers associated with the installation you want to uninstall or modify.
Enter the following command for each queue manager:

endmqm QMgrName

e) Stop any listeners associated with the queue managers. Enter the following command for each
queue manager:

endmqlsr -m QMgrName

3. Log in as root.
4. Uninstall or modify IBM MQ using a Debian installation command:
• Using apt.
Issuing the command:

apt-get remove "ibmmq-*"

removes the product but leaves the package definition cached.

Installing and uninstalling IBM MQ 159

 Issuing the command:

apt-get purge "ibmmq-*"

purges the cached definition of the product.

• Using dpkg.
Issuing the command:

dpkg -r packagename

removes the product but leaves the package definition cached.

Issuing the command:

dpkg -P packagename

purges the cached definition of the product.

Results
After uninstallation, certain files under the directory trees /var/mqm and /etc/opt/mqm are not
removed. These files contain user data and remain so subsequent installations can reuse the data.
Most of the remaining files contain text, such as INI files, error logs, and FDC files. The directory
tree /var/mqm/shared contains files that are shared across installations, including the executable
shared libraries libmqzsd.so and libmqzsd_r.so.

What to do next
• If the product successfully uninstalled, you can delete any files and directories contained in the
installation directory.
• If there are no other IBM MQ installations on the system, and you are not planning to reinstall
or migrate, you can delete the /var/mqm and /etc/opt/mqm directory trees, including the files
libmqzsd.so and libmqzsd_r.so. Deleting these directories destroys all queue managers and their
associated data.

Removing a fix pack from IBM MQ on Linux Ubuntu using Debian

packages
Follow these instructions to remove a fix pack, for example IBM MQ 9.2.0 Fix Pack 1, on Linux Ubuntu
using Debian packages.

Before you begin

Note: The following instructions apply to a Linux Ubuntu system.
Important: You must stop all IBM MQ queue managers, other objects, and applications, before you begin
the process to modify IBM MQ.

About this task

IBM MQ for Linux uses two different directory trees that are mutually exclusive. The two trees are for:
• The executable libraries and shared libraries,/opt/mqm .
• The data for the queue managers and other configuration files, var/mqm.
Because the directory trees are mutually exclusive, when you apply or remove maintenance only the files
in opt/mqm are affected.
You must uninstall IBM MQ in the reverse order of installation. That is, remove any fix pack you have
applied and then remove the base version of the product.

160 Installing IBM MQ

Procedure
1. Stop all IBM MQ queue managers and clients associated with the installation you are modifying, if you
have not already done so.
For example, issue the following command:

$ endmqm -i TEST_92

You receive a message that the queue manager TEST_92 is ending (that is, shutting down), followed
by another message when shutdown is complete.
2. Issue the following command:

$ ps -ef | grep -i mq

You receive a message similar to this:

mqm 5492 5103 0 16:35 pts/0 00:00:00 ps -ef

Now that there is no IBM MQ activity on the system, you can uninstall the product.
3. Login as root and issue the a command similar to the following, to find out the file sets for IBM MQ
9.2.0 Fix Pack 1.

+++ROOT+++ ubuntumq1.fyre.ibm.com: /root

# apt list "ibmmq-*-u9201*"
Listing... Done
ibmmq-amqp-u9201/unknown,now 9.2.0.1 amd64 [installed]
ibmmq-ams-u9201/unknown,now 9.2.0.1 amd64 [installed]
…
ibmmq-web-u9201/unknown,now 9.2.0.1 amd64 [installed]
ibmmq-xrservice-u9201/unknown,now 9.2.0.1 amd64 [installed]

Note the presence in each line of the following text, unknown, now.
4. Use the following Debian command to uninstall the product.
This command removes the product, but leaves the package definition cached.

# apt remove "ibmmq-*-u9201*"

You receive messages similar to the following:

…
0 upgraded, 0 newly installed, 34 to remove and 78 not upgraded.
After this operation, 974 MB disk space will be freed.
Do you want to continue? [Y/n]
Y
…
Removing ibmmq-runtime-u9201 (9.2.0.1) ...
Entering prerm for "ibmmq-runtime-u9201" remove
Entering postrm for "ibmmq-runtime-u9201" remove

5. List the installed file sets again by issuing the command:

# apt list "ibmmq-*-u9201*"

You receive messages similar to the following:

ibmmq-amqp-u9201/unknown,now 9.2.0.1 amd64 [residual-config]

ibmmq-ams-u9201/unknown,now 9.2.0.1 amd64 [residual-config]
…
ibmmq-web-u9201/unknown,now 9.2.0.1 amd64 [residual-config]
ibmmq-xrservice-u9201/unknown,now 9.2.0.1 amd64 [residual-config]

Note the following statement at the end of each line, residual-config

6. Issue the following command to purge the cached definition of the product:

Installing and uninstalling IBM MQ 161

 # apt purge "ibmmq-*-u9201*"

You receive messages similar to the following:

0 upgraded, 0 newly installed, 34 to remove and 78 not upgraded.

After this operation, 0 B of additional disk space will be used.
Do you want to continue? [Y/n]
Y
…
Purging configuration files for ibmmq-fttools-u9101 (9.2.0.1) ...
Entering postrm for "ibmmq-fttools-u9201" purge

7. List the installed file sets again by issuing the command:

# apt list "ibmmq-*-u9201*"

You receive messages similar to the following:

# apt list "ibmmq-*-u9201*"

Listing... Done
ibmmq-amqp-u9201/unknown 9.2.0.1 amd64
ibmmq-ams-u9201/unknown 9.2.0.1 amd64…
ibmmq-web-u9201/unknown 9.2.0.1 amd64
ibmmq-xrservice-u9201/unknown 9.2.0.1 amd64

Note the presence in each line of the following text, unknown instead of unknown, now.
8. Issue the command dspmqver and you see that the version is

# dspmqver
Name: IBM MQ
Version: 9.2.0.0

Results
You have successfully uninstalled IBM MQ 9.2.0 Fix Pack 1.

What to do next
You can uninstall the base product if required. For more information, see “Uninstalling or modifying IBM
MQ on Linux Ubuntu using Debian packages” on page 159.
Related tasks
Removing maintenance level server updates on Windows
Related reference
endmqm (end queue manager)
dspmqver (display version information)

Installing and uninstalling IBM MQ on Windows

Installation tasks that are associated with installing IBM MQ on Windows systems are grouped in this
section.

About this task

To prepare for installation and to install the IBM MQ components, complete the following tasks.
For information about how to uninstall IBM MQ, see “Uninstalling IBM MQ on Windows” on page 239.
If product fixes or updates are made available, see Applying maintenance to IBM MQ .

162 Installing IBM MQ

Procedure
1. Check the system requirements.
See “Checking requirements on Windows” on page 173.
2. Plan your installation.
• As part of the planning process, you must choose which components to install and where to install
them. See “IBM MQ features for Windows systems” on page 163.
• You must also make some platform-specific choices. See “Planning to install IBM MQ on Windows”
on page 175.
3. Install IBM MQ server.
See “Installing IBM MQ server on Windows” on page 182.
4. Optional: Install an IBM MQ client.
See “Installing an IBM MQ client on Windows” on page 209.
5. Verify your installation. See “Verifying an IBM MQ installation on Windows” on page 226.

IBM MQ features for Windows systems

You can select the features that you require when you install IBM MQ.
Important: See IBM MQ license information for details of what each purchase of IBM MQ entitles you to
install.
If you choose an interactive installation, before you install, you must decide what type of installation you
require. For more information about the available types of installation and the features that are installed
with each option, see “Installation methods for Windows” on page 177.
The following table shows the features that are available when installing an IBM MQ server or client on a
Windows system.

Interactive Non-interactive
displayed name displayed name Description Server media Client media
Server Server You can use the
server to run
queue managers
on your system and
connect to other
systems over a
network. Provides
messaging and
queuing services
to applications,
and support for
IBM MQ client
connections.

From IBM MQ
9.1, additional
prerequisite
checking is
performed on
this option.
See Prerequisite
checking for more
information.

Installing and uninstalling IBM MQ 163

 Interactive Non-interactive
displayed name displayed name Description Server media Client media
IBM MQ Explorer Explorer IBM MQ Explorer
allows you to
administer and
monitor resources
in IBM MQ.
Managed File MFT Service The Managed File
Transfer Service Transfer Service
install option
installs a file
transfer agent that
has additional
capabilities beyond
those provided by
the file transfer
agent installed
using the Managed
File Transfer Agent
install option.
These additional
capabilities are:-
• Create protocol
bridge agents
which are used to
send and receive
files with legacy
FTP, FTPS or
SFTP servers
The Managed File
Transfer Service
install option must
be installed on
systems where the
IBM MQ Server
install option is
already installed.

164 Installing IBM MQ

Interactive Non-interactive
displayed name displayed name Description Server media Client media
Managed File MFT Logger The Managed File
Transfer Logger Transfer Logger
install option
installs a file
transfer logger
which connects to
an IBM MQ queue
manager, often the
queue manager
designated as the
coordination queue
manager. It logs
file transfer audit
related data to
either a database
or a file. It must
be installed on
systems where the
IBM MQ Server
install option is
already installed.
Managed File MFT Agent The Managed File
Transfer Agent Transfer Agent
install option
installs a file
transfer agent
which connects to
an IBM MQ queue
manager and
transfers file data,
as messages, to
other file transfer
agents. These
must be installed
either as part
of the Managed
File Transfer Agent
or Managed File
Transfer Service
install options.

Installing and uninstalling IBM MQ 165

 Interactive Non-interactive
displayed name displayed name Description Server media Client media
Managed File MFT Tools The Managed File
Transfer Tools Transfer Tools
install option
installs command
line tools that
are used to
interact with file
transfer agents.
You can use these
tools to start file
transfers, schedule
file transfers and
create resource
monitors from the
command line.
The Managed File
Transfer Tools can
be installed and
used on either a
system where file
transfer agents are
installed, or on a
system where no
file transfer agents
are installed.

IBM MQ MQI client Client The IBM MQ MQI

client is a small
subset of IBM MQ,
without a queue
manager, that uses
the queue manager
and queues on
other (server)
systems. It can be
used only when
the system it is
on is connected
to another system
that is running a
full server version
of IBM MQ. The
client and server
can be on the same
system if required.
From IBM MQ
9.1.0, this feature
is named MQI
Client. In earlier
versions of the
product, it was
named Windows
Client.

166 Installing IBM MQ

Interactive Non-interactive
displayed name displayed name Description Server media Client media
JavaMsg The files needed
Extended
for messaging
Messaging APIs
using Java. This
feature includes
support for JMS,
XMS, .NET, and
IBM MQ web
services.
From IBM MQ
9.1.0, this feature
is named Extended
Messaging APIs.
In earlier versions
of the product,
it was named
Java and .NET
Messaging and
Web Services.

Web Web Adds HTTP based

Administration administration for
IBM MQ through
the REST API and
IBM MQ Console.
If you want to
install the Web
Administration
feature you
must also install
the Extended
Messaging APIs
(JavaMsg) feature.

Installing and uninstalling IBM MQ 167

 Interactive Non-interactive
displayed name displayed name Description Server media Client media
Development Toolkit This feature
Toolkit includes sample
source files, and
the bindings
(files .H, .LIB, .DLL,
and others),
that you need
to develop
applications to
run on IBM
MQ. Bindings
and samples
are provided for
the following
languages: C, C++,
Visual Basic, Cobol,
and .NET (including
C#). Java and Java
Message Service
support is included
and samples
are provided for
MTS (COM+), and
MQSC.

168 Installing IBM MQ

Interactive Non-interactive
displayed name displayed name Description Server media Client media
Telemetry Service XR Service MQ Telemetry
supports the
connection of
Internet Of Things
(IOT) devices (that
is, remote sensors,
actuators and
telemetry devices)
that use the
IBM MQ Telemetry
Transport (MQTT)
protocol. The
telemetry (MQXR)
service enables a
queue manager
to act as an
MQTT server, and
communicate with
MQTT client apps.
A set of MQTT
clients is available
from the Eclipse
Paho downloads
page. These
sample clients help
you write your
own MQTT client
apps that IOT
devices use to
communicate with
MQTT servers.
The XR Service
install option must
be installed on
systems where the
IBM MQ Server
install option is
already installed.
See also
“Installation
considerations for
MQ Telemetry” on
page 259.

Installing and uninstalling IBM MQ 169

 Interactive Non-interactive
displayed name displayed name Description Server media Client media
Advanced Message AMS Provides a high
Security level of protection
for sensitive data
flowing through
the IBM MQ
network, while
not impacting the
end applications.
You must install
this component
on all IBM MQ
installations that
host queues you
want to protect.
You must install
the IBM Global
Security Kit
component on
any IBM MQ
installation that is
used by a program
that puts or gets
messages to or
from a protected
queue, unless you
are using only Java
client connections.
The AMS install
option must
be installed on
systems where the
IBM MQ Server
install option is
already installed.

170 Installing IBM MQ

Interactive Non-interactive
displayed name displayed name Description Server media Client media
AMQP Service AMQP Install this
component to
make AMQP
channels available.
AMQP channels
support AMQP 1.0
APIs. You can use
AMQP channels
to give AMQP
applications access
to the enterprise-
level messaging
facilities provided
by IBM MQ.

The AMQP Service

install option must
be installed on
systems where the
IBM MQ Server
install option is
already installed.
From IBM MQ 9.1,
Java Runtime JRE
the Java Runtime
Environment
Environment (JRE)
is a separate
feature.
The JRE feature
installs a JRE that
has been tailored
for IBM MQ use,
and is a required
feature for all other
features that use
Java. That is:
• IBM MQ Explorer
• Web
Administration
• Telemetry
Service
• AMQP Service
• Managed File
Transfer
Additional
prerequisite
checking is
performed on
this option.
See Prerequisite
checking for more
information.

Installing and uninstalling IBM MQ 171

 Windows standard installation features
The following features are part of the Windows standard installation feature set. They are the features
installed by the GUI installer for a "typical installation".

Interactive displayed name Non-interactive Notes

displayed name
Server Server
MQ Explorer Explorer
Extended Messaging APIs JavaMsg Feature renamed at IBM MQ 9.1.0. It
was previously named Java and .NET
messaging and Web Services.
Web Administration Web Feature added at IBM MQ 9.1.0
Development Toolkit Toolkit
Java Runtime Environment JRE Feature added at IBM MQ 9.1.0. Prior
to IBM MQ 9.1.0, the JRE feature was
always installed.

When you install an IBM MQ server using msiexec, the features that are included in a typical installation
are added to the list of features that you specify in the ADDLOCAL directive.
If you specify ADDLOCAL="" all these features will be installed.
If you do not want specific features added, you must add those specific features to the REMOVE directive.
For example, suppose that you specify the following settings for an msiexec installation:

ADDLOCAL="Client"
REMOVE="Web,Toolkit"

This results in the following features being installed:

Server,Explorer,JavaMsg,JRE,Client

Related concepts
“IBM MQ components and features” on page 6
You can select the components or features that you require when you install IBM MQ.
“Planning considerations for installation on Multiplatforms” on page 14
Before you install IBM MQ, you must choose which components to install and where to install them. You
must also make some platform-specific choices.
Related tasks
“Installing the server using the Launchpad” on page 183
You can install IBM MQ server on Windows systems by using the Launchpad. This procedure can be used
for installing a first or a subsequent installation.
“Installing the server using msiexec” on page 185

172 Installing IBM MQ

IBM MQ on Windows uses the MSI technology to install software. MSI provides both an interactive
installation and a non interactive installation.

Checking requirements on Windows

Before you install IBM MQ on Windows, you must check for the latest information and system
requirements.

About this task

A summary of the tasks that you must complete to check system requirements are listed here with links
to further information.

Procedure
1. Check that you have the latest information, including information on hardware and software
requirements.
See “Where to find product requirements and support information” on page 9.
2. Check that your systems meet the initial hardware and software requirements for Windows.
See “Hardware and software requirements on Windows systems” on page 173.
3. Check that your systems have sufficient disk space for the installation.
See Disk space requirements.
4. Check that you have the correct licenses.
See “License requirements” on page 8 and IBM MQ license information.
Related concepts
“IBM MQ installation overview” on page 5
An overview of concepts and considerations for installing IBM MQ, with links to instructions on how to
install, verify, and uninstall IBM MQ on each of the supported platforms.
Related tasks
Applying maintenance to IBM MQ

Hardware and software requirements on Windows systems

Check that the server environment meets the prerequisites for installing IBM MQ for Windows and install
any prerequisite software that is missing from your system from the server DVD.
Before you install IBM MQ, you must check that your system meets the hardware and software
requirements.
You must also review the product readme file, which includes information about last-minute changes and
known problems and workarounds. For the latest version of the product readme file, see the IBM MQ,
WebSphere MQ, and MQSeries product readmes web page.

Supported versions of Windows

For a list of the supported versions of the Windows operating system, see the System Requirements for
IBM MQ website and follow the links to the Detailed System Requirements report for Windows. There are
separate reports for Long Term Support and Continuous Delivery.
Although IBM MQ 9.1, and later, no longer supports some earlier versions of the Windows operating
system referred to in the documentation, these earlier versions of Windows might still be supported for an
earlier version of IBM MQ installed in the same domain as an IBM MQ 9.1 or later installation.

Changes to Windows features in Windows 10

The names of some of the Windows features have changed in Windows 10:

Installing and uninstalling IBM MQ 173

 • Windows Explorer is File Explorer
• My Computer is called This PC
• The way in which you start the Control Panel is different
• The default browser is Microsoft Edge.
Note: The IBM MQ Console supports only the following browsers:
– Microsoft Edge
– Google Chrome
– Mozilla Firefox

Storage requirements for IBM MQ server

The storage requirements depend on which components you install, and how much working space you
need. The storage requirements also depend on the number of queues that you use, the number and
size of the messages on the queues, and whether the messages are persistent. You also require archiving
capacity on disk, tape, or other media. For more information, see System Requirements for IBM MQ.
Disk storage is also required:
• Prerequisite software
• Optional software
• Your application programs

Requirements for IBM MQ Explorer

IBM MQ Explorer can be installed either as part of the product installation, or from the stand-alone IBM
MQ Explorer support pack MS0T.
• The product version is available for Windows x86_64.
• The support pack version is available for Windows x86 and x86_64.
The requirements for installing IBM MQ Explorer as part of the product installation, and not as the
stand-alone IBM MQ Explorer support pack MS0T, include:
• A 64-bit (x86_64) processor
• 64-bit Windows operating system
Attention: From IBM MQ 9.0.0, the 32-bit version of IBM MQ Explorer is no longer supported.

For further information about Windows requirements, see IBM MQ Explorer Requirements and the
following web pages:
• Windows 7 system requirements
• Windows 8 system requirements

Requirements for IBM MQ classes for .NET

From IBM MQ 9.1.1, the following prerequisites apply to IBM MQ classes for .NET:
• .NET Core 2.1 is a prerequisite to use IBM MQ classes for .NET Standard, for developing .NET Core
applications.
• .NET Framework V4.7.1 is a prerequisite to use IBM MQ classes for .NET Standard, for developing .NET
Framework applications.

174 Installing IBM MQ

Installation directories used for Windows operating systems
The 64-bit IBM MQ server or client, by default, installs its program directories into the 64-bit installation
location: C:\Program Files\IBM\MQ.
Attention: From IBM MQ 9.0.0, there is no separate 32-bit client installation package. The client
installation package and redistributable client contain both 32-bit and 64-bit IBM MQ client
libraries. The included 32-bit libraries can be used by 32-bit applications on supported platforms
where 32-bit support is offered by the operating system.
The default data directory that is used by IBM MQ changed in IBM MQ 8.0 to C:\ProgramData\IBM\MQ.
This change affects both servers, in 32 and 64 bits and clients in 64 bits. However, if there has been
a previous installation of IBM MQ on the machine on which you are installing, the new installation
continues to use the existing data directory location. For more information, see Program and data
directory locations.

Installing prerequisite software

To install the prerequisite software that is provided on the IBM MQ Server DVD (which does not include
service packs or web browsers), choose one of the following options:
• Use the IBM MQ installation procedure.
When you install using the IBM MQ Server DVD, there is a Software Prerequisites option in the IBM MQ
Installation Launchpad window. You can use this option to check what prerequisite software is already
installed and what is missing, and then install any missing software.
• Use Windows Explorer:
1. Use Windows Explorer to select the Prereqs folder on the IBM MQ Server DVD.
2. Select the folder for the software item to be installed.
3. Start the installation program.
Related concepts
“Hardware and software requirements on Linux systems” on page 95
Before you install IBM MQ, check that your system meets the hardware and operating system software
requirements for the particular components you intend to install.
“Hardware and software requirements on IBM i systems” on page 63
Check that the server environment meets the prerequisites for installing IBM MQ for IBM i.
Related tasks
“Checking requirements on Windows” on page 173
Before you install IBM MQ on Windows, you must check for the latest information and system
requirements.
Related reference
IBM MQ Explorer Requirements

Planning to install IBM MQ on Windows

Before you install IBM MQ on Windows, you must choose which components to install and where to install
them. You must also make some platform-specific choices.

About this task

The following steps provide links to additional information to help you with planning your installation of
IBM MQ on Windows.
As part of your planning activities, make sure that you review the information on hardware and software
requirements for the platform on which you are planning to install IBM MQ. For more information, see
“Checking requirements on Windows” on page 173.

Installing and uninstalling IBM MQ 175

 Procedure
1. Decide which IBM MQ components and features to install.
See “IBM MQ components and features” on page 6 and “Where to find downloadable installation
images” on page 9.
Important: Ensure that your enterprise has the correct license, or licenses, for the components that
you are going to install. For more information, see “License requirements” on page 8 and IBM MQ
license information.
2. Review the options for naming your installation.
In some cases, you can choose an installation name to use instead of the default name. See
“Installation name on AIX, Linux, and Windows” on page 14.
3. Review the options and restrictions for choosing an installation location for IBM MQ.
For more information, see “Installation location on Multiplatforms” on page 15.
4. If you plan to install multiple copies of IBM MQ, see “Multiple installations on AIX, Linux, and
Windows” on page 17.
5. If you already have a primary installation, or plan to have one, see “Primary installation on AIX, Linux,
and Windows” on page 18.
6. Make sure that the communications protocol needed for server-to-server verification is installed and
configured on both systems that you plan to use.
For more information, see “Server-to-server links on AIX, Linux, and Windows” on page 26.
7. Determine whether you need to install the Java Runtime Environment (JRE).
From IBM MQ 9.1.0, if you are not using Java in your messaging applications, and you are not using
portions of IBM MQ that are written in Java, you have the option to not install the JRE (or to remove the
JRE if it was already installed).

Attention: If you choose not to install the JRE, or to remove the JRE if it was already installed:
• You must perform your key management by using the runmqakm command line tool rather
than the strmqikm GUI tool, or the runmqckm command line tool.
• The IBM Key Management shortcut is still installed. Clicking the shortcut has no effect. You
should use the runmqakm command line tool instead.
• Use of the runmqras command fails unless a JRE at version 7, or later, is available on the
system path.
On Windows, before IBM MQ 9.1.0, the JRE was a hidden installation feature that was always installed.
From IBM MQ 9.1.0, the JRE becomes an independently installable feature. The feature can be
installed or omitted, either silently or though the GUI installer, as long as you are not installing other
features that require the presence of the JRE. For more information, see Install features that require
the Server or JRE.
Upgrading from an earlier version of IBM MQ to IBM MQ 9.1.0 (or later) adds the separately installed
JRE feature to the installed product.
For more information, see Using runmqckm, runmqakm, and strmqikm to manage digital certificates.

Additional Windows features prerequisite checking

There are two Windows installation features that have additional prerequisite checking enabled in the
Windows IBM MQ installer from IBM MQ 9.1. These are the Server feature and the Java Runtime
Environment (JRE) feature. These features are required by other features and installing those features,
without these prerequisite checks, would cause those features to be unusable.
If you perform a Graphical User Interface installation, and select the custom install option, you can
deselect the JRE or Server features.
Attention: Dialog panels prevent you from completing the installation, until you have resolved any
issues.

176 Installing IBM MQ

If you perform a silent installation, and you elect to REMOVE the Server or JRE features while installing
any other features that require those features, the Server and JRE features, as appropriate, will be
added to your selected installation features.
Table 20 on page 177 describes how the selection of certain installation features requires the Server or
JRE to be added automatically.

Table 20. Installation features requiring either the Server or JRE feature
Feature Required by Non-interactive name
Server Web Administration Web

JRE IBM MQ Explorer Explorer

Telemetry Service XR Service

Managed File Transfer Service MFT Service

Managed File Transfer Agent MFT Agent

Managed File Transfer Logger MFT Logger

Managed File Transfer Tools MFT Tools

AMQP Service AMQP Service

Web Administration Web

To check whether the JRE or Server features have been installed, look in the [INSTALLDIR]\swidtag
directory. If the:
• ibm.com_IBM_MQ-9.0.x.swidtag file is present, the Server has been installed
• IBM_MQ_JRE-1.8.0.mqtag file is present, the JRE has been installed.
If this is not what you require, consult the installation log.
Important: Each of the JRE and Server features are part of the set of Windows standard IBM MQ
installation features. To remove the JRE (or the Server) when installing silently, add the feature to the
REMOVE directive, do not merely omit it from the ADDLOCAL directive. See “Windows standard installation
features” on page 172 for further details.

Installation methods for Windows

When you install IBM MQ on Windows, there are several different installation types to choose from. This
topic also describes how you can clear the installation settings of your enterprise, including the use of the
ResetMQ command script.
If you are migrating from an earlier version of IBM MQ, see Migration planning before moving to the latest
version of IBM MQ. To modify an existing installation, see “Modifying a server installation” on page 207.

Interactive or non-interactive installation

IBM MQ for Windows is installed using the Microsoft Installer (MSI). You can use the Installation
Launchpad to invoke MSI, this process is called an attended or interactive installation. Alternatively, you
can invoke MSI directly for a silent installation, without using the IBM MQ Installation Launchpad. This
means that you can install IBM MQ on a system without interaction. This process is called unattended,
silent, or non-interactive installation, and is useful for installing IBM MQ over a network on a remote
system.
For a list of interactive and non-interactive features, see “IBM MQ features for Windows systems” on page
163.

Installing and uninstalling IBM MQ 177

 Interactive installation
If you choose an interactive installation, before you install, you must decide what type of installation you
require. Table 21 on page 178 shows the installation types available, and the features that are installed
with each option. For the prerequisites required for each feature, see System Requirements for IBM MQ.
The installation types are:
• Typical installation
• Compact installation
• Custom Installation
You can also:
• Specify the installation location, name, and description.
• Have multiple installations on the same computer.
See “Primary installation on AIX, Linux, and Windows” on page 18 for important information about these
features, including whether to designate your installation as the primary installation.

Table 21. Features installed with each type of interactive installation

Installation Server Features installed Client Features installed Comments
type
Typical • Server • MQI Client The default option. Features
are installed to default
• IBM MQ Explorer • Development Toolkit locations with a default
• Development Toolkit • Extended Messaging APIs installation name.
• Extended Messaging APIs Extended Messaging APIs
• Web Administration (known as Java and .NET
Messaging and Web Services
before IBM MQ 9.1) includes
IBM MQ classes for .NET,
support for the Microsoft
Windows Communication
Foundation (WCF) for use with
Microsoft.NET 3.

Compact • Server only • MQI Client only The feature is installed to the
default location with a default
installation name.

178 Installing IBM MQ

Table 21. Features installed with each type of interactive installation (continued)
Installation Server Features installed Client Features installed Comments
type
Custom By default, the following By default, the following A server custom installation
features are preselected: features are preselected: can be used if you want to
install the IBM MQ MQI client
• Server • MQI Client
from within the server image.
• IBM MQ Explorer • Development Toolkit
All the available features are
• Development Toolkit • Extended Messaging APIs listed and you can select
• Extended Messaging APIs which ones to install, and
• Web Administration where to install them. You
can also name and provide a
A custom installation can also description for the installation.
install:
Use a custom installation when
• Telemetry Service you want to specify that the
• Advanced Message Security installation is primary.
• Managed File Transfer Extended Messaging APIs
Service (known as Java and .NET
• Managed File Transfer Messaging and Web Services
Logger before IBM MQ 9.1) includes
IBM MQ classes for .NET,
• Managed File Transfer Agent support for the Microsoft
• Managed File Transfer Tools Windows Communication
• MQI Client Foundation (WCF) for use with
Microsoft.NET 3 or later.

If Microsoft.NET is not installed before IBM MQ and you add it, rerun setmqinst -i -n
Installationname if this is a primary installation.
The following table describes which level of .NET is required for which function:

Table 22. Required levels of Microsoft.NET

IBM MQ function .NET version required
IBM MQ classes for .NET. For more information, .NET 2
see: Getting started with IBM MQ classes for .NET
2
The IBM MQ custom channel for WCF. For more .NET framework 3.5 or later
information, see Developing WCF applications with
IBM MQ.
To build the sample solution files, either the
Microsoft.NET 3.5 SDK, or Microsoft Visual Studio
2008 is needed. For more information, see:
Software requirements for the WCF custom
channel for IBM MQ

For instructions on how to install IBM MQ on Windows systems, see Installing IBM MQ Server on Windows
systems and “Installing an IBM MQ client on Windows” on page 209.

Non-interactive installation
If you choose a non-interactive installation the system on which you want to install must be able to access
the IBM MQ image, or a copy of the files, and you must be able to access the system.

Installing and uninstalling IBM MQ 179

 If you are running IBM WebSphere MQ 7.5 or later, with User Account Control (UAC) enabled, you must
invoke the non-interactive installation from an elevated command prompt. Elevate a command prompt by
using a right-click to start the command prompt and choose Run as administrator. If you try to silently
install from a non-elevated command prompt, the installation fails with an error of AMQ4353 in the
installation log.
There are several ways to invoke MSI:
• Using the msiexec command with command-line parameters.
• Using the msiexec command with a parameter that specifies a response file. The response file contains
the parameters that you normally supply during an interactive installation. See “Installing the server
using msiexec” on page 185.
• Use the MQParms command with command-line parameters, a parameter file, or both. The parameter
file can contain many more parameters than a response file. See “Installing the server using the
MQParms command” on page 194.

Special domain ID
If the system belongs to a Windows domain you may need a special domain ID for the IBM MQ service,
see “Considerations when installing IBM MQ server on Windows” on page 181 for more information.

Clearing IBM MQ installation settings

When you install IBM MQ on Windows, various values, such as the location of the data directory for IBM
MQ, are stored in the registry.
In addition, the data directory contains configuration files that are read at installation time. To provide
a trouble free re-installation experience, these values and files persist even after the last IBM MQ
installation has been removed from the machine.
This is designed to assist you, and
• Allows you to easily uninstall and reinstall
• Ensures that you do not lose any previously defined queue managers in the process.
However in some cases this feature can be an annoyance. For example, if you want to:
• Move the data directory
• Pick up the default data directory for the new release that you want to install. For more information, see
Program and data directory locations on Windows.
• Install as if installing on a new machine, for example, for test purposes.
• Remove IBM MQ permanently.
To assist you in these situations, IBM MQ 8.0 onwards supplies a Windows command file, on the root
directory of the installation media, called ResetMQ.cmd.
To run the command, enter the following:

ResetMQ.cmd [LOSEDATA] [NOPROMPT]

Attention: The parameters LOSEDATA and NOPROMPT are optional. If you supply either, or both, of
these parameters, the following action results:
LOSEDATA
Existing queue managers become unusable. However, the data remains on disk.
NOPROMPT
Configuration information is permanently removed without further prompting.
You can run this command only after the last IBM MQ installation has been removed.

180 Installing IBM MQ

Important: You should use this script with caution. The command, even without specifying the optional
parameter LOSEDATA, can irrecoverably remove queue manager configuration.
Related concepts
“Considerations when installing IBM MQ server on Windows” on page 181
There are some considerations relating to security that you should take into account when installing an
IBM MQ server on Windows. There are some additional considerations relating to the object naming rules
and logging.

Considerations when installing IBM MQ server on Windows

There are some considerations relating to security that you should take into account when installing an
IBM MQ server on Windows. There are some additional considerations relating to the object naming rules
and logging.

Security considerations when installing IBM MQ server on a Windows system

• If you are installing IBM MQ on a Windows domain network running Active Directory Server, you
probably need to obtain a special domain account from your domain administrator. For further
information, and the details that the domain administrator needs to set up this special account, see
“Configuring IBM MQ with the Prepare IBM MQ Wizard” on page 200 and “Creating and setting up
Windows domain accounts for IBM MQ” on page 204.
• When you are installing IBM MQ server on a Windows system you must have local administrator
authority. In order to administer any queue manager on that system, or to run any of the IBM MQ control
commands your user ID must belong to the local mqm or Administrators group . If the local mqm
group does not exist on the local system, it is created automatically when IBM MQ is installed. A user
ID can either belong to the local mqm group directly, or belong indirectly through the inclusion of global
groups in the local mqm group. For more information, see Authority to administer IBM MQ on UNIX,
Linux, and Windows.
• Windows versions with a User Account Control (UAC) feature restricts the actions users can perform on
certain operating system facilities, even if they are members of the Administrators group. If your user
ID is in the Administrators group but not the mqm group you must use an elevated command prompt to
issue IBM MQ admin commands such as crtmqm, otherwise the error AMQ7077 is generated. To open
an elevated command prompt, right-click the start menu item, or icon, for the command prompt, and
select Run as administrator.
• Some commands can be run without being a member of the mqm group (see Authority to administer IBM
MQ on UNIX, Linux, and Windows).
• As with other versions of Windows, the object authority manager (OAM) gives members of the
Administrators group the authority to access all IBM MQ objects even when User Account Control is
enabled.
• If you intend to administer queue managers on a remote system, your user ID must be authorized
on the target system. If you need to perform any of these operations on a queue manager when
connected remotely to a Windows machine, you must have the Create global objects user
access. Administrators have the Create global objects user access by default, so if you are an
administrator you can create and start queue managers when connected remotely without altering your
user rights. For more information, see Authorizing users to use IBM MQ remotely.
• If you use the highly secure template, you must apply it before installing IBM MQ. If you apply the highly
secure template to a machine on which IBM MQ is already installed, all the permissions you have set on
the IBM MQ files and directories are removed (see Applying security template files on Windows).

Naming considerations
Windows has some rules regarding the naming of objects created and used by IBM MQ. These naming
considerations apply to IBM WebSphere MQ 7.5 or later.

Installing and uninstalling IBM MQ 181

 • Ensure that the machine name does not contain any spaces. IBM MQ does not support machine names
that include spaces. If you install IBM MQ on such a machine, you cannot create any queue managers.
• For IBM MQ authorizations, names of user IDs and groups must be no longer than 64 characters (spaces
are not allowed).
• An IBM MQ for Windows server does not support the connection of an IBM MQ MQI client if the client is
running under a user ID that contains the @ character, for example, abc@d. Similarly, the client user ID
should not be the same as local group.
• A user account that is used to run the IBM MQ Windows service is set up by default during the
installation process; the default user ID is MUSR_MQADMIN. This account is reserved for use by IBM
MQ. For more information, see Configuring user accounts for IBM MQ and Local and domain user
accounts for the IBM MQ Windows service.
• When an IBM MQ client connects to a queue manager on the server, the username under which the
client runs must not be same as the domain or machine name. If the user has the same name as the
domain or machine, the connection fails with return code 2035(MQRC_NOT_AUTHORIZED).

Logging
You can set up logging during installation which assists you in troubleshooting any problems you might
have with the installation.
From IBM WebSphere MQ 7.5, logging is enabled by default from the Launchpad. You can also enable
complete logging, for more information, see How to enable Windows Installer logging.

Digital signatures
The IBM MQ programs and installation image are digitally signed on Windows to confirm that they are
genuine and unmodified. From IBM MQ 8.0 the SHA-256 with RSA algorithm is used to sign the IBM MQ
product.

Installing IBM MQ server on Windows

On Windows, IBM MQ is installed by using the Microsoft Installer (MSI). You can either use the
Installation Launchpad to invoke MSI or alternatively, you can invoke MSI directly.

About this task

To install IBM MQ server on Windows systems, you can choose either to install interactively with the
Launchpad or to install by using MSI technology directly. MSI provides both an interactive installation and
a non interactive installation.
For more information on installation options, see “Installation methods for Windows” on page 177.

Procedure
• To install IBM MQ server by using the Launchpad, see “Installing the server using the Launchpad” on
page 183.
• To install IBM MQ server on by using the MSI technology directly, see “Installing the server using
msiexec” on page 185.
Related concepts
“Modifying a server installation” on page 207
You can modify an IBM MQ server installation interactively using the launchpad or non-interactively using
msiexec.
Related tasks
“Configuring user accounts for IBM MQ” on page 200

182 Installing IBM MQ

After installing IBM MQ server, you must configure the IBM MQ service before you can start any queue
managers.
“Uninstalling IBM MQ on Windows” on page 239
You can uninstall the IBM MQ MQI clients and servers on Windows systems by using the control panel,
the command line ( msiexec ), MQParms, or by using the installation media, in which case you can
optionally remove queue managers as well.

Installing the server using the Launchpad

You can install IBM MQ server on Windows systems by using the Launchpad. This procedure can be used
for installing a first or a subsequent installation.

About this task

You can use the Launchpad to make a compact, typical, or custom installation of IBM MQ. You can reuse
the launchpad multiple times to install further installations. It automatically selects the next available
installation name, instance, and location to use. To view all the installation types and the features that are
installed with each option, see “Installation methods for Windows” on page 177.
Note that if you have previously uninstalled IBM MQ from your system (see “Uninstalling IBM MQ on
Windows” on page 239 ), some configuration information might remain, and some default values might be
changed.

From IBM MQ 9.2.1, a new Confirm License Entitlement panel in the Windows interactive
installer is presented after feature selection if you have chosen to install any IBM MQ Advanced features
(MQ Telemetry Service, Advanced Message Security, or Managed File Transfer Service), or if you are
upgrading from an installation that already has these features.

This panel simply warns you that these features are considered IBM MQ Advanced
functionality and should only be installed if you have entitlement to IBM MQ Advanced. This warning
reduces the risk of users installing IBM MQ Advanced features on a machine in error.
Note: The Confirm License Entitlement panel applies to production server builds and not to clients, beta
builds, trial builds or developer (non-warranty) builds.

Procedure
1. Access the IBM MQ installation image.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.
2. Locate setup.exe in the base directory of the IBM MQ installation image.
• From a network location, this location might be m:\instmqs\setup.exe
• From a local file system directory, this location might be C:\instmqs\setup.exe
• From a DVD, this location might be E:\setup.exe
3. Start the installation process.
Either run setup.exe from a command prompt, or double-click setup.exe from Windows Explorer.
Note: If you are installing on a Windows system with UAC enabled, accept the Windows prompt to
allow the launchpad to run as elevated. During installation, you might also see Open File - Security
Warning dialog boxes that list International Business Machines Limited as the publisher. Click Run to
allow the installation to continue.
The IBM MQ Installation window is displayed.
4. Follow the instructions on screen. Review, and if necessary, modify the software requirements and
network configuration.

Installing and uninstalling IBM MQ 183

 5. On the IBM MQ Installation tab of the Launchpad, select the installation language, and then click
Launch IBM MQ Installer to start the IBM MQ installation wizard.
6. Use the IBM MQ installation wizard to install the software.

If you select any IBM MQ Advanced features and the Confirm License Entitlement panel
then appears:
• If you do have an IBM MQ Advanced license, simply select Yes (I have an MQ Advanced license)
and Next to continue with the installation.
• If you do not have an IBM MQ Advanced license and do not intend to purchase one, click Back and
change your feature selections.
Depending on your system the installation process can take several minutes. At the end of the
installation process, the IBM MQ Setup window displays the message Installation Wizard
Completed Successfully.
When this message appears, click Finish.

Results
You have successfully installed IBM MQ. The Prepare IBM MQ wizard starts automatically, displaying the
Welcome to the Prepare IBM MQ Wizard page.

What to do next
Use the Prepare IBM MQ Wizard to configure IBM MQ with a user account for your network. You must
run the wizard to configure the IBM MQ Service before you can start any queue managers. For more
information, see “Configuring IBM MQ with the Prepare IBM MQ Wizard” on page 200.
• If you have chosen this installation to be the primary installation on the system, you must now set it as
the primary installation. Enter the following command at the command prompt:

MQ_INSTALLATION_PATH\bin\setmqinst -i -p MQ_INSTALLATION_PATH

You can have only one primary installation on a system. If there is already a primary installation on the
system, you must unset it before you can set another installation as the primary installation. For more
information, see Changing the primary installation.
• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ. For
more information, see setmqenv and crtmqenv.
• For instructions on how to verify your installation, see “Verifying an IBM MQ installation on Windows” on
page 226.
Related concepts
“Modifying a server installation” on page 207
You can modify an IBM MQ server installation interactively using the launchpad or non-interactively using
msiexec.
Related tasks
“Installing the server using msiexec” on page 185
IBM MQ on Windows uses the MSI technology to install software. MSI provides both an interactive
installation and a non interactive installation.
“Configuring user accounts for IBM MQ” on page 200
After installing IBM MQ server, you must configure the IBM MQ service before you can start any queue
managers.
“Uninstalling IBM MQ on Windows” on page 239

184 Installing IBM MQ

You can uninstall the IBM MQ MQI clients and servers on Windows systems by using the control panel,
the command line ( msiexec ), MQParms, or by using the installation media, in which case you can
optionally remove queue managers as well.

Installing the server using msiexec

IBM MQ on Windows uses the MSI technology to install software. MSI provides both an interactive
installation and a non interactive installation.

Before you begin

If you are running IBM MQ on Windows systems with User Account Control (UAC) enabled, you
must invoke the installation with elevated privileges. If you are using the Command prompt or IBM
MQ Explorer, you elevate privileges by using a right-click to start the program and selecting Run as
administrator. If you try to run msiexec without using elevated privileges, the installation fails with an
error of AMQ4353 in the installation log.

About this task

IBM MQ on Windows uses the MSI technology to install software. MSI provides both an interactive
installation and a non interactive installation. An interactive installation displays panels and ask
questions.
The msiexec command uses parameters to give MSI some or all of the information that can also be
specified through panels during an interactive installation. This means that a user can create a reusable
automated or semi-automated installation configuration. Parameters can be given through the command
line, a transform file, a response file, or a combination of the three.
Some parameters can only be provided on the command line and not in a response file. For more
information about these parameters, see Table 23 on page 187 in “Specifying command line parameters
for server installation with msiexec” on page 187.
There are also a number of parameters can be used either on the command line or in a response file. For
more information about these parameters, see Table 25 on page 190 in “Creating and using a response
file for server installation” on page 189. If a parameter is specified both on the command line and in a
response file, the setting on the command line takes precedence.

Procedure
1. For multiple silent installations, for each version that is to be installed, find an MSI instance ID that is
available to use for that installation.
For more information, see “Choosing MSI Instance IDs for multiple client installations” on page 212.
2. To install using msiexec, at the command line, enter the msiexec command in the following format:

msiexec parameters [USEINI="response-file"] [TRANSFORMS="transform_file"]

where:
parameters
are either command-line parameters preceded by a / character, or property=value pairs. If you
are using both forms of parameter, always put the command-line parameters first. For more
information, see “Specifying command line parameters for server installation with msiexec” on
page 187, which contains a link to the web site that lists all the command line parameters that are
available.
For an unattended installation, you must include the /q or /qn parameter in the command line.
Without this parameter, the installation is interactive.
Note: You must include the /i parameter and the file location of the IBM MQ installer package.

Installing and uninstalling IBM MQ 185

 response-file
is the full path and file name of the file that contains the [Response] stanza and the
required property=value pairs, for example C:\MyResponseFile.ini. An example response file,
Response.ini, is supplied with IBM MQ. This file contains default installation parameters. For
more information, see “Creating and using a response file for server installation” on page 189.
transform_file
is the full path and file name of a transform file. For more information, see “Using transforms with
msiexec for server installation” on page 188 and “Choosing MSI Instance IDs for multiple server
installations” on page 186.
Note: For a silent installation to succeed, the AGREETOLICENSE="yes" property must be defined
either on the command line or in the response file.

Results
After the command has been entered, the command prompt immediately reappears. IBM MQ is installing
as a background process. If you have entered parameters to produce a log, check this file to see
how the installation is progressing. If the installation completes successfully, you see the message
Installation operation completed successfully in the log file.

Choosing MSI Instance IDs for multiple server installations

For multiple silent installations, for each version that is installed you must find an MSI instance ID that is
available to use for that installation.

About this task

In order to support silent, or non-interactive, multiple installations, you need to find out whether the
instance ID you want to use is already in use or not and choose the appropriate one. For each installation
media (for example, each client and server), Instance ID 1 is the default ID which is used for single
installations. If you want to install alongside Instance ID 1 you need to specify which instance you want
to use. If you have already installed instance 1, 2, and 3 then you need to find out what the next available
instance is, for instance, Instance ID 4. Similarly, if instance 2 has been removed, you need to find out
that there is a gap that can be reused. You can find out which Instance ID is currently in use by using the
dspmqinst command.

Procedure
1. Type dspmqinst to find a free MSI Instance in the media being installed by reviewing the MSIMedia
and MSIInstanceId values for the versions already installed. For example:

InstName: Installation1
InstDesc:
Identifier: 1
InstPath: C:\Program Files\IBM\MQ
Version: 9.0.0.0
Primary: Yes
State: Available
MSIProdCode: {74F6B169-7CE6-4EFB-8A03-2AA7B2DBB57C}
MSIMedia: 9.0 Server
MSIInstanceId: 1

2. If MSI Instance ID 1 is in use and you want to use MSI Instance ID 2, the following parameters must
be added to the msiexec call:

MSINEWINSTANCE=1 TRANSFORMS=":instanceId7.mst;1033.mst"

What to do next
For multiple installations, the INSTALLATIONNAME or PGMFOLDER must be supplied as an additional
parameter on any non-interactive installation command. Supplying the INSTALLATIONNAME or

186 Installing IBM MQ

PGMFOLDER ensures that you do not work with the wrong installation in case you omit or incorrectly
specify the TRANSFORMS parameter.

Specifying command line parameters for server installation with msiexec

You can specify either standard msiexec command line parameters preceded by a / character, or
property=value pairs, or a combination of both.

About this task

The msiexec command can accept the following types of parameter on the command line:
Standard command line parameters, preceded by a / character
For more information about the msiexec command line parameters, see the MSDN Command-Line
Options web page.
For an unattended installation, you must include the /q or /qn parameter in the command line.
Without this parameter, the installation is interactive.
Note: You must include the /i parameter and the file location of the IBM MQ installer package.
Property=value pair parameters entered on the command line
All the parameters that are available for use in a response file can also be used on the command line.
For more information about these parameters, see Table 25 on page 190 in “Creating and using a
response file for server installation” on page 189.
There are some extra property=value pair parameters, shown in the following table, that are only for
use on the command line:

Table 23. Parameters that can be used on the command line only (msiexec property=value
parameters)
Property Values Meaning
USEINI path \ file_name Use the specified response file. See “Creating
and using a response file for server installation”
on page 189
SAVEINI path \ file_name Generate a response file during installation. The
file contains those parameters selected for this
installation that a user might make during an
interactive installation.
ONLYINI 1|yes| "" 1, yes or any value other than null. End the
installation before updating the target system,
but after generating a response file, if this is
specified.
"". Continue the installation and update the
target system (the default).

TRANSFORMS :InstanceId x.mst| path \ The :InstanceId x.mst value is only required for
file_name | a subsequent installation of IBM MQ. The path
:InstanceId x.mst; path \ \ file_name specifies what transform (.mst) files
file_name must be applied to the product. For example,
"1033.mst" specifies the supplied U.S. English
transform file.
MSINEWINSTAN 1 This property is only required for subsequent
CE installations of IBM MQ

When using the property=value pair parameters note that:

• Property strings must be in uppercase.

Installing and uninstalling IBM MQ 187

 • Value strings are not case-sensitive, except for feature names. You can enclose value strings in double
quotation marks. If a value string includes a blank, enclose the blank value string in double quotation
marks.
• For a property that can take more than one value, use the format:

ADDLOCAL="Server,Client"

• For properties taking paths and file names, for example, PGMFOLDER, you must supply the paths as
absolute paths and not relative paths; that is as C:\folder\file and not ".\folder\file".
When using property=value pair and command line parameters with the msiexec command, enter
command line parameters first.
If a parameter is specified both on the command line and in a response file, the setting on the command
line takes precedence.

Procedure
• For a single installation of IBM MQ, specify the msiexec command as shown in the following typical
example.
All parameters, separated by one or more spaces, must be typed on the same line as the msiexec
call.

msiexec
/i "path\MSI\IBM MQ.msi"
/l*v c:\install.log
/q
TRANSFORMS="1033.mst"
AGREETOLICENSE="yes"
ADDLOCAL="Server"

• If you are installing a second copy of IBM MQ, specify the msiexec command as shown in the
following typical example.
All parameters, separated by one or more spaces, must be typed on the same line as the msiexec
call.

msiexec
/i "path\MSI\IBM MQ.msi"
/l*v c:\install.log
/q
TRANSFORMS=":InstanceId2.mst;1033.mst"
AGREETOLICENSE="yes"
ADDLOCAL="Server"
MSINEWINSTANCE=1

where /l*v c:\install.log writes installation log to file c:\install.log.

Using transforms with msiexec for server installation

MSI can use transforms to modify an installation. During IBM MQ installation, transforms can be used to
support different national languages.

About this task

IBM MQ is supplied with transform files in the \MSI folder of the Server image. These files are also
embedded in the IBM MQ Windows installer package, IBM MQ.msi.
Table 24 on page 189 shows the locale identifier, language, and the transform file name to use in the
msiexec command line.

188 Installing IBM MQ

Table 24. Supplied transform files for various language support
Language Transform File name Value
U.S. English 1033.mst 1033
German 1031.mst 1031
French 1036.mst 1036
Spanish 1034.mst 1034
Italian 1040.mst 1040
Brazilian Portuguese 1046.mst 1046
Japanese 1041.mst 1041
Korean 1042.mst 1042
Simplified Chinese 2052.mst 2052
Traditional Chinese 1028.mst 1028
Czech 1029.mst 1029
Russian 1049.mst 1049
Hungarian 1038.mst 1038
Polish 1045.mst 1045

You can also specify the required language by using the MQLANGUAGE property with the MQParms
command. For information about the msiexec property=value parameters, see “MQParms parameter file -
server installation” on page 195.

Procedure
On the msiexec command line, specify the required language by using the TRANSFORMS property in a
property=value pair as shown in the following example:

TRANSFORMS="1033.mst"

The quotation marks surrounding the value are optional.

You can also specify the full path and file name of the transform file. Again, the quotation marks
surrounding the value are optional. For example:

TRANSFORMS="D:\Msi\1033.mst"

You might need to merge transforms to install multiple installations of the same version, for example:

TRANSFORMS=":InstanceId2.mst;D:\Msi\1033.mst"

Creating and using a response file for server installation

You can use the msiexec command with a parameter that specifies additional properties that are defined
in a response file. There are three ways of creating a response file for a server installation.

About this task

A response file is an ASCII text file with a format like a Windows .ini file, that contains the stanza
[Response]. The [Response] stanza contains some or all the parameters that would normally be specified

Installing and uninstalling IBM MQ 189

 as part of an interactive installation. The parameters are given in a property=value pair format. Any other
stanzas in the response file are ignored by msiexec.
An example response file, Response.ini, is supplied with IBM MQ. It contains the default installation
parameters.
You can combine the use of a response file with msiexec command-line parameters described in
“Specifying command line parameters for server installation with msiexec” on page 187.
Table 25 on page 190 shows the parameters that are available for use in a response file. These
parameters can also be used on the command line. If a parameter is specified both on the command
line and in a response file, the setting on the command line takes precedence.

Table 25. Parameters that can be used in a response file

Property Values Meaning
PGMFOLDER“1” on page 193 path Folder for the IBM MQ program files. For
example, c:\mqm.
DATFOLDER path Folder for the IBM MQ data files. For example,
c:\mqm\data.
Note: Multiple installations of IBM MQ all use
the same DATFOLDER.

LOGFOLDER path Folder for the IBM MQ queue manager log files.
For example, c:\mqm\log.
Note: Multiple installations of IBM MQ all use
the same LOGFOLDER.

USERCHOICE 0|no If the command line or response file specifies

parameters to install features, a dialog can be
displayed to prompt the user to accept the
preselected options, or review and possibly
change them.
0 or no. Suppresses display of the dialog.
Anything else. Dialog is displayed.
Not used for a silent installation.

AGREETOLICENSE “2” on yes Accept the terms of the license. Set to yes
page 193 before a silent installation.
If the installation is not silent, this parameter is
ignored.

KEEPQMDATA keep |delete If the Server feature is to be uninstalled,

whether to delete any existing queue managers.
delete removes any existing queue managers.
keep, or any other value, keeps them.
Note: This property is only valid on a final
server uninstallation. Otherwise this property is
ignored.

190 Installing IBM MQ

Table 25. Parameters that can be used in a response file (continued)
Property Values Meaning
LAUNCHWIZ 0|1|yes|no| "" 0 or no. Do not launch the Prepare IBM MQ
Wizard after IBM MQ is installed.
1 or yes. Launch the Prepare IBM MQ Wizard if
the Server feature is installed.
"". Launch the Prepare IBM MQ Wizard to install
the Server (the default).
If this option is to launch the Prepare IBM
MQ Wizard, you can specify the WIZPARMFILE,
either in this file, or on the command line.
The Prepare IBM MQ Wizard must be run to
make your IBM MQ installation operational. If
you choose not to launch it here, you must run it
before using IBM MQ.

WIZPARMFILE path \ file_name When specified, the file that contains the
parameters to pass to the Prepare IBM MQ
Wizard when it is launched. These are in the
[Services].
ADDLOCAL feature, feature, All| "" A comma-separated list of features to install
locally. For a list of valid feature names, see
“IBM MQ features for Windows systems” on
page 163.
All installs all features
"" installs the typical features. If you do not want
a feature use REMOVE="feature"
Note: If this is a new installation, the typical
features “3” on page 193 are installed by default
irrespective of the feature list provided in the
ADDLOCAL property. If you do not want a
feature, use REMOVE="feature" to specify that
feature.

REMOVE feature, feature, |All| "" A comma-separated list of features to remove.

For a list of valid feature names, see “IBM MQ
features for Windows systems” on page 163. “4”
on page 193

All uninstalls all features

"" uninstalls no features (the default).

Installing and uninstalling IBM MQ 191

 Table 25. Parameters that can be used in a response file (continued)
Property Values Meaning
STARTSERVICE 0|no| "" 0 or no. Do not start the IBM MQ Service at the
end of installation.
"" (the default). Start the IBM MQ Service at the
end of installation if it was running at the start,
or if this is a new installation.
Anything else. Start the Service at the end of the
installation.
Ignored if the server feature is not installed.
If you do not start the IBM MQ Service, IBM
MQ will not be operational and queue managers
will not start. You must run the Prepare IBM MQ
Wizard for the service to be correctly configured.
This parameter is only valid if LAUNCHWIZ is set
to no.

STARTTASKBAR 0|no| "" 0 or no. Do not start the IBM MQ taskbar

application at the end of installation.
"" (the default). Start the IBM MQ taskbar
application at the end of installation if it
was running at the start, or if this is a new
installation.
Anything else. Start the taskbar application at
the end of the installation.
Ignored if the server feature is not installed.
This parameter is only valid if LAUNCHWIZ is set
to no.

INSTALLATIONDESC "Description of Sets the installation description from the

installation" command line. Subject to the documented
installation description length limitations
INSTALLATIONNAME “1” [INSTALLATION0,]Name Sets the installation name from the command
on page 193 line. Subject to the documented installation
name character and length limitations.
Note: Supply INSTALLATION0,Name only when
upgrading from versions of the product before
IBM WebSphere MQ 7.1.

MAKEPRIMARY 0|1| "" Makes the installation primary, if possible, or

removes the primary flag. 1 = Make primary, 0
= Make non-primary, - use default algorithm
Note: This option is ignored if a version of
the product before IBM WebSphere MQ 7.1
is installed, or if another installation of IBM
WebSphere MQ 7.1, or later, is present and set
as the primary.

Notes:

192 Installing IBM MQ

1. For multiple installations, the INSTALLATIONNAME or PGMFOLDER must be supplied as an additional
parameter on any non-interactive installation command. Supplying the INSTALLATIONNAME or
PGMFOLDER ensures that you do not work with the wrong installation in case you omit or incorrectly
specify the TRANSFORMS parameter.
2. For a silent installation to succeed, the AGREETOLICENSE="yes" property must be defined either on
the command line or in the response file.
3. For a new installation, the typical features that are installed by default, irrespective of the feature list
provided in the ADDLOCAL property, include the following features. If they are NOT required, they must
be added to the REMOVE list.
• Server
• MQ Explorer
• Extended Messaging APIs (was Java and .NET Messaging and Web Services before IBM MQ 9.1.0)
• Web Administration
• Development Toolkit
• Java Runtime Environment
4. When specifying which features to remove with the REMOVE parameter:
• If you want to silently uninstall the Server feature, and the Web Administration (Web) feature
is installed, you must also silently uninstall the Web feature at the same time by specifying
REMOVE="Web,Server".
• If you want to silently uninstall the Java Runtime Environment (JRE) feature, and the Web
Administration (Web) feature is installed, you must also silently uninstall the Web feature at the
same time by specifying REMOVE="Web,JRE".

Procedure
1. Create a response file for installation in one of the following ways:
• Copy and edit the file Response.ini that is supplied in the IBM MQ Windows Server install image,
using an ASCII file editor.
• Create your own response file using an ASCII file editor.
• Use the msiexec command with the SAVEINI (and optionally, the ONLYINI) command line
parameters to generate a response file that contains the same installation options as shown in
the following example:

msiexec /i "path\IBM MQ.msi" /q SAVEINI="response_file"

TRANSFORMS="1033.mst" AGREETOLICENSE="yes"

2. To run the msiexec command with a response file, specify the full path and file name of the response
file with the USEINI parameter as shown in the following example:

msiexec /i "path\MSI\IBM
MQ.msi" /l*v c:\install.log TRANSFORMS= "1033.mst" USEINI= "C:\MQ\Responsefile"

In the response file, all text is in English, and comments begin with a ; character.

Example
The following example shows a typical response file:

[Response]
PGMFOLDER="c:\mqm"
DATFOLDER="c:\mqm\data"
LOGFOLDER="c:\mqm\log"
AGREETOLICENSE="yes"
LAUNCHWIZ=""
WIZPARMFILE="d:\MQParms.ini"

Installing and uninstalling IBM MQ 193

 ADDLOCAL="Server,Client"
REMOVE="Toolkit"

Installing the server using the MQParms command

You can use the MQParms command to invoke installation or uninstallation of the IBM MQ server.

Before you begin

The MQParms command can use parameters on a command line, or those specified in a parameter file.
The parameter file is an ASCII text file that contains the parameter values that you want to set for the
installation. The MQParms command takes the specified parameters and generates the corresponding
msiexec command line.
This means that you can save all the parameters that you want to use with the msiexec command in a
single file.
If you are running IBM MQ on Windows systems with User Account Control (UAC) enabled, you must
invoke the installation with elevated privileges. If you are using the Command prompt or IBM MQ Explorer
elevate privileges by using a right-click to start the program and selecting Run as administrator. If you
try to run the MQParms program without using elevated privileges, the installation fails with an error of
AMQ4353 in the installation log.
For silent operations, this must include the /q or /qn parameter, either on the command line, or in the
[MSI] stanza of the parameter file. You must also set the AGREETOLICENSE parameter to "yes".
You can specify many more parameters in the parameter file that you use with the MQParms command
than you can in the response file that you use directly with the msiexec command. Also, as well as
parameters that the IBM MQ installation uses, you can specify parameters that can be used by the
Prepare IBM MQ Wizard.
If you do not complete the Prepare IBM MQ Wizard directly after IBM MQ installations or if for any reason
your machine is rebooted between completing IBM MQ installation and completing the Prepare IBM MQ
Wizard, ensure that the wizard is run with Administrator privilege afterward, otherwise the installation
is incomplete, and might fail. You might also see Open File - Security Warning dialog boxes that list
International Business Machines Limited as the publisher. Click Run to allow the wizard to continue
An example of the file MQParms.ini is supplied with IBM MQ. This file contains default installation
parameters.
There are two ways to create a parameter file for installation:
• Copy and edit the file MQParms.ini that is supplied with the product, using an ASCII file editor.
• Create your own parameter file using an ASCII file editor.

About this task

To invoke installation using the MQParms command:

Procedure
1. From a command line, change to the root folder of the IBM MQ Server install image (that is, the
location of the file MQParms.exe).
2. Enter the following command:

MQParms parameter_file parameters ]

where:
parameter_file
is the file that contains the required parameter values. If this file is not in the same folder as
MQParms.exe, specify the full path and file name. If you do not specify a parameter file, the default

194 Installing IBM MQ

 is MQParms.ini. For silent installation, the MQParms_silent.ini parameter file can be used.
For further details, see “MQParms parameter file - server installation” on page 195.
parameters
are one or more command-line parameters, for a list of these, see the MSDN Command-Line
Options web page.

Example
A typical example of an MQParms command is:

MQParms "c:\MyParamsFile.ini" /l*v c:\install.log

A typical example of an MQParms command when you are installing a second copy of IBM MQ is:

MQParms "c:\MyParamsFile.ini" /l*v c:\install.log TRANSFORMS=":InstanceId2.mst;1033.mst"

MSINEWINSTANCE=1

Alternatively, TRANSFORMS and MSINEWINSTANCE can be specified in the MSI stanza of the parameter
file.
If you specify a parameter both on the command line and in the parameter file, the setting on the
command line takes precedence.
If you specify a parameter file, you might want to run the encryption utility before you use the MQParms
command (see “Encrypting a parameter file” on page 198 ).
If you do not specify /i, /x, /a, or /j, MQParms defaults to standard installation using the IBM MQ
Windows Installer package, IBM MQ.msi. That is, it generates the following part of the command line:

/i " current_folder \MSI\IBM MQ.msi"

If you do not specify a WIZPARMFILE parameter, MQParms defaults to the current parameter file. That is,
it generates the following part of the command:

WIZPARMFILE=" current_folder \ current_parameter_file "

MQParms parameter file - server installation

A parameter file is an ASCII text file that contains sections (stanzas) with parameters that can be used by
the MQParms command. Typically, this is an initialization file such as MQParms.ini.
The MQParms command takes parameters from the following stanzas in the file:
[MSI]
Contains general properties related to how the MQParms command runs and to the installation of IBM
MQ.
The properties that you can set in this stanza are listed in “Installing the server using msiexec” on
page 185, and Table 26 on page 196.
[Services]
Contains properties related to IBM MQ account configuration, in particular, the user account required
for IBM MQ Services. If you are installing IBM MQ on a network where the domain controller is on
a Windows 2003 or later server, you probably need details of a special domain account. For more
information, see “Configuring IBM MQ with the Prepare IBM MQ Wizard” on page 200 and “Creating
and setting up Windows domain accounts for IBM MQ” on page 204.
The properties that you can set in this stanza are listed in Table 28 on page 197.
MQParms ignores any other stanzas in the file.

Installing and uninstalling IBM MQ 195

 The stanza parameters are in the form property=value, where property is always interpreted as
uppercase, but value is case sensitive. If a value string includes a blank, it must be enclosed in double
quotation marks. Most other values can be enclosed in double quotation marks. Some properties can take
more than one value, for example:

ADDLOCAL="Server,Client"

To clear a property, set its value to an empty string, for example:

REINSTALL=""

The following tables show the properties that you can set. The default is shown in bold.
For the [MSI] stanza, you can enter standard MSI command line options and properties. For example:

- /q
- ADDLOCAL="server"
- REBOOT=Suppress

Refer to Table 26 on page 196, Table 27 on page 197, and Table 28 on page 197 for the properties used
to install IBM MQ.
Table 26 on page 196 shows additional properties in the stanza that affect how the MQParms command
runs, but that do not affect the installation.

Table 26. Properties used by MQParms in the MSI stanza

Property Values Description
MQPLOG path | file_name MQParms generates a text log file with the
specified name and location.
MQPLANGUAGE The installation language.
system |user|
transform_value |existing system. Install using the language of the
default system locale (the default).
user. Install using the language of the default
locale of the user.
transform_value. Install using the language
specified by this value. See Table 27 on page
197.
existing. If IBM MQ already exists on the
system, the same language will be used by
default, otherwise system is used.

MQPSMS 0 |no 0 or no. MQParms does not wait for the

msiexec command to end (the default).
Any other value. MQParms waits for the
msiexec command to end.

MQPINUSE 0 |1 If MQPINUSE is set to 1, MQParms continues

installing even if IBM MQ files are in use. If
this option is used a reboot will be required to
complete the installation.

196 Installing IBM MQ

Table 27. Valid values for the MQPLANGUAGE property
Language Valid values
U.S. English English en_us 1033
German German de_de 1031
French French fr_fr 1036
Spanish Spanish es_es 1034
Italian Italian it_it 1040
Brazilian Portuguese Brazilian Portuguese pt_br 1046
Japanese Japanese ja_jp 1041
Korean Korean ko_kr 1042
Simplified Chinese Simplified Chinese zh_cn 2052
Traditional Chinese Traditional Chinese zh_tw 1028
Czech Czech cs_cz 1029
Russian Russian ru_ru 1049
Hungarian Hungarian hu_hu 1038
Polish Polish pl_pl 1045

For the [Services] stanza, you can enter parameters in property=value format. You might want to encrypt
the values in this stanza. See “Encrypting a parameter file” on page 198.

Table 28. Properties used in the Services stanza

Property Values Description
USERTYPE local | domain | The type of user account to use:
onlydomain local
Creates a local user account.
domain
Creates a local user account. If this
does not have the required security
authorities, it uses the domain user
account specified by DOMAINNAME,
USERNAME, and PASSWORD.
onlydomain
Does not create a local user account,
but immediately uses the domain user
account specified by DOMAINNAME,
USERNAME and PASSWORD. If any of
these three properties are missing, a
USERTYPE of local is assumed.
The properties DOMAINNAME, USERNAME,
and PASSWORD are required if USERTYPE is
set to onlydomain.

DOMAINNAME domain_name 1 The domain for the domain user account.

Required if USERTYPE is set to domain or
onlydomain.

Installing and uninstalling IBM MQ 197

 Table 28. Properties used in the Services stanza (continued)
Property Values Description
USERNAME user_name 1 The user name for the domain user account.
Required if USERTYPE is set to domain or
onlydomain..

PASSWORD password 1 The password for the domain user account.

Required if USERTYPE is set to domain or
onlydomain.

1. Do not enclose this value in double quotation marks.

A typical example of a parameter file is:

[MSI]
MQPLANGUAGE=1033
MQPLOG=%temp%\MQParms.log
MQPSMS=no
ADDLOCAL=Server
/m miffile
REMOVE=""
/l*v c:\install.log

[Services]
USERTYPE=domain
DOMAINNAME=mqm*df349edfcab12
USERNAME=mqm*a087ed4b9e9c
PASSWORD=mqm*d7eba3463bd0a3

Encrypting a parameter file

If the DOMAINNAME, USERNAME, and PASSWORD values in the [Services] stanza of a parameter file are
not already encrypted, you can encrypt them by running the setmqipw utility.

About this task

Use the setmqipw utility to encrypt the DOMAINNAME, USERNAME, and PASSWORD values in the
[Services] stanza of a parameter file, if they are not already encrypted. (These values might be
encrypted if you have run the utility before.) setmqipw will also encrypt the QMGRPASSWORD and
CLIENTPASSWORD values in the [SSLMigration] stanza of a parameter file.
This encryption means that, if you need a special domain account to configure IBM MQ (see “Configuring
IBM MQ with the Prepare IBM MQ Wizard” on page 200 and “Creating and setting up Windows domain
accounts for IBM MQ” on page 204), or you need to keep key database passwords secret, details are
kept secure. Otherwise, these values, including the domain account password, flow across the network as
clear text. You do not have to use this utility, but it is useful if security in your network is an issue.
To run the script:

Procedure
1. From a command line, change to the folder that contains your parameter file.
2. Enter the following command:

CD_drive:\setmqipw

198 Installing IBM MQ

 Note: You can run the command from a different folder, by entering the following command, where
parameter_file is the full path and file name of the parameter file:

CD_drive:\setmqipw parameter_file

Results
If you view the resulting parameter file, the encrypted values start with the string mqm*. Do not use this
prefix for any other values; passwords or names that begin with this prefix are not supported.
The utility creates a log file, setmqipw.log, in the current directory. This file contains messages related
to the encryption process. When encryption is successful, messages are similar to:

Encryption complete
Configuration file closed
Processing complete

What to do next
After you encrypt the parameter file, you can use it in the normal way with the MQParms command (see
“Installing the server using the MQParms command” on page 194 ).

Checking for problems after installing

There are some optional tasks that you can use to check the installation if you believe there was a
problem, or to verify installation messages after an unattended (silent) installation for example.

About this task

Use these steps as a guide to check the following files for messages:

Procedure
1. Check MSI nnnnn.LOG. This file is in your user Temp folder. It is an application log that contains
English messages written during installation. The log includes a message indicating whether the
installation was successful and complete.
This file is created if you have set up default logging.
2. If you used the launchpad to install IBM MQ, check MQv9_Install_YYYY-MM-DDTHH-MM-SS.log in
your user Temp folder, where:
YYYY
This is the year that you installed IBM MQ
MM
This is the month that you installed IBM MQ, for example this would be 09 if you installed in
September
DD
This is the day that you installed IBM MQ
HH-MM-SS
This is the time at which IBM MQ was installed
You can get to your user Temp directory by entering the following command at the command prompt:

cd %TEMP%

Installing and uninstalling IBM MQ 199

 3. Check amqmjpse.txt. This file is in the IBM MQ data files folder (default
C:\ProgramData\IBM\MQ ). It is an application log that contains English messages written during
installation by the Prepare IBM MQ Wizard.

What to do next
Verify your installation, as described in “Verifying an IBM MQ installation on Windows” on page 226.

Configuring user accounts for IBM MQ

After installing IBM MQ server, you must configure the IBM MQ service before you can start any queue
managers.

About this task

When you install IBM MQ using the graphical user interface, you are guided through several screens
that help you to apply the relevant options and settings. You use the Launchpad to check software
requirements, specify network information, and then start the IBM MQ installation wizard and use it to
install the software.
After the installation of IBM MQ completes, you can use the Prepare IBM MQ Wizard to configure IBM MQ
before starting any queue managers.
If you are setting up IBM MQ for use with the Microsoft Cluster Service (MSCS), see Supporting the
Microsoft Cluster Service (MSCS).

Configuring IBM MQ with the Prepare IBM MQ Wizard

The Prepare IBM MQ Wizard helps you to configure IBM MQ with a user account for your network. You
must run the wizard to configure the IBM MQ Service before you can start any queue managers.

Before you begin

When IBM MQ is running, it must check that only authorized users can access queue managers or queues.
Whenever any user attempts such access, IBM MQ uses its own local account to query information about
the user.
Most networked Windows systems are members of a Windows domain where user accounts, other
security principals, and security groups are maintained and managed by a directory service, Active
Directory, running on a number of domain controllers. IBM MQ checks that only authorized users can
access queue managers or queues.
In such networks, IBM MQ queue manager processes access the Active Directory information to find the
security group membership of any users attempting to use IBM MQ resources. The accounts under which
IBM MQ services run must be authorized to look up such information from the directory. In most Windows
domains, local accounts defined at individual Windows servers cannot access directory information, so
the IBM MQ services must run under a domain account that has the appropriate permission.
If the Windows server is not a member of a Windows domain or the domain has a reduced security
or functional level, then the IBM MQ services can run under a local account that was created during
installation.
If a special domain account is needed for your installation of IBM MQ, the Prepare IBM MQ Wizard asks
you to enter details of this account (domain, user name, and password), so make sure that you have
this information available before you start this task. Ask your domain administrator to set up an account,
if one does not already exist, and provide you with the necessary details. For more information about
configuring a domain account, see “Creating and setting up Windows domain accounts for IBM MQ” on
page 204.
Important: If a domain account is needed and you install IBM MQ without a special account (or without
entering its details), many or all parts of IBM MQ will not work, depending on the particular user accounts
involved. Also, IBM MQ connections to queue managers that run under domain accounts on other systems

200 Installing IBM MQ

 might fail. The account can be changed by running the Prepare IBM MQ Wizard and specifying the details
of the account to be used.
For information about the user rights required to take advantage of the Active Directory support, see Local
and domain user accounts for the IBM MQ Windows service.
For information about the user rights required to take advantage of the Kerberos authentication support,
see Securing.

About this task

The Prepare IBM MQ Wizard window is displayed when the IBM MQ installation completes. You can also
run the wizard at any time from the Start menu.
You can use the Prepare IBM MQ Wizard (AMQMJPSE.EXE) with the following parameters:

Table 29. Startup parameters that can be used for the Prepare IBM MQ Wizard
Parameter Parameter Default action if parameter not
Name description How parameter is used supplied
-l file Create log file The Prepare IBM MQ Wizard appends Append to log file amqmjpse.txt
to a log file with the program actions in IBM MQ Data directory.
and results.
This parameter specifies the file name
to use for this log. If the path is not
provided, the IBM MQ Data directory
is assumed. If the file name is not
provided, amqmjpse.txt is assumed.

-r Reset When the Prepare IBM MQ Wizard User account not reset.
MQSeriesService is first run it creates a local
user account user account MUSR_MQADMIN, with
specific settings and permissions.
The MQSeriesService component is
configured to run under this account.
Depending on the LAN configuration,
the wizard might reconfigure the
MQSeriesService component to run
under a domain user account instead.
When this parameter is specified, the
local user account MUSR_MQADMIN is
re-created with all the default settings
and permissions. The MQSeriesService
component is configured to run under
this account.

-s silent installation Process silently. Nothing is displayed Not silent mode.

mode and there is no user input.
-p file User parameters Load and use parameters from the When in silent mode, the
from file parameter file. If the path is not parameter file AMQMJPSE.INI
provided, the IBM MQ Data directory is loaded from IBM MQ Data
is assumed. If the file name is not directory.
provided, AMQMJPSE.INI is assumed.
When not in silent mode, a
The following stanzas are loaded: parameter file is not used.

[Services]
[SSLMigration]

Installing and uninstalling IBM MQ 201

Table 29. Startup parameters that can be used for the Prepare IBM MQ Wizard (continued)
Parameter Parameter Default action if parameter not
Name description How parameter is used supplied
-m file Generate a When the Prepare IBM MQ Wizard .MIF file not created.
Microsoft System closes, generate a status .MIF file
Management Server with the specified name. If the path
(SMS) status .MIF is not provided, the Data directory
file. is assumed. If the file name is not
provided, AMQMJPSE.MIF is assumed.
The file ISMIF32.DLL (installed as part
of SMS) must be in the path.
The InstallStatus field in the file will
contain either Success or Failed.

On Windows systems, you must carry out this task under a Windows administrator account, or domain
administrator account in case your workstation is a member of a Windows domain.
On Windows systems with User Account Control (UAC) enabled, if you do not complete the Prepare IBM
MQ Wizard directly after IBM MQ is installed, or if for any reason your machine is rebooted between
completing IBM MQ installation and completing the Prepare IBM MQ Wizard, you must accept the
Windows prompt when it appears to allow the wizard to run as elevated.

Procedure
1. When the IBM MQ installation completes, the Prepare IBM MQ Wizard window is displayed with a
welcome message.
To continue, click Next.
2. If you have run the Prepare IBM MQ Wizard before, this step is skipped. Otherwise, the Prepare IBM
MQ Wizard window displays a progress bar with the following message:
Status: Setting up IBM MQ Configuration

Wait until the progress bar completes.

3. The Prepare IBM MQ Wizard window displays a progress bar with the following message:
Status: Setting up the IBM MQ Service.

Wait until the progress bar completes.

4. IBM MQ attempts to detect whether you must configure IBM MQ for use with Windows Active
Directory Server or Windows domain users. Depending on the results of the detection, IBM MQ does
one of the following things:
• If IBM MQ detects that you need to configure IBM MQ for Windows Active Directory Server or
Windows domain users, the Prepare IBM MQ Wizard window displays a message that starts:

IBM MQ does not have the authority to query information about

your user account

Click Next, and go to step 5.

• If you are not installing on a Windows Active Directory Server or Windows domain server and IBM
MQ cannot detect whether you need to configure IBM MQ for Windows Active Directory Server or
Windows domain users, the Prepare IBM MQ Wizard window displays the following message:

Are any of the domain controllers in your network running

Windows 2000 or later domain server?

If you select Yes, click Next, then go to step 5.

If you select No, click Next, then go to step 9.

202 Installing IBM MQ

 If you select Don't know, you cannot continue. Select one of the other options, or click Cancel and
contact your domain administrator.
• If IBM MQ detects that you do not need to configure IBM MQ for Windows Active Directory Server
or Windows domain users, go to step 9.
5. The Prepare IBM MQ Wizard window displays the following message:
Do you need to configure IBM MQ for users defined on Windows 2000
or later domain controllers?

If you select Yes, click Next, then go to step 6.

If you select No, click Next, then go to step 9.
If you select Don't know, you cannot continue. Select one of the other options, or click Cancel and
contact your domain administrator. For more information about domain accounts, see “Creating and
setting up Windows domain accounts for IBM MQ” on page 204.
6. Give the domain user that you obtained from your domain administrator the access to run as a
service.
a) Click Start > Run..., type the command secpol.msc and click OK.
b) Open Security Settings > Local Policies > User Rights Assignments. In the list of policies,
right-click Log on as a service > Properties.
c) Click Add User or Group... and type the name of the user you obtained from your domain
administrator, then click Check Names
d) If prompted by a Windows Security window, type the user name and password of an account user
or administrator with sufficient authority, and click OK > Apply > OK. Close the Local Security
Policy window.
7. In the next window, enter the Domain and user ID of the domain user account that you obtained
from your domain administrator. Either enter the Password for this account, or select the option This
account does not have a password. Click Next.
8. The Prepare IBM MQ Wizard window displays a progress bar with the following message:
Status: Configuring IBM MQ with the special domain user account

Wait until the progress bar completes. If there are any problems with the domain user account,
a further window is displayed. Follow the advice on this window before you continue with this
procedure.
9. The Prepare IBM MQ Wizard window displays a progress bar with the following message:

Status: Starting IBM MQ services

Wait until the progress bar completes.

10. Next, select the options that you require.
The Prepare IBM MQ Wizard window displays the following message:

You have completed the Prepare IBM MQ Wizard

Select the options that you require, then click Finish. Select one or more from the following list:
• Remove the shortcut to this wizard from the desktop
This option is available only if you have previously attempted installation, but you canceled the
procedure from thePrepare IBM MQ Wizard and you created a desktop shortcut to this wizard.
Select this option to remove the shortcut. You do not need it now that you have completed the
Prepare IBM MQ Wizard.
• Launch IBM MQ Explorer
The IBM MQ Explorer allows you to view and administer your IBM MQ network. You can use the
items in the Welcome to IBM MQ Explorer Content view page to explore the facilities in IBM MQ.
This page is launched the first time that the IBM MQ Explorer is launched. The Welcome page can
be viewed at any time from the IBM MQ Explorer by clicking IBM MQ in the Navigator view.

Installing and uninstalling IBM MQ 203

 • Launch Notepad to view the release notes
The release notes contain information about installing IBM MQ and also late-breaking news that is
available after the published documentation is produced.

What to do next
Optionally, follow the procedure described in Checking for problems after installing.
For information on how to verify an installation, see Verifying an IBM MQ installation on Windows.
Related concepts
User rights required for an IBM MQ Windows Service
Related tasks
Creating and setting up Windows domain accounts for IBM MQ
This information is for Domain Administrators. Use this information to create and set up a special domain
account for the IBM MQ service. Do this if IBM MQ is to be installed on a Windows domain where local
accounts do not have the authority to query the group membership of the domain user accounts.

Creating and setting up Windows domain accounts for IBM MQ

This information is for Domain Administrators. Use this information to create and set up a special domain
account for the IBM MQ service. Do this if IBM MQ is to be installed on a Windows domain where local
accounts do not have the authority to query the group membership of the domain user accounts.

About this task

After you add a local user to the mqm group, that user can administer IBM MQ on the system. This task
describes how to do the same using Windows domain user IDs.
There is an IBM MQ component for checking Windows privileges. This component runs as a Windows
service under a local user account created by IBM MQ at installation. This component checks that the
account under which the IBM MQ services are run has the following privileges:
• The account has the ability to query group memberships of domain accounts.
• The account has the authority to administer IBM MQ.
If the account does not have the ability to query group memberships, the access checks made by the
services fail.
Windows domain controllers running Windows Active Directory can be set up so that local accounts do
not have the authority to query the group membership of the domain user accounts. This prevents IBM
MQ from completing its checks, and access fails. If you are using Windows on a domain controller that
has been set up in this way, you must instead use a special domain user account with the required
permissions.
Each installation of IBM MQ on the network must be configured to run its service under a domain
user account that has the required authority to check that users who are defined on the domains
are authorized to access queue managers or queues. Typically, this special account has the IBM MQ
administrator rights through membership of the domain group DOMAIN\Domain mqm. The domain group
is automatically nested by the installation program under the local mqm group of the system on which IBM
MQ is being installed.
Important:
1. By default, Windows 10 version 1607 or later, and Windows Server 2016 or later, are more restrictive
than earlier versions of Windows. These later versions restrict clients allowed to make remote calls
to the Security Accounts Manager (SAM), and could prevent IBM MQ queue managers from starting.
Access to SAM is critical for the functioning of IBM MQ when IBM MQ is configured as a domain
account.
2. The IBM MQ installer must be given the user ID and password details of the special domain user
account. The installer can then use this information to configure the IBM MQ service after the product

204 Installing IBM MQ

 is installed. If an installer continues and configures IBM MQ without a special account, many or all
parts of IBM MQ will not work, depending upon the particular user accounts involved, as follows:
• IBM MQ connections to queue managers running under Windows domain accounts on other
computers might fail.
• Typical errors include AMQ8066: Local mqm group not found and AMQ8079: Access was
denied when attempting to retrieve group membership information for user
'abc@xyz'.
You must repeat steps “1” on page 205 and “8” on page 206 of the following procedure for each domain
that has user names that will administer IBM MQ. This creates an account for IBM MQ on each domain.

Procedure
Create a domain group with a special name that is known to IBM MQ (see “4” on page 205) and give
members of this group the authority to query the group membership of any account.
1. Log on to the domain controller as an account with domain administrator authority.
2. From the Start menu, open Active Directory Users and Computers.
3. Find the domain name in the navigation pane, right-click it and select New Group.
4. Type a group name into the Group name field.
Note: The preferred group name is Domain mqm. Type it exactly as shown.
• Calling the group Domain mqm modifies the behavior of the Prepare IBM MQ Wizard on a domain
workstation or server. It causes the Prepare IBM MQ Wizard automatically to add the group Domain
mqm to the local mqm group on each new installation of IBM MQ in the domain.
• You can install workstations or servers in a domain with no Domain mqm global group. If you do
so, you must define a group with the same properties as Domain mqm group. You must make that
group, or the users that are members of it, members of the local mqm group wherever IBM MQ is
installed in a domain. You can place domain users into multiple groups. Create multiple domain
groups, each group corresponding to a set of installations that you want to manage separately. Split
domain users, according to the installations they manage, into different domain groups. Add each
domain group or groups to the local mqm group of different IBM MQ installations. Only domain users
in the domain groups that are members of a specific local mqm group can create, administer, and run
queue managers for that installation.
• The domain user that you nominate when installing IBM MQ on a workstation or server in a domain
must be a member of the Domain mqm group, or of an alternative group you defined with same
properties as the Domain mqm group.
5. Leave Global clicked as the Group scope, or change it to Universal. Leave Security clicked as the
Group type. Click OK.
6. Follow these steps to assign permissions to the group based on the Windows version of the domain
controller:
On Windows Server 2012, Windows Server 2012 R2, Windows Server 2016, Windows Server 2019,
and Windows Server 2022:
a. In the Server Manager, click Tools then select Active Directory Users and Computers from the
list box.
b. Select View > Advanced Features.
c. Expand your domain name, then click Users.
d. In the Users window, right-click Domain mqm > Properties.
e. On the Security tab, click Advanced > Add....
f. Click Select principle, then type Domain mqm and click Check names > OK.
The Name field is prefilled with the string Domain mqm (domain name\Domain mqm).
g. In the Applies to list, select Descendant User Objects.

Installing and uninstalling IBM MQ 205

 h. In the Permissions list, select the Read group membership and Read groupMembershipSAM
check boxes.
i. Click OK > Apply > OK > OK.
On Windows Server 2008 and Windows 2008 R2:
a. In the Server Manager navigation tree, click Users.
b. In the Server Manager action bar, click View > Advanced features.
c. In the Users window, right-click Domain mqm > Properties.
d. On the Security tab, click Advanced > Add, then type Domain mqm and click Check names > OK.
The Name field is prefilled with the string Domain mqm (domain name\Domain mqm)
e. Click Properties. In the Apply to list, select Descendant User Objects.
f. In the Permissions list, select the Read group membership and Read groupMembershipSAM
check boxes.
g. Click OK > Apply > OK > OK.
Create one or more accounts, and add them to the group.
7. Open Active Directory Users and Computers.
8. Create one or more user accounts with names of your choosing.
In the Server Manager navigation tree, right click Users to create a new user account.
9. Add each new account to the group Domain mqm or a group that is a member of the local mqm group.

Attention: You cannot use a user domain named mqm on Windows.

Create an account for IBM MQ on each domain.

10. Repeat step sections “1” on page 205 and “8” on page 206 for each domain that has user names that
will administer IBM MQ.
Use the accounts to configure each installation of IBM MQ.
11. Either use the same domain user account (as created in Step “1” on page 205 ) for each installation
of IBM MQ, or create a separate account for each one, adding each to the Domain mqm group (or a
group that is a member of the local mqm group).
12. When you have created the account or accounts, give one to each person configuring an installation
of IBM MQ. They must enter the account details (domain name, user name, and password) into the
Prepare IBM MQ Wizard. Give them the account that exists on the same domain as their installing
userid.
13. When you install IBM MQ on any system on the domain, the IBM MQ installation program detects the
existence of the Domain mqm group on the LAN, and automatically adds it to the local mqm group.
(The local mqm group is created during installation; all user accounts in it have authority to manage
IBM MQ ). Thus all members of the " Domain mqm " group will have authority to manage IBM MQ on
this system.
14. However, you do still need to provide a domain user account (as created in Step “1” on page 205 )
for each installation, and configure IBM MQ to use it when making its queries. The account details
must be entered into the Prepare IBM MQ Wizard that runs automatically at the end of installation
(the wizard can also be run at any time from the start menu).
Set the password expiry periods.
15. Choices:
• If you use just one account for all users of IBM MQ, consider making the password of the account
never expire, otherwise all instances of IBM MQ will stop working at the same time when the
password expires.
• If you give each user of IBM MQ their own user account you will have more user accounts to create
and manage, but only one instance of IBM MQ will stop working at a time when the password
expires.

206 Installing IBM MQ

 If you set the password to expire, warn the users that they will see a message from IBM MQ each
time it expires - the message warns that the password has expired, and describes how to reset it.
Use a Windows domain account as the user ID for the IBM MQ service.
16. Click Start > Run....
Type the command secpol.msc then click OK.
17. Open Security Settings > Local Policies > User Rights Assignments.
In the list of policies, right-click Log on as a service > Properties.
18. Click Add User or Group....
Type the name of the user you obtained from your domain administrator, and click Check Names.
19. If prompted by a Windows Security window, type the user name and password of an account user or
administrator with sufficient authority, then click OK > Apply > OK.
Close the Local Security Policy window.
Note: User Account Control (UAC) is enabled by default. The UAC feature restricts the actions users
can perform on certain operating system facilities, even if they are members of the Administrators
group. You must take appropriate steps to overcome this restriction.
Related tasks
Configuring IBM MQ with the Prepare IBM MQ Wizard
The Prepare IBM MQ Wizard helps you to configure IBM MQ with a user account for your network. You
must run the wizard to configure the IBM MQ Service before you can start any queue managers.

Modifying a server installation

You can modify an IBM MQ server installation interactively using the launchpad or non-interactively using
msiexec.
Related tasks
“Modifying a server installation using the Installation Launchpad” on page 207
You can interactively remove or install IBM MQ features on Windows by using IBM MQ Installation
Launchpad.
“Modifying a server installation silently using msiexec” on page 208
You can silently remove or install IBM MQ features on Windows by using msiexec.

Modifying a server installation using the Installation Launchpad

You can interactively remove or install IBM MQ features on Windows by using IBM MQ Installation
Launchpad.

Before you begin

To modify an installation, some features of IBM MQ must already be installed.

About this task

To remove or install IBM MQ features follow the instructions. This procedure is the only way to
interactively remove or install IBM MQ features on Windows Server 2008:

Procedure
1. Insert the IBM MQ for Windows Server DVD into the DVD drive.
2. If autorun is installed, the installation process starts.
Otherwise, double-click the Setup icon in the root folder of the DVD to start the installation process.
The IBM MQ Installation Launchpad window is displayed.
3. Click the IBM MQ Installation option.
4. Click Launch IBM MQ Installer. Wait until the IBM MQ Setup window is displayed with a welcome
message.

Installing and uninstalling IBM MQ 207

 5. If you have multiple installations on your system, you must choose the installation you want to
modify. Do this by selecting the Maintain or upgrade an existing instance option and choosing the
appropriate instance.
If you are upgrading an IBM WebSphere MQ 7.0.1 installation (or earlier) to IBM WebSphere MQ
7.1.0, and you already have an IBM WebSphere MQ 7.1.0 or greater installation, you need to select
Install a new instance. A subsequent panel then allows you to choose the installation you would like
to upgrade.
6. Click Next to continue. The Program Maintenance panel is displayed.
7. Select Modify, then click Next.
The Features panel is displayed.
8. Click the + symbol next to a feature to show any dependent features (subfeatures).
9. To change the installation of a feature:
a) Click the symbol next to the feature name to display a menu.
b) Select the required option from:
• Install this feature
• Install this feature and all its subfeatures (if any)
• Do not install this feature (remove if already installed)
The symbol next to the feature name changes to show the current installation option.
10. Stop the web server before removing the web feature.
If you do not do this, you receive an error message.
11. When your selections are complete, click Next. IBM MQ installation begins.

What to do next
After modifying the installation, you might need to run setmqenv again as described in What to do next in
“Installing IBM MQ server on Windows” on page 182.

Modifying a server installation silently using msiexec

You can silently remove or install IBM MQ features on Windows by using msiexec.

About this task

You can silently modify an installation by using the msiexec command with the ADDLOCAL and REMOVE
parameters.

Procedure
• To silently modify an installation using msiexec, set the ADDLOCAL parameter to include the features
you want to add, and set the REMOVE parameter to the features you want to remove.
For example, if you use ADDLOCAL="JavaMsg" and REMOVE="" it modifies the installation to include
the Extended Messaging and APIs (JavaMsg) feature but does not remove any currently installed
features.

msiexec /i {product code} /q ADDLOCAL="JavaMsg" REMOVE="" INSTALLATIONNAME="Installation1"

where product_code is the value shown for MSIProdCode in the output of the following command:

dspmqinst -n installation_name

An example of a product code is {0730749B-080D-4A2E-B63D-85CF09AE0EF0}.

Important: When specifying which features to remove with the REMOVE parameter:

208 Installing IBM MQ

 – If you want to silently uninstall the Server feature, and the Web Administration (Web) feature
is installed, you must also silently uninstall the Web feature at the same time by specifying
REMOVE="Web,Server".
– If you want to silently uninstall the Java Runtime Environment (JRE) feature, and the Web
Administration (Web) feature is installed, you must also silently uninstall the Web feature at the
same time by specifying REMOVE="Web,JRE".
Related concepts
“IBM MQ features for Windows systems” on page 163
You can select the features that you require when you install IBM MQ.
Related tasks
“Installing the server using msiexec” on page 185
IBM MQ on Windows uses the MSI technology to install software. MSI provides both an interactive
installation and a non interactive installation.
“Uninstalling IBM MQ using msiexec” on page 242
You can uninstall IBM MQ by running the msiexec command from the command line to remove all
currently installed features, or selected features.

Installing an IBM MQ client on Windows

This topic describes how to install IBM MQ client on Windows systems. This procedure can be used for
installing a first or a subsequent installation.

Before you begin

To install an IBM MQ client, you must be logged on to Windows as an administrator.

About this task

Follow these instructions to perform an interactive compact, typical, or custom installation of IBM MQ.
To view all the installation types and the features that are installed with each option consult Features
installed with each type of interactive installation.
Attention: From IBM MQ 9.0, if you are using msiexec to install the client, the installation is
automatically set to be the primary installation.

Procedure
1. Access the IBM MQ installation image.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.
2. Locate setup.exe in the Windows directory of the IBM MQ installation image.
• From the server DVD, this location might be E:\Windows\setup.exe
• From a network location, this location might be m:\instmqs\Windows\setup.exe
• From a local file system directory, this location might be C:\instmqs\Windows\setup.exe
3. Start the installation process.
Either run setup.exe from a command prompt, or double-click setup.exe from Windows Explorer.
Note: If you are installing on a Windows system with UAC enabled, accept the Windows prompt to
allow the launchpad to run as elevated. During installation, you might also see Open File - Security
Warning dialog boxes that list International Business Machines Limited as the publisher. Click Run to
allow the installation to continue.
The IBM MQ Installation window is displayed.
4. Follow the instructions on screen.

Installing and uninstalling IBM MQ 209

 Results
A new sample IBM MQ MQI client configuration file is created in the IBM MQ installation directory (for
example C:\Program Files\IBM\MQ\, by the IBM MQ MQI client package, during installation, but only
if this file does not exist. This file contains the ClientExitPath stanza. An example mqclient.ini file
is shown in Configuring a client using a configuration file.
Note:
If you are using a common configuration file for multiple clients, either in the IBM MQ installation
directory or in another location using the MQCLNTCF environment variable, you must grant read access to
all user identifiers under which the IBM MQ client applications run. If the file cannot be read, the failure is
traced and the search logic continues as if the file had not existed.

What to do next
• If you have chosen this installation to be the primary installation on the system, when using
setup.exe, you must now set it as the primary installation. Enter the following command at the
command prompt:

MQ_INSTALLATION_PATH\bin\setmqinst -i -p MQ_INSTALLATION_PATH

You can have only one primary installation on a system. If there is already a primary installation on the
system, you must unset it before you can set another installation as the primary installation. For more
information, see Changing the primary installation.
• You might want to set up the environment to work with this installation. You can use the setmqenv or
crtmqenv command to set various environment variables for a particular installation of IBM MQ. For
more information, see setmqenv and crtmqenv.
• For instructions on how to verify your installation, see “Testing communication between a client and a
server on Windows” on page 238.
Related concepts
“Modifying a client installation using Add/Remove Programs” on page 222
On some versions of Windows, you can modify an installation by using Add/Remove Programs.
Related tasks
“Installing a client using msiexec” on page 210
IBM MQ on Windows uses the MSI technology to install software. MSI provides both an interactive
installation and a non interactive installation.
“Installing a client using the MQParms command” on page 218
You can use the MQParms command to invoke installation or uninstallation of an IBM MQ client.
“Uninstalling IBM MQ on Windows” on page 239
You can uninstall the IBM MQ MQI clients and servers on Windows systems by using the control panel,
the command line ( msiexec ), MQParms, or by using the installation media, in which case you can
optionally remove queue managers as well.

Installing a client using msiexec

IBM MQ on Windows uses the MSI technology to install software. MSI provides both an interactive
installation and a non interactive installation.

About this task

IBM MQ on Windows uses the MSI technology to install software. MSI provides both an interactive
installation and a non interactive installation. An interactive installation displays panels and ask
questions.

210 Installing IBM MQ

The msiexec command uses parameters to give MSI some or all of the information that can also be
specified through panels during an interactive installation. This means that a user can create a reusable
automated or semi-automated installation configuration. Parameters can be given through the command
line, a transform file, a response file, or a combination of the three.
Some parameters can only be provided on the command line and not in a response file. For more
information about these parameters, see Table 30 on page 213 in “Specifying command line parameters
for client installation with msiexec” on page 212.
There are also a number of parameters can be used either on the command line or in a response file. For
more information about these parameters, see Table 32 on page 215 in “Creating and using a response
file for client installation” on page 215. If a parameter is specified both on the command line and in a
response file, the setting on the command line takes precedence.

Procedure
1. For multiple silent installations, for each version that is to be installed, find an MSI instance ID that is
available to use for that installation.
For more information, see “Choosing MSI Instance IDs for multiple server installations” on page 186.
2. To install using msiexec, at the command line, enter the msiexec command in the following format:

msiexec parameters [USEINI="response-file"] [TRANSFORMS="transform_file"]

where:
parameters
are either command line parameters preceded by a / character, or property=value pairs (if using
both forms of parameter always put the command-line parameters first). For further information,
see “Specifying command line parameters for client installation with msiexec” on page 212.
For an unattended installation, you must include the /q or /qn parameter in the command line.
Without this parameter, the installation is interactive.
Note: You must include the /i parameter and the file location of the IBM MQ installer package.
response-file
is the full path and file name of the file that contains the [Response] stanza and the
required property=value pairs, for example C:\MyResponseFile.ini. An example response file,
Response.ini, is supplied with IBM MQ. This file contains default installation parameters. For
further information, see “Creating and using a response file for client installation” on page 215.
transform_file
is the full path and file name of a transform file. For further information, see “Using transforms with
msiexec for client installation” on page 214 and “Choosing MSI Instance IDs for multiple server
installations” on page 186.
Note: For a silent installation to succeed, the AGREETOLICENSE="yes" property must be defined
either on the command line or in the response file.

Results
After the command has been entered, the command prompt immediately reappears. IBM MQ is installing
as a background process. If you have entered parameters to produce a log, check this file to see
how the installation is progressing. If the installation completes successfully, you see the message
Installation operation completed successfully in the log file.

Installing and uninstalling IBM MQ 211

 Choosing MSI Instance IDs for multiple client installations
For multiple silent installations, for each version that is installed you must find an MSI instance ID that is
available to use for that installation.

About this task

In order to support silent, or non-interactive, multiple installations, you need to find out whether the
instance ID you want to use is already in use or not and choose the appropriate one. For each installation
media (for example, each client and server), Instance ID 1 is the default ID which is used for single
installations. If you want to install alongside Instance ID 1 you need to specify which instance you want
to use. If you have already installed instance 1, 2, and 3 then you need to find out what the next available
instance is, for instance, Instance ID 4. Similarly, if instance 2 has been removed, you need to find out
that there is a gap that can be reused. You can find out which Instance ID is currently in use by using the
dspmqinst command.

Procedure
1. Type dspmqinst to find a free MSI Instance in the media being installed by reviewing the MSIMedia
and MSIInstanceId values for the versions already installed. For example:

InstName: Installation1
InstDesc:
Identifier: 1
InstPath: C:\Program Files\IBM\MQ
Version: 9.0.0.0
Primary: Yes
State: Available
MSIProdCode: {74F6B169-7CE6-4EFB-8A03-2AA7B2DBB57C}
MSIMedia: 9.0 Server
MSIInstanceId: 1

2. If MSI Instance ID 1 is in use and you want to use MSI Instance ID 2, the following parameters must
be added to the msiexec call:

MSINEWINSTANCE=1 TRANSFORMS=":instanceId7.mst;1033.mst"

What to do next
For multiple installations, the INSTALLATIONNAME or PGMFOLDER must be supplied as an additional
parameter on any non-interactive installation command. Supplying the INSTALLATIONNAME or
PGMFOLDER ensures that you do not work with the wrong installation in case you omit or incorrectly
specify the TRANSFORMS parameter.

Specifying command line parameters for client installation with msiexec

You can specify either standard msiexec command line parameters preceded by a / character, or
property=value pairs, or a combination of both.

About this task

The msiexec command can accept the following types of parameters on the command line:
Standard command line parameters, preceded by a / character
For more information about the msiexec command line parameters, see the MSDN Command-Line
Options web page.
For an unattended installation, you must include the /q or /qn parameter in the command line.
Without this parameter, the installation is interactive.
Note: You must include the /i parameter and the file location of the IBM MQ installer package.

212 Installing IBM MQ

Property=value pair parameters on the command line
All the parameters that are available for use in a response file can be used on the command line.
For more information about these parameters, see Table 32 on page 215 in “Creating and using a
response file for client installation” on page 215.
There are some extra property=value pair parameters, shown in the following table that are only for
use on the command line:

Table 30. Parameters that can be used on the command line only (msiexec property=value
parameters)
Property Values Meaning
USEINI path \ file_name Use the specified response file. See
“Creating and using a response file
for client installation” on page 215
SAVEINI path \ file_name Generate a response file during
installation. The file contains
those parameters selected for this
installation that a user might make
during an interactive installation.
ONLYINI 1|yes| "" 1, yes or any value other than
null. End the installation before
updating the target system, but after
generating a response file, if this is
specified.
"". Continue the installation and
update the target system (the
default).

TRANSFORMS :InstanceId x.mst| path \ file_name | The :InstanceId x.mst value is

:InstanceId x.mst; path \ file_name only required for a subsequent
installation of IBM WebSphere MQ
7.1 or later. The path \ file_name
specifies what transform (.mst) files
must be applied to the product. For
example, "1033.mst" specifies the
supplied U.S. English transform file.
MSINEWINSTAN 1 This property is only required for
CE subsequent installations of IBM
WebSphere MQ 7.1 or later.
REMOVEFEATUR yes Required with value "yes" for a
ES silent installation, otherwise ignored.
Allows obsolete features, no longer
part of IBM MQ, to be deleted.

When using the property=value pair parameters note that:

• Property strings must be in uppercase.
• Value strings are not case-sensitive, except for feature names. You can enclose value strings in double
quotation marks. If a value string includes a blank, enclose the blank value string in double quotation
marks.
• For a property that can take more than one value, use the format:

ADDLOCAL="Server,Client"

Installing and uninstalling IBM MQ 213

 • For properties taking paths and file names, for example PGMFOLDER, you must supply the paths as
absolute paths and not relative; that is, C:\folder\file and not .\folder\file.
When using property=value pair and command line parameters with the msiexec command, enter
command line parameters first.
If a parameter is specified both on the command line and in a response file, the setting on the command
line takes precedence.

Procedure
• For a single installation of IBM MQ, specify the msiexec command as shown in the following typical
example.

msiexec /i "path\MSI\IBM MQ.msi" /l*v c:\install.log

/q TRANSFORMS="1033.mst" AGREETOLICENSE="yes" ADDLOCAL="Client"

• If you are installing a second copy of IBM MQ, specify the msiexec command as shown in the
following typical example.

msiexec /i "path\MSI\IBM MQ.msi" /l*v c:\install.log

/q TRANSFORMS=":InstanceId2.mst;1033.mst" AGREETOLICENSE="yes"
ADDLOCAL="Client" MSINEWINSTANCE=1

Using transforms with msiexec for client installation

MSI can use transforms to modify an installation. During IBM MQ installation, transforms can be used to
support different national languages.

About this task

IBM MQ is supplied with transform files in the \MSI folder of the client image. These files are also
embedded in the IBM MQ Windows installer package, IBM MQ.msi.
Table 31 on page 214 shows the locale identifier, language, and the transform file name to use in the
msiexec command line.

Table 31. Supplied transform files for various language support

Language Transform File name Value
U.S. English 1033.mst 1033
German 1031.mst 1031
French 1036.mst 1036
Spanish 1034.mst 1034
Italian 1040.mst 1040
Brazilian Portuguese 1046.mst 1046
Japanese 1041.mst 1041
Korean 1042.mst 1042
Simplified Chinese 2052.mst 2052
Traditional Chinese 1028.mst 1028
Czech 1029.mst 1029
Russian 1049.mst 1049

214 Installing IBM MQ

Table 31. Supplied transform files for various language support (continued)
Language Transform File name Value
Hungarian 1038.mst 1038
Polish 1045.mst 1045

You can also specify the required language by using the MQLANGUAGE property with the MQParms
command. For information about the msiexec property=value parameters, see “MQParms parameter file -
client installation” on page 219.

Procedure
On the msiexec command line, you can specify the required language by using the TRANSFORMS
property in a property=value pair as shown in the following example:

TRANSFORMS="1033.mst"

The quotation marks surrounding the value are optional.

You can also specify the full path and file name of the transform file. Again, the quotation marks
surrounding the value are optional. For example:

TRANSFORMS="D:\Msi\1033.mst"

Table 31 on page 214 shows the locale identifier, language, and the transform file name to use in the
msiexec command line.
You might need to merge transforms to install multiple installations of the same version, for example:

TRANSFORMS=":InstanceId2.mst;D:\Msi\1033.mst"

Creating and using a response file for client installation

You can use the msiexec command with a parameter that specifies additional properties that are defined
in a response file. There are three ways of creating a response file for a client installation.

About this task

A response file is an ASCII text file, with a format like a Windows .ini file, that contains the stanza
[Response]. The [Response] stanza contains some or all the parameters that would normally be specified
as part of an interactive installation. The parameters are given in a property=value pair format. Any other
stanzas in the response file are ignored by msiexec.
An example response file, Response.ini, is supplied with IBM MQ. It contains the default installation
parameters.
You can combine the use of a response file with the msiexec command line parameters described in
“Specifying command line parameters for client installation with msiexec” on page 212.
Table 32 on page 215 shows the parameters that are available for use in a response file. These
parameters can also be used on the command line. If a parameter is specified both on the command
line and in a response file, the setting on the command line takes precedence.

Table 32. Parameters that can be used in a response file

Property Values Meaning
PGMFOLDER “1” on page path Folder for the IBM MQ program files. For example,
217 c:\mqm.

Installing and uninstalling IBM MQ 215

 Table 32. Parameters that can be used in a response file (continued)
Property Values Meaning
DATFOLDER path Folder for the IBM MQ data files. For example,
c:\mqm\data.
USERCHOICE 0|no If the command line or response file specifies
parameters to install features, a dialog can
be displayed to prompt you to accept the
preselected options, or review and possibly
change them.
0 or no. Suppresses display of the dialog.
Anything else. Dialog is displayed and you can
amend the options.
Not used for a silent installation.

AGREETOLICENSE “2” yes Accept the terms of the license. Set to yes before
on page 217 a silent installation.
If the installation is not silent, this parameter is
ignored.

ADDLOCAL feature, feature, All| "" A comma-separated list of features to install

locally. For a list of valid feature names, see “IBM
MQ features for Windows systems” on page 163.
All installs all features
"" installs the typical features. If you do not want
a feature use REMOVE="feature"
Note: If this is a new installation the typical
features (Client, Java, .NET Messaging, and
Development Toolkit) are installed by default
irrespective of the feature list provided in the
ADDLOCAL property. If you do not want a feature
use REMOVE="feature"

REMOVE feature, feature, |All| "" A comma-separated list of features to remove.

For a list of valid feature names, see “IBM MQ
features for Windows systems” on page 163.
All uninstalls all features
"" uninstalls no features (the default).

INSTALLATIONDESC "Description of Sets the installation description from the

installation" command line. Subject to the documented
installation description length limitations
INSTALLATIONNAME [INSTALLATION0,]Name Sets the installation name from the command
“1” on page 217 line. Subject to the documented installation name
character and length limitations.
Note: Supply INSTALLATION0,Name only when
upgrading from a release earlier than IBM
WebSphere MQ 7.1.

216 Installing IBM MQ

Table 32. Parameters that can be used in a response file (continued)
Property Values Meaning
MAKEPRIMARY 0|1| "" Makes the installation primary, if possible, or
removes the primary flag. 1 = Make primary, 0 =
Make non-primary, - use default algorithm
Note: This option is ignored if a release earlier
than IBM WebSphere MQ 7.1 is installed, or
if another IBM WebSphere MQ 7.1 or later
installation is present and set as the primary.

Notes:
1. For multiple installations, the INSTALLATIONNAME or PGMFOLDER must be supplied as an additional
parameter on any non-interactive installation command. Supplying the INSTALLATIONNAME or
PGMFOLDER ensures that you do not work with the wrong installation in case you omit or incorrectly
specify the TRANSFORMS parameter.
2. For a silent installation to succeed, the AGREETOLICENSE="yes" property must be defined either on
the command line or in the response file.

Procedure
1. Create a response file for installation in one of the following ways:
• Copy and edit the file Response.ini that is supplied on the IBM MQ Windows Server install
image, using an ASCII file editor.
• Create your own response file using an ASCII file editor.
• Use the msiexec command with the SAVEINI (and optionally, the ONLYINI ) command line
parameters to generate a response file that contains the same installation options as shown in the
following example:

msiexec /i "path\IBM MQ.msi" /q SAVEINI="response_file"

TRANSFORMS="1033.mst" AGREETOLICENSE="yes"

2. To run the msiexec command with a response file, specify the full path and file name of the response
file with the USEINI parameter as shown in the following example:

msiexec /i "path\MSI\IBM MQ.msi" /l*v c:\install.log

TRANSFORMS="1033.mst" USEINI="C:\MQ\Responsefile"

In the response file, all text is in English, and comments begin with a ; character.

Example
The following example shows a typical response file:

[Response]
PGMFOLDER="c:\mqm"
DATFOLDER="c:\mqm\data"
AGREETOLICENSE="yes"
ADDLOCAL="Client"
REMOVE="Toolkit"

Installing and uninstalling IBM MQ 217

 Installing a client using the MQParms command
You can use the MQParms command to invoke installation or uninstallation of an IBM MQ client.

Before you begin

The MQParms command can use parameters on a command line, or those specified in a parameter file.
The parameter file is an ASCII text file that contains the parameter values that you want to set for the
installation. The MQParms command takes the specified parameters and generates the corresponding
msiexec command line.
This means that you can save all the parameters that you want to use with the msiexec command in a
single file.
If you are running IBM MQ on Windows systems with User Account Control (UAC) enabled, you must
invoke the installation with elevated privileges. If you are using the Command prompt or IBM MQ Explorer
elevate privileges by using a right-click to start the program and selecting Run as administrator. If you
try to run the MQParms program without using elevated privileges, the installation fails with an error of
AMQ4353 in the installation log.
For silent operations, this must include the /q or /qn parameter, either on the command line, or in the
[MSI] stanza of the parameter file. You must also set the AGREETOLICENSE parameter to "yes".
You can specify many more parameters in the parameter file that you use with the MQParms command
than you can in the response file that you use directly with the msiexec command. Also, as well as
parameters that the IBM MQ installation uses, you can specify parameters that can be used by the
Prepare IBM MQ Wizard.
If you do not complete the Prepare IBM MQ Wizard directly after IBM MQ installations or if for any reason
your machine is rebooted between completing IBM MQ installation and completing the Prepare IBM MQ
Wizard, ensure that the wizard is run with Administrator privilege afterward, otherwise the installation
is incomplete, and might fail. You might also see Open File - Security Warning dialog boxes that list
International Business Machines Limited as the publisher. Click Run to allow the wizard to continue
An example of the file MQParms.ini is supplied with IBM MQ. This file contains default installation
parameters.
There are two ways to create a parameter file for installation:
• Copy and edit the file MQParms.ini that is supplied with the product, using an ASCII file editor.
• Create your own parameter file using an ASCII file editor.

About this task

To invoke installation using the MQParms command:

Procedure
1. From a command line, change to the root folder of the IBM MQ installation media (that is, the location
of the file MQParms.exe).
2. Enter the following command:

MQParms [ parameter_file ] [ parameters ]

where:
parameter_file
is the file that contains the required parameter values. If this file is not in the same folder as
MQParms.exe, specify the full path and file name. If you do not specify a parameter file, the default
is MQParms.ini. For further details, see “MQParms parameter file - client installation” on page 219.

218 Installing IBM MQ

 parameters
are one or more command-line parameters, for a list of these, see the MSDN Command-Line
Options web page.

Example
A typical example of an MQParms command is:

MQParms "c:\MyParamsFile.ini" /l*v c:\install.log

If you specify a parameter both on the command line and in the parameter file, the setting on the
command line takes precedence.
If you do not specify /i, /x, /a, or /j, MQParms defaults to standard installation using the IBM MQ
Windows Installer package, IBM IBM MQ.msi. That is, it generates the following part of the command line:

/i " current_folder \MSI\IBM MQ.msi"

MQParms parameter file - client installation

A parameter file is an ASCII text file that contains sections (stanzas) with parameters that can be used by
the MQParms command. Typically, this is an initialization file such as MQParms.ini.
The MQParms command takes parameters from the following stanzas in the file:
[MSI]
Contains general properties related to how the MQParms command runs and to the installation of IBM
MQ.
The properties that you can set in this stanza are listed in “Installing a client using msiexec” on page
210, and Table 33 on page 220.
MQParms ignores any other stanzas in the file.
The stanza parameters are in the form property=value, where property is always interpreted as
uppercase, but value is case sensitive. If a value string includes a blank, it must be enclosed in double
quotation marks. Most other values can be enclosed in double quotation marks. Some properties can take
more than one value, for example:

ADDLOCAL="Server,Client"

To clear a property, set its value to an empty string, for example:

REINSTALL=""

The following tables show the properties that you can set. The default is shown in bold.
For the [MSI] stanza, you can enter standard MSI command line options and properties. For example:

- /q
- ADDLOCAL="client"
- REBOOT=Suppress

Refer to Table 33 on page 220, and Table 34 on page 220 for the properties used to install IBM MQ.
Table 33 on page 220 shows additional properties in the stanza that affect how the MQParms command
runs, but that do not affect the installation.

Installing and uninstalling IBM MQ 219

 Table 33. Properties used by MQParms in the MSI stanza
Property Values Description
MQPLOG path | file_name MQParms generates a text log file with the
specified name and location.
MQPLANGUAGE The installation language.
system |user|
transform_value |existing system. Install using the language of the
default system locale (the default).
user. Install using the language of the default
locale of the user.
transform_value. Install using the language
specified by this value. See Table 34 on page
220.
existing. If MQ already exists on the system,
the same language will be used by default,
otherwise system is used.

MQPSMS 0 |no 0 or no. MQParms does not wait for the

msiexec command to end (the default).
Any other value. MQParms waits for the
msiexec command to end.

MQPINUSE 0 |1 If MQPINUSE is set to 1, MQParms continues

installing even if IBM MQ files are in use. If
this option is used a reboot will be required to
complete the installation.

Table 34. Valid values for the MQPLANGUAGE property

Language Valid values
U.S. English English en_us 1033
German German de_de 1031
French French fr_fr 1036
Spanish Spanish es_es 1034
Italian Italian it_it 1040
Brazilian Portuguese pt_br 1046
Japanese Japanese ja_jp 1041
Korean Korean ko_kr 1042
Simplified Chinese zh_cn 2052
Traditional Chinese zh_tw 1028
Czech Czech cs_cz 1029
Russian Russian ru_ru 1049
Hungarian Hungarian hu_hu 1038
Polish Polish pl_pl 1045

220 Installing IBM MQ

A typical example of a parameter file is:

[MSI]
MQPLANGUAGE=1033
MQPLOG=%temp%\MQParms.log
MQPSMS=no
ADDLOCAL=CLIENT
/m miffile
REMOVE=""
/l*v c:\install.log

Modifying a client installation on Windows

You modify the installation when an IBM MQ for Windows client is installed and you want to remove or
install some IBM MQ client features.

Procedure
1. Access the IBM MQ installation image.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.
2. Locate setup.exe in the Windows directory of the IBM MQ installation image.
• From the server DVD, this location might be E:\Windows\setup.exe
• From a network location, this location might be m:\instmqs\Windows\setup.exe
• From a local file system directory, this location might be C:\instmqs\Windows\setup.exe
3. Start the installation process.
Either run setup.exe from a command prompt, or double-click setup.exe from Windows Explorer.
Note: If you are installing on a Windows system with UAC enabled, accept the Windows prompt to
allow the launchpad to run as elevated. During installation, you might also see Open File - Security
Warning dialog boxes that list International Business Machines Limited as the publisher. Click Run to
allow the installation to continue.
The IBM MQ Installation window is displayed.
4. Click Next to continue.
5. Select Modify, then click Next.
The Features panel is displayed.
6. To change the installation of a feature, complete the following steps:
a) Click the symbol next to the feature name to display a menu.
b) Select the required option from:
• Install this feature
• Install this feature and all its subfeatures (if any)
• Do not install this feature (remove if already installed).
The symbol next to the feature name changes to show the current installation option.
7. When your selections are complete, click Next.
The IBM MQ Setup window displays a summary of the installation you selected.
8. To continue, click Modify then wait until the progress bar is complete.
When the IBM MQ client is successfully installed, the IBM MQ Setup window displays the following
message: Installation Wizard Completed Successfully
9. Click Finish to close the window.

Installing and uninstalling IBM MQ 221

 Modifying a client installation using Add/Remove Programs
On some versions of Windows, you can modify an installation by using Add/Remove Programs.
For Windows 7 follow these steps.
1. From the Windows taskbar, select Start > Control Panel.
2. Select Add/Remove Programs.
3. Select IBM MQ.
4. Select Change.
The IBM MQ Setup window with the Program Maintenance panel is displayed.
5. Select Modify, then click Next.
The Features panel is displayed.
6. To change the installation of a feature:
a. Click the symbol next to the feature name to display a menu.
b. Select the required option from:
• Install this feature
• Install this feature and all its subfeatures (if any)
• Do not install this feature (remove if already installed).
The symbol next to the feature name changes to show the current installation option.
7. When your selections are complete, click Next.
8. The IBM MQ Setup window displays a summary of the installation you selected.
To continue, click Modify.
9. Wait until the progress bar is complete.
When the IBM MQ client is successfully installed, the IBM MQ Setup window displays the following
message:
Installation Wizard Completed Successfully
Click Finish to close the window.
10. For Windows 8, the Add/Remove Programs option uninstalls the whole product.
You need to run the setup.exe file from the original installation media to make any modifications to
the installation.

Modifying a client installation silently using msiexec

You can use msiexec to modify an IBM MQ client installation.
To silently modify an IBM MQ client installation using msiexec, follow the instructions on the installation
pages, but set the ADDLOCAL parameter to include the features you want to add, and set the REMOVE
parameter to the features you want to remove.
For example if you used ADDLOCAL="JavaMsg" and REMOVE="" it would modify the installation to include
the Java Messaging and Web Services feature.
The instructions for msiexec begin here: “Installing a client using msiexec” on page 210

Modifying a client installation silently using MQParms

You can use the MQParms command to modify an IBM MQ client installation.
To silently modify an IBM MQ client installation using MQParms, follow the instructions on the installation
pages, but set the ADDLOCAL parameter to include the features you want to add, and set the REMOVE
parameter to the features you want to remove.

222 Installing IBM MQ

 For example if you used ADDLOCAL="JavaMsg" and REMOVE="" it would modify the installation to include
the Java Messaging and Web Services feature.
For details of the MQParms command, see “Installing a client using the MQParms command” on page
218.

Converting a trial license on Windows

Convert a trial license to a full license without reinstalling IBM MQ.
When the trial license expires, the "count-down" displayed by the strmqm command informs you the
license has expired, and the command does not run.

Before you begin

1. IBM MQ is installed with a trial license.
2. You have access to the installation media of a fully licensed copy of IBM MQ.

About this task

Run the setmqprd command to convert a trial license to a full license.
If you do not want to apply a full license to your trial copy of IBM MQ, you can uninstall it at any time.

Procedure
1. Obtain the full license from the fully licensed installation media.
The full license file is amqpcert.lic. On Windows it is in the \MediaRoot\licenses directory on
the installation media. It is installed into the bin directory on the IBM MQ installation path.
2. Run the setmqprd command from the installation that you are upgrading:

MQ_INSTALLATION_PATH\bin\setmqprd \MediaRoot\licenses\amqpcert.lic

Related reference
setmqprd

Displaying messages in your national language on Windows

systems
To display messages from a different national language message catalog, you must either set the
MQS_FORCE_NTLANGID environment variable, or change a regional setting.

About this task

Messages in U.S. English are automatically installed with IBM MQ
Messages in the national languages that IBM MQ supports are automatically installed. Messages are
displayed in the national language, based on the following order:
1. The value of the MQS_FORCE_NTLANGID environment variable, if set.
2. The regional format of the user that is displaying the message, if the language specified by the regional
format is supported by IBM MQ.
3. The Administrative system locale if the language specified by the system locale is supported by IBM
MQ.
4. US English, if no other supported language can be determined.

Installing and uninstalling IBM MQ 223

 Note: The queue manager is usually launched by a service on the machine, and hence is running under
its own user account (for example MUSR_MQADMIN) or a specific domain account provided during install
time. See Local and domain user accounts for the IBM MQ Windows service for more information.
If you require messages in a language other than the one associated with the regional format of a user
account, perform the following steps:

Procedure
1. Globally set the MQS_FORCE_NTLANGID environment variable, to the language identifier of the desired
language, for messages displayed by the queue manager.
You should set the MQS_FORCE_NTLANGID system wide. Otherwise, every user displaying messages
needs to have the environment variable set individually.
The language identifier values, represented in hexadecimal notation, are listed in the following
Microsoft document: Language Identifier Constants and Strings
2. Reboot machines where queue managers are running as a service, for the environment variable to take
effect.

Redistributable clients on Windows

The Windows 64-bit image is shipped in a Win64.zip file.

File names
The archive or .zip file names describe the file contents and equivalent maintenance levels.
For IBM MQ 9.2.0 the client images are available under the following file names:
Long Term Support: 9.2.0 IBM MQ C and .NET redistributable client for Windows x64
9.2.0.0-IBM-MQC-Redist-Win64.zip
Long Term Support: 9.2.0 IBM MQ JMS and Java redistributable client
9.2.0.0-IBM-MQC-Redist-Java.zip

Choosing the runtime files to distribute with an application

A script file named genmqpkg is provided by the redistributable client under the bin directory.
You can use the genmqpkg script to generate a smaller subset of files that are tailored to the needs of the
application, for which the files are intended to be distributed. You are asked a series of interactive Yes or
No questions to determine the runtime requirements for an IBM MQ
application.
Finally, genmqpkg asks you to supply a new target directory, where the script duplicates the required
directories and files.
Important: IBM support is only able to provide assistance with the full, unmodified set of files contained
within the redistributable client packages.

Other considerations
On Windows, the default data path of a non-installed client is %HOMEDRIVE%%HOMEPATH%
\IBM\MQ\data.
You can change the default directory of the data path, by using the MQ_OVERRIDE_DATA_PATH
environment variable.
Note: You must create the directory first, as the directory is not created automatically.
A redistributable client runtime co-exists with a full IBM MQ client or server installation, provided that
they are installed in different locations.

224 Installing IBM MQ

 Important: Unpacking a redistributable image into the same location as a full IBM MQ installation is not
supported.

Classpath changes
The classpath used by dspmqver, setmqenv, and crtmqenv commands, add the
com.ibm.mq.allclient.jar to the environment, immediately following the com.ibm.mq.jar and
com.ibm.mqjms.jar.
An example of dspmqver output from the redistributable client on Windows:

Name: IBM MQ
Version: 9.2.0.0
Level: p920-920-L150909
BuildType: IKAP - (Production)
Platform: IBM MQ for Windows (x64 platform)
Mode: 64-bit
O/S: Windows 10 Professional x64 Edition, Build 7601: SP1
InstName: MQNI09200004
InstDesc: IBM MQ V9.2.0.0 (Redistributable)
Primary: No
InstPath: C:\Users\johndoe\Desktop\Redist
DataPath: C:\Users\johndoe\IBM\MQ\data
MaxCmdLevel: 920

Related concepts
“Redistributable IBM MQ clients” on page 27
The IBM MQ redistributable client is a collection of runtime files that are provided in a .zip or .tar file
that can be redistributed to third parties under redistributable license terms, which provides a simple way
of distributing applications and the runtime files that they require in a single package.

.NET application runtime - Windows only

Considerations when using the .NET application.
The runtime DLL files laid down in the redistributable images on Windows for .NET applications are
normally registered with the global assembly cache (GAC) by a user with system administrator privileges,
when installing the primary installation. However, this severely limits the benefits of redistribution.
The redistributable package on the Windows platform does not provide any tooling to register DLLs with
the GAC, so .NET applications have to locate the appropriate assemblies by other means. There are two
options that work in this situation.

Probing
After checking the GAC, the .NET runtime attempts to locate required assemblies through probing. The
first location checked is the application base, which is the root location where the application is being
run. See the information on How the Runtime Locates Assemblies on the Microsoft Web site for more
information.
Note that when using this approach, the maintenance level of the assemblies used when building
the .NET application must match those used at runtime - for example an application built at IBM MQ
8.0.0 Fix Pack 4 must be run with the IBM MQ 8.0.0 Fix Pack 4 redistributable client runtime.
Using this approach, a .NET application placed in the \bin directory alongside the IBM MQ assemblies
picks up assemblies from a primary IBM MQ installation (if one exists), falling back to the redistributable
copies.
1. Compile the .NET application under a full IBM MQ installation, that is csc \t:exe \r:System.dll
\r:amqmdnet.dll \lib: \out:nmqwrld.exe nmqwrld.cs.
2. Copy the exe file in the redistributable client .zip file into the \bin directory.

Installing and uninstalling IBM MQ 225

 DEVPATH environment variable
An alternative, that allows your application to be built, distributed, extracted and run as previously, is to
use DEVPATH to locate the required assemblies. Unlike with the probing approach, this option overrides
any matching assemblies from the GAC. However it is for this reason that Microsoft discourages its use in
a production environment.
This approach can be effective where there is a possibility that a full IBM MQ installation is installed on
the client. However, there is a good reason to always use the redistributable assemblies.
1. Compile the .NET application under a full IBM MQ installation, that is csc \t:exe \r:System.dll
\r:amqmdnet.dll \lib: \out:nmqwrld.exe nmqwrld.cs)
2. Copy the .exe file into, or alongside, the redistributable client .zip file.
3. In the same directory as the .exe file, create an application configuration file with the name of
the .exe file suffixed by .config, that is nmqwrld.exe.config with the following contents:

<configuration>
<runtime>
<developmentMode developerInstallation="true" />
</runtime>
</configuration>

4. Call setmqenv -s and set the DEVPATH environment variable to specify the \bin directory from the
redistributable image before running the application, that is:

set DEVPATH=%MQ_INSTALLATION_PATH%\bin

Starting and stopping trace for the .NET redistributable managed client
You generate trace for the .NET redistributable managed client in the same way as for the stand-
alone .NET client. For more information, see Using the stand-alone IBM MQ .NET client.

More information on .NET

For more information on .NET, see Writing and deploying IBM MQ .NET programs.
Related concepts
“Redistributable IBM MQ clients” on page 27
The IBM MQ redistributable client is a collection of runtime files that are provided in a .zip or .tar file
that can be redistributed to third parties under redistributable license terms, which provides a simple way
of distributing applications and the runtime files that they require in a single package.

Verifying an IBM MQ installation on Windows

The topics in this section provide instructions on how to verify a server or a client installation of IBM MQ
on Windows systems.

About this task

You can verify a local (stand-alone) server installation or a server-to-server installation of the IBM MQ
server:
• A local server installation has no communication links with other IBM MQ installations.
• A server-to-server installation does have links to other installations.
You can also verify that your IBM MQ MQI client installation completed successfully and that the
communication link is working.

226 Installing IBM MQ

Procedure
• To verify a local server installation, see “Verifying a local server installation using the command line on
Windows” on page 227.
• To verify a server-to-server installation, see “Verifying a server-to-server installation using the
command line on Windows” on page 228.
• To verify a client installation, see “Verifying a client installation on Windows” on page 231.

Verifying a local server installation using the command line on

Windows
On Windows systems, you can verify a local installation by using the command line to create a simple
configuration of one queue manager and one queue.

Before you begin

To verify the installation, you must first install the samples package.
Before beginning the verification procedure, you might want to check that you have the latest fixes for
your system. For more information about where to find the latest updates, see “Checking requirements on
Windows” on page 173.

About this task

Use the following steps to configure your default queue manager from the command line. After the queue
manager is configured, use the amqsput sample program to put a message on the queue. You then use
the amqsget sample program to get the message back from the queue.
IBM MQ object definitions are case-sensitive. Any text entered as an MQSC command in lowercase is
converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that you
type the examples exactly as shown.

Procedure
1. Set up your environment:
a) Set up environment variables for use with a particular installation by entering the following
command:

MQ_INSTALLATION_PATH\bin\setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

b) Check that the environment is set up correctly by entering the following command:

dspmqver

If the command completes successfully, and the expected version number and installation name
are returned, the environment is set up correctly.
2. Create a queue manager called QMA by entering the following command:

crtmqm QMA

Messages indicate when the queue manager is created, and when the default IBM MQ objects are
created.
3. Start the queue manager by entering the following command:

strmqm QMA

Installing and uninstalling IBM MQ 227

 A message indicates when the queue manager starts.
4. Start MQSC by entering the following command:

runmqsc QMA

A message indicates when MQSC starts. MQSC has no command prompt.

5. Define a local queue called QUEUE1 by entering the following command:

DEFINE QLOCAL (QUEUE1)

A message indicates when the queue is created.

6. Stop MQSC by entering the following command:

end

Messages are shown, followed by the command prompt.

Note: Subsequent steps require that the samples package is installed.
7. Put a message on the queue by entering the following command:

amqsput QUEUE1 QMA

The following messages are shown:

Sample AMQSPUT0 start

target queue is QUEUE1

8. Type some message text on one or more lines, where each line is a different message. Enter a blank
line to end the message input.
The following message is shown:

Sample AMQSPUT0 end

Your messages are now on the queue and the command prompt is shown.
9. Get the messages from the queue, by entering the following command:

amqsget QUEUE1 QMA

The sample program starts, and your messages are displayed.

Results
You have successfully verified your local installation.

Verifying a server-to-server installation using the command line on

Windows
You can verify a server-to-server installation using two servers, one as a sender and one as a receiver.

Before you begin

• On Windows, IBM MQ supports TCP, SNA, NetBios, and SPX.
The examples in this task use TCP/IP. If you do not use TCP, see Setting up communication for Windows.
• Make sure that you are a member of the IBM MQ administrators group (mqm) on each server.

228 Installing IBM MQ

 • Decide which installation is the sender server and which installation is the receiver server. The
installations might be on the same system, or on different systems.

About this task

IBM MQ object definitions are case-sensitive. Any text entered as an MQSC command in lowercase is
converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that you
type the examples exactly as shown.

Procedure
1. On the receiver server:
a) Check which ports are free, for example by running netstat. For more information about this
command, see the documentation of your operating system.
If port 1414 is not in use, make a note of 1414 to use as the port number in step 2 g. Use the same
number for the port for your listener later in the verification. If it is in use, note a port that is not in
use; for example 1415.
b) Set up the environment for the installation you are using by entering the following command at the
command prompt:

MQ_INSTALLATION_PATH\bin\setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

c) Create a queue manager called QMB by entering the following command at the command prompt:

crtmqm QMB

Messages tell you that the queue manager has been created, and that the default IBM MQ objects
have been created.
d) Start the queue manager by entering the following command:

strmqm QMB

A message tells you when the queue manager has started.

e) Start MQSC by entering the following command:

runmqsc QMB

A message tells you that MQSC has started. MQSC has no command prompt.
f) Define a local queue called RECEIVER.Q by entering the following command:

DEFINE QLOCAL (RECEIVER.Q)

A message tells you the queue has been created.

g) Define a listener by entering the following command:
DEFINE LISTENER (LISTENER1) TRPTYPE (TCP) CONTROL (QMGR) PORT ( PORT_NUMBER )

Where port_number is the name of the port the listener runs on. This number must be the same as
the number used when defining your sender channel.
h) Start the listener by entering the following command:

START LISTENER (LISTENER1)

Installing and uninstalling IBM MQ 229

 Note: Do not start the listener in the background from any shell that automatically lowers the
priority of background processes.
i) Define a receiver channel by entering the following command:

DEFINE CHANNEL (QMA.QMB) CHLTYPE (RCVR) TRPTYPE (TCP)

A message tells you when the channel has been created.

j) End MQSC by typing:

end

Some messages are displayed, followed by the command prompt.

2. On the sender server:
a) Set up the environment for the installation you are using by entering the following command at the
command prompt:

MQ_INSTALLATION_PATH\bin\setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

b) Create a queue manager called QMA by entering the following command at the command prompt:

crtmqm QMA

Messages tell you that the queue manager has been created, and that the default IBM MQ objects
have been created.
c) Start the queue manager, by entering the following command:

strmqm QMA

A message tells you when the queue manager has started.

d) Start MQSC by entering the following command:

runmqsc QMA

A message tells you that an MQSC session has started. MQSC had no command prompt.
e) Define a local queue called QMB (to be used as a transmission queue) by entering the following
command:

DEFINE QLOCAL (QMB) USAGE (XMITQ)

A message tells you when the queue has been created.

f) Define a local definition of the remote queue by entering the following command:

DEFINE QREMOTE (LOCAL.DEF.OF.REMOTE.QUEUE) RNAME (RECEIVER.Q) RQMNAME ('QMB') XMITQ (QMB)

g) Define a sender channel by entering the following command:

DEFINE CHANNEL (QMA.QMB) CHLTYPE (SDR) CONNAME ('CON-NAME(PORT)') XMITQ (QMB) TRPTYPE (TCP)

con-name is the TCP/IP address of the receiver system. If both installations are on the same
system, the con-name is localhost. port is the port you noted in 1 a. If you do not specify a port,
the default value of 1414 is used.
h) Start the sender channel by entering the following command:

230 Installing IBM MQ

 START CHANNEL(QMA.QMB)

The receiver channel on the receiver server starts automatically when the sender channel starts.
i) Stop MQSC by entering the following command:

end

Some messages are displayed, followed by the command prompt.

j) If both the sender server and receiver server are installations on the same system, check that the
queue managers have been created on different installations by entering the following command:

dspmq -o installation

If the queue managers are on the same installation, move either QMA to the sender installation
or QMB to the receiver installation by using the setmqm command. For more information, see
setmqm.
k) Put a message on the local definition of the remote queue, which in turn specifies the name of the
remote queue. Enter the following command:

amqsput LOCAL.DEF.OF.REMOTE.QUEUE QMA

A message tells you that amqsput has started.

l) Type some message text on one or more lines, followed by a blank line.
A message tells you that amqsput has ended. Your message is now on the queue and the
command prompt is displayed again.
3. On the receiver server:
a) Get the message from the queue on the receiver by entering the following command:

amqsget RECEIVER.Q QMB

The sample program starts, and your message is displayed. After a pause, the sample ends. Then
the command prompt is displayed.

Results
You have now successfully verified the server-to-server installation.

Verifying a client installation on Windows

You can verify that your IBM MQ MQI client installation completed successfully and that the
communication link is working.

About this task

The verification procedure shows how to create a queue manager called queue.manager.1, a local
queue called QUEUE1, and a server-connection channel called CHANNEL1 on the server.
It shows how to create the client-connection channel on the IBM MQ MQI client workstation. It then
shows how to use the sample programs to put a message onto a queue, and get the message from the
queue.
The example does not address any client security issues. See Setting up IBM MQ MQI client security for
details if you are concerned with IBM MQ MQI client security issues.
The verification procedure assumes that:

Installing and uninstalling IBM MQ 231

 • The full IBM MQ server product has been installed on a server.
• The server installation is accessible on your network.
• The IBM MQ MQI client software has been installed on a client system.
• The IBM MQ sample programs have been installed.
• TCP/IP has been configured on the server and client systems. For more information, see Configuring
connections between the server and client.

Procedure
1. Set up the server and client:
• To set up the server and client by using the command line, follow the instructions in “Setting up the
server and client using the command line on Windows” on page 232.
• To set up the server and client by using IBM MQ Explorer, follow the instructions in “Setting up the
server and client using IBM MQ Explorer on Windows” on page 235.
2. Test the communications between client and server, using the instructions in “Testing communication
between a client and a server on Windows” on page 238.
Related tasks
“Installing an IBM MQ client on Windows” on page 209
This topic describes how to install IBM MQ client on Windows systems. This procedure can be used for
installing a first or a subsequent installation.

Setting up the server and client using the command line on Windows
You can use the command line to create the objects that you need to use to verify a client installation
on Linux. On the server you create a queue manager, a local queue, a listener, and a server-connection
channel. You must also apply security rules to allow the client to connect and make use of the queue
defined. On the client you create a client-connection channel. After setting up the server and client, you
can then use the sample programs to complete the verification procedure.

Before you begin

Before starting this task, review the information in “Verifying a client installation on Windows” on page
231.

About this task

This task explains how to use the command line to set up the server and client so that you can verify your
client installation.
If you prefer to use IBM MQ Explorer, see “Setting up the server and client using IBM MQ Explorer on
Windows” on page 235.

Procedure
1. Set up the server by following the instructions in “Setting up the server using the command line on
Windows” on page 233.
2. Set up the client by following instructions in “Connecting to a queue manager, using the MQSERVER
environment variable on Windows” on page 234.

What to do next
Test the communications between client and server by following the instructions in “Testing
communication between a client and a server on Windows” on page 238.

232 Installing IBM MQ

 Setting up the server using the command line on Windows
Follow these instructions to create a queue manager, queue, and channel on the server. You can then use
these objects to verify the installation.

About this task

These instructions assume that no queue manager or other IBM MQ objects have been defined.
IBM MQ object definitions are case-sensitive. Any text entered as an MQSC command in lowercase is
converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that you
type the examples exactly as shown.

Procedure
1. Create a user ID on the server that is not in the mqm group.
This user ID must exist on the server and client. This is the user ID that the sample applications must
be run as, otherwise a 2035 error is returned.
2. You must set various environment variables so that the installation can be used in the current shell.
You can set the environment variables by entering the following command:

MQ_INSTALLATION_PATH\bin\setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed

3. Create a queue manager called QUEUE.MANAGER.1 by entering the following command:

crtmqm QUEUE.MANAGER.1

You see messages telling you that the queue manager has been created.
4. Start the queue manager by entering the following command:

strmqm QUEUE.MANAGER.1

A message tells you when the queue manager has started.

5. Start MQSC by entering the following command:

runmqsc QUEUE.MANAGER.1

A message tells you that an MQSC session has started. MQSC has no command prompt.
6. Define a local queue called QUEUE1 by entering the following command:

DEFINE QLOCAL(QUEUE1)

A message tells you when the queue has been created.

7. Allow the user ID that you created in step 1 to use QUEUE1 by entering the following command:

SET AUTHREC PROFILE(QUEUE1) OBJTYPE(QUEUE) PRINCIPAL(' non_mqm_user ') AUTHADD(PUT,GET)

where non_mqm_user is the user ID created in step 1. A message tells you when the authorization
has been set. You must also run the following command to give the user ID authority to connect:

SET AUTHREC OBJTYPE(QMGR) PRINCIPAL(' non_mqm_user ') AUTHADD(CONNECT)

If this command is not run, a 2305 stop error is returned.

8. Define a server-connection channel by entering the following command:

Installing and uninstalling IBM MQ 233

 DEFINE CHANNEL (CHANNEL1) CHLTYPE (SVRCONN) TRPTYPE (TCP)

A message tells you when the channel has been created.

9. Allow your client channel to connect to the queue manager and run under the user ID that you
created in step 1, by entering the following MQSC command:

SET CHLAUTH(CHANNEL1) TYPE(ADDRESSMAP) ADDRESS(' client_ipaddr ') MCAUSER(' non_mqm_user ')

where client_ipaddr is the IP address of the client system, and non_mqm_user is the user ID created
in step 1. A message tells you when the rule has been set.
10. Define a listener by entering the following command:

DEFINE LISTENER (LISTENER1) TRPTYPE (TCP) CONTROL (QMGR) PORT (port_number)

where port_number is the number of the port the listener is to run on. This number must be the same
as the number used when defining your client-connection channel in “Installing an IBM MQ client on
Windows” on page 209.
Note: If you omit the port parameter from the command, a default value of 1414 is used for the
listener port. If you want to specify a port other than 1414, you must include the port parameter in
the command, as shown.
11. Start the listener by entering the following command:

START LISTENER (LISTENER1)

12. Stop MQSC by entering:

end

You see some messages, followed by the command prompt.

What to do next
Follow the instructions to set up the client. See “Connecting to a queue manager, using the MQSERVER
environment variable on Windows” on page 234.

Connecting to a queue manager, using the MQSERVER environment variable on Windows

When an IBM MQ application is run on the IBM MQ MQI client, it requires the name of the MQI channel,
the communication type, and the address of the server to be used. Provide these parameters by defining
the MQSERVER environment variable.

Before you begin

Before you start this task, you must complete the task, “Setting up the server using the command line on
Windows” on page 233, and save the following information:
• The host name or IP address of the server and port number that you specified when creating the
listener.
• The channel name of the server-connection channel.

About this task

This task describes how to connect an IBM MQ MQI client, by defining the MQSERVER environment
variable on the client.
You can give the client access to the generated client channel definition table, amqclchl.tab instead;
see Accessing client-connection channel definitions.

234 Installing IBM MQ

Alternatively, on Windows, if Active Directory support is enabled, the client discovers the client-
connection information dynamically from the Active Directory.

Procedure
1. Log in as the userid that you created in Step 1 of “Setting up the server using the command line on
Windows” on page 233.
2. Check the TCP/IP connection. From the client, enter one of the following commands:
• ping server-hostname
• ping n.n.n.n
n.n.n.n represents the network address. You can set the network address in IPv4 dotted decimal
form, for example, 192.0.2.0. Alternatively, set the address in IPv6 hexadecimal form, for
example 2001:0DB8:0204:acff:fe97:2c34:fde0:3485.
If the ping command fails, correct your TCP/IP configuration.
3. Set the MQSERVER environment variable. From the client, enter the following command:

SET MQSERVER=CHANNEL1/TCP/server-address(port)

Where:
• CHANNEL1 is the server-connection channel name.
• server-address is the TCP/IP host name of the server.
• port is the TCP/IP port number the server is listening on.
If you do not give a port number, IBM MQ uses the one specified in the qm.ini file, or the client
configuration file. If no value is specified in these files, IBM MQ uses the port number identified in the
TCP/IP services file for the service name MQSeries. If an MQSeries entry in the services file does not
exist, a default value of 1414 is used. It is important that the port number used by the client and the
port number used by the server listener program are the same.

What to do next
Use the sample programs to test communication between the client and server; see “Testing
communication between a client and a server on Windows” on page 238.

Setting up the server and client using IBM MQ Explorer on Windows

You can use IBM MQ Explorer to create the objects that you need to use to verify a client installation on
Windows. On the server, you create a queue manager, a local queue, a listener and a server-connection
channel. On the client system you create a client-connection channel. Then from the command line you
use the sample PUT and GET programs to complete the verification procedure.

Before you begin

Before starting this task, review the information in “Verifying a client installation on Windows” on page
231.

About this task

This task explains how to use IBM MQ Explorer to set up the server and client so that you can verify your
client installation.
If you prefer to use the command line, see “Setting up the server and client using the command line on
Windows” on page 232.

Installing and uninstalling IBM MQ 235

 Procedure
1. Set up the server by following the instructions in “Setting up the server using IBM MQ Explorer on
Windows” on page 236.
2. Set up the client by following instructions in “Setting up the client using IBM MQ Explorer on Windows”
on page 237.

What to do next
Test the communications between client and server by following the instructions in “Testing
communication between a client and a server on Windows” on page 238.
Related tasks
“Installing an IBM MQ client on Windows” on page 209
This topic describes how to install IBM MQ client on Windows systems. This procedure can be used for
installing a first or a subsequent installation.

Setting up the server using IBM MQ Explorer on Windows

On the server, you create a queue manager, a local queue, a listener and a server-connection channel.
On the client system you create a client-connection channel. Then from the command line you use the
sample PUT and GET programs to complete the verification procedure.

About this task

You can use the IBM MQ Explorer to create a queue manager, queue and server-connection channel on
Windows. This topic describes the tasks necessary to set up the server.

Procedure
1. Create a queue manager:
a) Open IBM MQ Explorer.
b) Right-click the folder called Queue Managers, select New > Queue Manager.
c) In the first entry field, type the queue manager name, QUEUE.MANAGER.1, and click Finish.
2. Create a local queue:
a) Expand the queue manager you have just created and right-click queues.
b) Select New > Local Queue.
c) Enter the queue name, QUEUE1, and click Finish.
3. Define the server-connection channel:
a) Right-click Channels.
b) Select New > Server Connection Channel.
c) Enter the channel name, CHANNEL1, and click Next.
d) In the dialog navigation pane, click MCA to open the MCA page.
e) In the MCA User ID field, enter a userid that is a member of the mqm group, typically your own.
f) Click Finish.
4. Run the listener.
The listener is automatically started when the queue manager is configured. To check that the listener
is running, open Listeners and look for LISTENER.TCP.

What to do next
Set up the client. See “Setting up the client using IBM MQ Explorer on Windows” on page 237.
Related tasks
“Testing communication between a client and a server on Windows” on page 238

236 Installing IBM MQ

On the IBM MQ MQI client workstation, use the amqsputc sample program to put a message on the
queue at the server workstation. Use the amqsgetc sample program to get the message from the queue
back to the client.
“Installing an IBM MQ client on Windows” on page 209
This topic describes how to install IBM MQ client on Windows systems. This procedure can be used for
installing a first or a subsequent installation.

Setting up the client using IBM MQ Explorer on Windows

You can use IBM MQ Explorer to define the client-connection if you are setting up the client and server on
the same workstation on a Windows system.

Procedure
1. Select the queue manager, QUEUE.MANAGER.1
2. Open the Channels folder, then right-click Client Connections > New > Client-connection Channel...
3. Enter the channel name, CHANNEL1, for the client connection, and click Next.
4. Enter the queue manager name, QUEUE.MANAGER.1
5. Enter the following string as the connection name:

server-address (port)

Where:
• server-address is the TCP/IP host name of the server
• port is the TCP/IP port number the server is listening on
6. Click Finish.
7. From the command line, set the MQCHLLIB environment variable.
Enter the following command:

SET MQCHLLIB= MQ_INSTALLATION_PATH\qmgrs\QUEUE!MANAGER!1\@ipcc

where MQ_INSTALLATION_PATH represents the high-level directory in which IBM MQ is installed

Note: The queue manager name contains ".". IBM MQ creates the queue manager directory with the
name, QUEUE!MANAGER!1

What to do next
Use the sample programs to test communication between the client and server. See “Testing
communication between a client and a server on Windows” on page 238.
Related tasks
“Setting up the server and client using IBM MQ Explorer on Windows” on page 235
You can use IBM MQ Explorer to create the objects that you need to use to verify a client installation on
Windows. On the server, you create a queue manager, a local queue, a listener and a server-connection
channel. On the client system you create a client-connection channel. Then from the command line you
use the sample PUT and GET programs to complete the verification procedure.
“Installing an IBM MQ client on Windows” on page 209

Installing and uninstalling IBM MQ 237

 This topic describes how to install IBM MQ client on Windows systems. This procedure can be used for
installing a first or a subsequent installation.

Testing communication between a client and a server on Windows

On the IBM MQ MQI client workstation, use the amqsputc sample program to put a message on the
queue at the server workstation. Use the amqsgetc sample program to get the message from the queue
back to the client.

Before you begin

Complete the previous topics in this section:
• Set up a queue manager, channels, and queue.
• Open a command window.
• Set system environment variables.

About this task

Note that IBM MQ object definitions are case-sensitive. Text entered as an MQSC command in lowercase
is converted automatically to uppercase unless you enclose it in single quotation marks. Make sure that
you type the examples exactly as shown.

Procedure
1. Change into the MQ_INSTALLATION_PATH\Tools\C\Samples\Bin directory for 32 bit systems or the
MQ_INSTALLATION_PATH\Tools\C\Samples\Bin64 directory for 64 bit systems.
MQ_INSTALLATION_PATH represents the high-level directory in which IBM MQ is installed.
2. You must set certain environment variables so that the installation can be used in the current shell.
You can set the environment variables by entering the following command:

MQ_INSTALLATION_PATH\bin\setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed

3. Start the PUT program for QUEUE1 on QUEUE.MANAGER.1 by entering the following command:

amqsputc QUEUE1 QUEUE.MANAGER.1

If the command is successful, the following messages are displayed:

Sample AMQSPUT0 start target queue is QUEUE1

Tip: You might get the error, MQRC_NOT_AUTHORIZED ( 2035 ). By default, channel authentication
is enabled when a queue manager is created. Channel authentication prevents privileged users
accessing a queue manager as an IBM MQ MQI client. For verifying the installation, you can either
change the MCA user ID to a non-privileged user, or disable channel authentication. To disable channel
authentication run the following MQSC command:

ALTER QMGR CHLAUTH(DISABLED)

When you finish the test, if you do not delete the queue manager, re-enable channel authentication:

ALTER QMGR CHLAUTH(ENABLED)

4. Type some message text, then press Enter twice.

The following message is displayed:

238 Installing IBM MQ

 Sample AMQSPUT0 end

Your message is now on the queue that is on the server queue manager.
5. Start the GET program for QUEUE1 on QUEUE.MANAGER.1 by entering the following command:

amqsgetc QUEUE1 QUEUE.MANAGER.1

The sample program starts, and your message is displayed. After a short pause (approximately 30
seconds), the sample ends and the command prompt is displayed again.

Results
You have now successfully verified the client installation.

What to do next
1. You must set various environment variables on the server so that the installation can be used in the
current shell. You can set the environment variables by entering the following command:

MQ_INSTALLATION_PATH\bin\setmqenv -s

where MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

2. On the server, stop the queue manager by entering the following command:

endmqm QUEUE.MANAGER.1

3. On the server, delete the queue manager by entering the following command:

dltmqm QUEUE.MANAGER.1

Uninstalling IBM MQ on Windows

You can uninstall the IBM MQ MQI clients and servers on Windows systems by using the control panel,
the command line ( msiexec ), MQParms, or by using the installation media, in which case you can
optionally remove queue managers as well.

Before you begin

By default, uninstallation logging is not enabled on Windows. To ensure that you receive an uninstallation
log, carry out the following procedure:
1. In a command prompt, open the registry editor by issuing the command regedit.
2. Create, or edit, the appropriate registry key:
HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\Windows\Installer
3. Under this registry key add the following information:
Name
Logging
Data type
REG_SZ
Value
voicewarmup
4. Save the updated registry key.

Installing and uninstalling IBM MQ 239

 Procedure
The first part of the procedure ensures that there are no IBM MQ programs or processes running:
1. If you are running IBM MQ with the Microsoft Cluster Service (MSCS), remove the queue managers
from MSCS control before uninstalling IBM MQ. Perform the following steps for each queue manager
currently under MSCS control :
a) Take the queue manager resource offline.
b) Destroy the resource instance.
c) Migrate the queue manager files back from shared drives. This step is shown as optional in
Removing a queue manager from MSCS control. However, it is mandatory in this case.
2. Stop all IBM MQ applications associated with the installation you are uninstalling.
3. Close all Managed File Transfer agents.
If you have a Managed File Transfer Agent running, close it by using the fteStopAgent command;
see fteStopAgent (stop a Managed File Transfer Agent).
4. For a server installation, end all IBM MQ activity:
a) Log in as a user in the group mqm.
b) Stop all running queue managers and listeners by using the IBM MQ Explorer, or by entering the
following commands:
i) Set up your environment to work with the installation you want to uninstall by entering the
following command:

MQ_INSTALLATION_PATH\bin\setmqenv -s

where MQ_INSTALLATION_PATH is the location where IBM MQ is installed.

ii) For each queue manager, enter the following command to stop the queue manager:

endmqm queue_manager_name

iii) For each queue manager, enter the following command to stop any listeners associated with
the queue manager:

endmqlsr -m queue_manager_name

5. Stop IBM MQ.

To do this right-click the IBM MQ icon in the system tray, then select Stop IBM MQ.
6. Close all IBM MQ windows.
7. Stop any monitoring service.
When all processes associated with IBM MQ are no longer running, you can uninstall IBM MQ:
8. Uninstall IBM MQ by using one of the following methods:
• Use the Windows Control Panel. This process is described in: “Uninstalling IBM MQ using the
control panel” on page 241. This method does not remove the queue manager data.
• Use the command line by running the msiexec command as described in: “Uninstalling IBM MQ
using msiexec” on page 242. This method does not remove the queue manager data.
• Use the appropriate parameters with MQParms. This process is described in “Uninstalling IBM MQ
using MQParms” on page 244. This method does not remove the queue manager data.
• Use the installation media, by selecting the appropriate option as described in: “Uninstalling IBM
MQ on Windows using the installation media” on page 244. The option to remove queue manager
data is displayed in the Removing Server feature panel, if appropriate.
If you have to cancel the uninstallation process before it is finished, you might have to reconfigure
IBM MQ with the Prepare IBM MQ wizard because the rollback of the deletion of the IBM MQ service

240 Installing IBM MQ

 is unable to set the service's user account password. Use the following command to reconfigure IBM
MQ:

MQ_INSTALLATION_PATH\bin\amqmjpse.exe -r

For more information about the Prepare IBM MQ Wizard, see “Configuring IBM MQ with the Prepare
IBM MQ Wizard” on page 200.
9. Check the Windows event log and restart the system if necessary.
If event ID 10005 is written to the Windows event log, you must restart the system to complete the
uninstallation process.
10. If you are uninstalling the last or only installation of IBM MQ, you can remove all the information
about previous installations that is retained on the system, if you want to. You should use the
Reset.cmd for this purpose; see “Clearing IBM MQ installation settings” on page 180 for more
information.
The following registry values remain after uninstallation:
• My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\IBM\WebSphere MQ\LogDefaultPath
• My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\IBM\WebSphere MQ\WorkPath
• My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\IBM\WebSphere
MQ\LogDefaultPath
• My Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\IBM\WebSphere
MQ\WorkPath
Data folders will also remain and are located at MQ_DATA_PATH\Config, where MQ_DATA_PATH is
the location of the IBM MQ data directory. Most of the remaining files contain text such as INI files,
error logs, and FDC files. The executable shared library mqzsd.dll also remains.
If a client is installed on a system where the LogDefaultPath registry value remains from a
previous server installation, a client installation will attempt to create this directory if it does
not already exist. If this behavior is not wanted, remove the LogDefaultPath registry value before
installing the client.

Uninstalling IBM MQ using the control panel

You can uninstall IBM MQ by using the control panel to remove all currently installed features.

Before you begin

Start the uninstalling process by following the steps described in “Uninstalling IBM MQ on Windows” on
page 239.
If you no longer require the queue managers that are on the system, delete them by using the IBM MQ
Explorer or the dltmqm command.

Procedure
1. From the Windows taskbar, open the control panel by clicking Start > Settings > Control Panel, or
Start > Control Panel.
2. Open Programs and Features.
3. Click IBM MQ (installation_name), where installation_name is the name of the installation you want to
remove.
4. Click Remove or Uninstall and click Yes to confirm.
If User Account Control (UAC) is enabled, accept the Windows prompt to allow the uninstallation to run
as elevated. The program then begins and runs to completion.

Installing and uninstalling IBM MQ 241

 What to do next
Complete the steps that you started in “Uninstalling IBM MQ on Windows” on page 239.

Uninstalling IBM MQ using msiexec

You can uninstall IBM MQ by running the msiexec command from the command line to remove all
currently installed features, or selected features.

Before you begin

This task describes one of several uninstallation options that you can choose from when uninstalling IBM
MQ as described in “Uninstalling IBM MQ on Windows” on page 239. Before starting this task, refer to
“Uninstalling IBM MQ on Windows” on page 239 for more information.
If you no longer require the queue managers that are on the system, delete them by using the IBM MQ
Explorer or the dltmqm command.

About this task

You can use the msiexec command to uninstall IBM MQ either by running the msiexec command with
a parameter that calls a response file, or by entering the required msiexec parameters on the command
line.
Important: When specifying which features to remove with the REMOVE parameter:
• If you want to silently uninstall the Server feature, and the Web Administration (Web) feature
is installed, you must also silently uninstall the Web feature at the same time by specifying
REMOVE="Web,Server".
• If you want to silently uninstall the Java Runtime Environment (JRE) feature, and the Web
Administration (Web) feature is installed, you must also silently uninstall the Web feature at the same
time by specifying REMOVE="Web,JRE".
If you are running IBM MQ on Windows with User Account Control (UAC) enabled, you must invoke the
silent uninstallation from an elevated command prompt. Elevate a command prompt by using a right-click
to start the command prompt and choose Run as administrator.
In all of the examples of commands shown, the variable names used are as follows:
• installation_name is the name of the installation you want to remove.
• product_code is the value shown for MSIProdCode in the output of the following command:

dspmqinst -n installation_name

An example of a product code is {0730749B-080D-4A2E-B63D-85CF09AE0EF0}.

Procedure
• To silently uninstall IBM MQ by running the msiexec command with a parameter that calls a response
file:
a) Set which features to uninstall, and whether to keep existing queue managers in the response file.
A response file is an ASCII text file that contains the parameter values that you want to set for
the uninstallation. The response file has a format similar to a Windows .ini file, and contains the
stanza [Response]. This stanza contains parameters that the msiexec command can use, in the
form of property = value pairs. The msiexec command ignores any other stanzas in the file.
This is an example of a simple uninstallation [Response] stanza:

[Response] REMOVE="ALL"

242 Installing IBM MQ

 For more information about how to create a response file, including which parameters you can
specify, see “Creating and using a response file for server installation” on page 189.
b) To silently uninstall IBM MQ using the response file, enter the following
command: msiexec /x {product_code} /l*v "c:\removal.log" /q USEINI="response_file"
INSTALLATIONNAME="installation_name"
• To uninstall IBM MQ by entering the required msiexec parameters on the command line, enter one of
the following commands:
– To invoke an interactive uninstallation giving you the option to remove queue manager data
(providing there are no other IBM MQ installations remaining):

msiexec /x {product_code} /l*v "c:\removal.log" REMOVE="All"

INSTALLATIONNAME="installation_name"

If you are running IBM MQ on a Windows system with User Account Control (UAC) enabled, you
might see Open File - Security Warning dialog boxes during uninstallation that list International
Business Machines Limited as the publisher. Click Run to allow the uninstallation to continue.
– To invoke a silent uninstallation that does not remove any queue manager data:

msiexec /x {product_code} /l*v "c:\removal.log" /q REMOVE="All"

INSTALLATIONNAME="installation_name"

– To invoke a silent uninstallation and remove any queue manager data (only valid when removing the
final server installation):

msiexec /x {product_code} /l*v "c:\removal.log" /q REMOVE="All" KEEPQMDATA="delete"

INSTALLATIONNAME="installation_name"

– To monitor the progress of the uninstalling process and not remove any queue manager data:

msiexec /x {product_code} /l*v "c:\removal.log" INSTALLATIONNAME="installation_name"

If you are running IBM MQ on a Windows system with User Account Control (UAC) enabled, you
might see Open File - Security Warning dialog boxes during uninstallation that list International
Business Machines Limited as the publisher. Click Run to allow the uninstallation to continue.
– To invoke a silent uninstallation and not remove any queue manager data:

msiexec /x {product_code} /l*v "c:\removal.log" /q INSTALLATIONNAME="installation_name"

Results
After the command is entered, the command prompt immediately reappears and IBM MQ is uninstalled
as a background process. If you entered parameters to produce a log, check this file to see how the
uninstallation is progressing. If the uninstallation finishes successfully, you see the message Removal
completed successfully in the log file.

What to do next
Complete the steps that you started in “Uninstalling IBM MQ on Windows” on page 239.
Related concepts
“IBM MQ features for Windows systems” on page 163
You can select the features that you require when you install IBM MQ.
Related tasks
“Installing the server using msiexec” on page 185

Installing and uninstalling IBM MQ 243

 IBM MQ on Windows uses the MSI technology to install software. MSI provides both an interactive
installation and a non interactive installation.
“Modifying a server installation silently using msiexec” on page 208
You can silently remove or install IBM MQ features on Windows by using msiexec.

Uninstalling IBM MQ using MQParms

You can uninstall IBM MQ by running the MQParms command from the command line to remove all
currently installed features.

Before you begin

Start the uninstalling process by following the steps described in “Uninstalling IBM MQ on Windows” on
page 239.

Procedure
1. Follow the instructions on the MQParms installation pages to uninstall IBM MQ non-interactively. See:
“Installing the server using the MQParms command” on page 194.
a) Set the ADDLOCAL parameter to empty (ADDLOCAL="").
b) Set the REMOVE parameter to "ALL" (REMOVE="ALL").
2. If you have multiple versions of IBM MQ installed on your system, specify the product code that
identifies the installation you want to remove.
Type the following command:

MQParms.exe parameter_file/i "{product_code}"

where
• parameter_file is the file that contains the required parameter values. If this file is not in the
same folder as MQParms.exe, specify the full path and file name. If you do not specify a parameter
file, the default is MQParms.ini.
• product_code is the value shown for MSIProdCode in the output of the following command:

dspmqinst -n installation_name

where installation_name is the name of the installation you want to remove. An example of a
product code is {0730749B-080D-4A2E-B63D-85CF09AE0EF0}.

What to do next
Complete the steps that you started in “Uninstalling IBM MQ on Windows” on page 239.

Uninstalling IBM MQ on Windows using the installation media

You can uninstall IBM MQ by using the installation media to remove all currently installed features and
optionally remove existing queue managers and their data.

Before you begin

Start the uninstalling process by following the steps described in “Uninstalling IBM MQ on Windows” on
page 239.

Procedure
1. Insert the IBM MQ for Windows Server DVD into the DVD drive.
2. Start the installation process.

244 Installing IBM MQ

 • If autorun is enabled, the installation process starts automatically.
• If autorun is not enabled, double-click the Setup icon in the root folder of the DVD to start the
installation process.
The IBM MQ Installation Launchpad window opens.
3. Click IBM MQ Installation.
4. Click Launch IBM MQ Installer and click Next until the IBM MQ Program Maintenance panel is
displayed with a welcome message.
If this panel is not displayed, IBM MQ for Windows is not currently installed.
5. Click Maintain or upgrade an existing instance and if there is more than one installation of IBM
MQ on the system, select which installation you want to remove. Click Next and in the Program
Maintenance panel, click Remove, then Next.
6. If you are uninstalling the last or only server, and there are any queue managers on the system, the
Removing Server feature panel is shown.
Click one of the following options:
• Keep: keep existing queue managers and their objects.
• Remove: remove existing queue managers and their objects.
Click Next.
The Remove IBM MQ panel is displayed, with a summary of the installation to be removed.
7. Click Remove to continue.
If there are any messages that state that locked files are found, ensure that there are no IBM MQ
programs running; see “Uninstalling IBM MQ on Windows” on page 239.
When IBM MQ has been uninstalled, a message indicates completion.
8. Click Finish.

What to do next
Complete the steps that you started in “Uninstalling IBM MQ on Windows” on page 239.

Installing IBM MQ Advanced for Multiplatforms

Installation tasks associated with IBM MQ Advanced for Multiplatforms are grouped in this section.

About this task

IBM MQ Advanced is a single license entitlement that, in addition to IBM MQ itself, provides entitlement
to:
• Advanced Message Security
• Managed File Transfer
• MQ Telemetry

• Replicated data queue managers (RDQM)

For more information, see IBM MQ license information.

Procedure
• “Installing and uninstalling AMS on Multiplatforms” on page 246.
• “Installing Managed File Transfer ” on page 253.
• “Installing MQ Telemetry” on page 259.

•
“Installing RDQM (replicated data queue managers)” on page 265.

Installing and uninstalling IBM MQ 245

 Related tasks
“Installing IBM MQ Advanced for z/OS” on page 289
Installation of IBM MQ Advanced for z/OS consists of installation of the Managed File
Transfer (MFT) feature and the Connector Pack component. The Advanced Message Security (AMS)
feature does not require installation. You can choose to just install the MFT feature, just the Connector
Pack component, or both.
“Installing IBM MQ Advanced for z/OS Value Unit Edition” on page 291
IBM MQ Advanced for z/OS Value Unit Edition (VUE) is a bundling of the IBM MQ for z/OS VUE and IBM
MQ Advanced for z/OS products.
Related reference
DISPLAY QMGR ADVCAP
MQCMD_INQUIRE_Q_MGR MQIA_ADVANCED_CAPABILITY

Installing and uninstalling AMS on Multiplatforms

Installation and uninstallation, by platform, for Advanced Message Security (AMS) on Multiplatforms.

About this task

Advanced Message Security is a separately installed component of IBM MQ and is another option on
the IBM MQ installer. Make sure that you purchase a license for using IBM MQ Advanced before the
installation (see IBM MQ license information).

Procedure
• “Installing AMS on Multiplatforms” on page 246
• “Uninstalling AMS on Multiplatforms” on page 250

Installing AMS on Multiplatforms

Use the information for your platform to guide you through installing the Advanced Message Security
(AMS) component.

Before you begin

Make sure the following IBM MQ components are installed in your environment:
• MQSeriesRuntime
• MQSeriesServer

About this task

For information about installing Advanced Message Security follow the guidance for the appropriate
platform.

Procedure
• “Installing Advanced Message Security on AIX” on page 247
• “Installing Advanced Message Security on IBM i” on page 247
• “Installing Advanced Message Security on Linux” on page 248
• “Installing AMS on Windows using the Launchpad” on page 249

246 Installing IBM MQ

Installing Advanced Message Security on AIX
You can install Advanced Message Security component on AIX platforms using either system
management interface tool (SMIT) or the command line.

Installing using SMIT

Procedure
1. Log on as root.
2. Change the directory to the location of the installation packages.
3. Start the system management interface tool (SMIT).
The system management menu is displayed.
4. Select the required SMIT window using the following sequence:

Software Installation and Maintenance

Install and Update Software
Install Software

5. Enter the directory location of the installation package.

6. Press F4 to list the software in the SOFTWARE name option.
7. Select the mqm.ams.rte and press Enter.
8. Accept the default setting for the remaining options and press Enter.

Results
Advanced Message Security has been installed successfully.

Installing using command line

Procedure
1. Log on as root.
2. Set your current directory to the location of the installation file. The location might be the mount point
of the DVD, a network location, or a local file system directory.
3. Run the following command:

installp -a -c -Y -d. mqm.ams.rte

Note the period, signifying the current directory, following the -d parameter.

Results
Advanced Message Security component has been installed successfully.

Installing Advanced Message Security on IBM i

You can install Advanced Message Security component on IBM i.

Procedure
Install AMS using the command:

RSTLICPGM LICPGM(5724H72) DEV(installation device) OPTION(2) OUTPUT(*PRINT)

where the parameters of RSTLICPGM are:

LICPGM(5724H72)
The product identifier for IBM MQ for IBM i.

Installing and uninstalling IBM MQ 247

 DEV(installation device)
The device from which the product is to be loaded, typically an optical drive, for example, OPT01.
OPTION(2)
Install Advanced Message Security for IBM i
OUTPUT(*PRINT)
The output is printed with the spooled output of the job.

Results
The AMS component has been installed successfully.
Once AMS is installed on an IBM MQ server installation, any:
• Queue managers that are subsequently started enable security policy management features.
• Applications that connect to the queue manager enable interceptors.

What to do next
See Setting up certificates and the keystore configuration file on IBM i for details on setting up your
security policy.

Installing Advanced Message Security on Linux

You can install Advanced Message Security on Linux platforms.

Procedure
1. Log on as root.
2. Set your current directory to the location of the installation file. The location might be the mount point
of the server DVD, a network share, or a local file system directory.
3. If this installation is not the first installation on the system, you must run the crtmqpkg command to
create a unique set of packages to install on the system.
In order for the crtmqpkg command to run on Linux, the pax and rpmbuild commands must be
installed.
Important: pax and rpmbuild are not supplied as part of the product. You must obtain these from
your Linux distribution supplier.
a) Enter the following command:

./crtmqpkg suffix

where suffix is a name of your choosing, that uniquely identifies the installation packages on the
system. suffix is not the same as an installation name, although the names can be identical. suffix is
limited to 16 characters in the ranges A-Z, a-z, and 0-9.
Note: This command creates a full copy of the installation packages in a subdirectory of /var/tmp.
You must ensure that the system has enough space before running the command.
b) Set your current directory to the location specified when the crtmqpkg command completes.
This directory is a subdirectory of /var/tmp/mq_rpms, in which the unique set of packages is
created. The packages have the suffix value contained within the filename. For example, using a
suffix of "1":

./crtmqpkg 1

248 Installing IBM MQ

 there is a subdirectory named /var/tmp/mq_rpms/1/i386 and the packages are renamed, for
example:

From: MQSeriesAMS-V.R.M-F.i386.rpm
To: MQSeriesAMS_1-V.R.M-F.i386.rpm

where:
V
Represents the version of the product that you are installing
R
Represents the release of the product that you are installing
M
Represents the modification of the product that you are installing
F
Represents the fix pack level of the product that you are installing
4. In the command line, issue the following command:
This example shows a minimum installation:

rpm -iv package_name

where package_name is one of the following:

• MQSeriesAMS-V.R.M-F.i386.rpm
• MQSeriesAMS-V.R.M-F.x86_64.rpm
• MQSeriesAMS-V.R.M-F.ppc.rpm
• MQSeriesAMS-V.R.M-F.s390.rpm

Results
Advanced Message Security has been installed successfully.

Installing AMS on Windows using the Launchpad

Access the IBM MQ installation image. Run the Launchpad. Follow the instructions on screen to install the
Advanced Message Security component (AMS) on Windows.

Procedure
1. Access the IBM MQ installation image.
The location might be the mount point of a DVD, a network location, or a local file system directory. See
Where to find downloadable installation images.
2. Locate setup.exe in the base directory of the IBM MQ installation image.
• From a DVD, this location might be E:\setup.exe
• From a network location, this location might be m:\instmqs\setup.exe
• From a local file system directory, this location might be C:\instmqs\setup.exe
3. Start the installation process.
Either run setup.exe from a command prompt, or double-click setup.exe from Windows Explorer.
Note: If you are installing on a Windows system with UAC enabled, accept the Windows prompt to
allow the launchpad to run as elevated. During installation, you might also see Open File - Security
Warning dialog boxes that list International Business Machines Limited as the publisher. Click Run to
allow the installation to continue.
The IBM MQ Installation window is displayed.

Installing and uninstalling IBM MQ 249

 4. Follow the instructions on screen.

Uninstalling AMS on Multiplatforms

Use the information for your platform to uninstall the Advanced Message Security (AMS) component.

Procedure
• “Uninstalling AMS on AIX” on page 250
• “Uninstalling AMS on Linux” on page 251
• “Uninstalling AMS on Windows” on page 252
Related tasks
“Installing AMS on Multiplatforms” on page 246
Use the information for your platform to guide you through installing the Advanced Message Security
(AMS) component.

Uninstalling AMS on AIX

On AIX platforms, you can remove Advanced Message Security component either using SMIT or the
command line.

Procedure
1. Stop all IBM MQ applications associated with the installation you are uninstalling.
2. For a server installation, end any IBM MQ activity associated with the installation you are uninstalling:
a) Log in as a user in the group mqm.
b) Set up your environment to work with the installation you want to uninstall. Enter the following
command:

. MQ_INSTALLATION_PATH/bin/setmqenv

where . MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

c) Display the state of all queue managers on the system. Enter the following command:

dspmq -o installation

d) Stop all running queue managers associated with the installation you want to uninstall. Enter the
following command for each queue manager:

endmqm QMgrName

e) Stop any listeners associated with the queue managers. Enter the following command for each
queue manager:

endmqlsr -m QMgrName

3. Log in as root.
4. Uninstall AMS component using either installp or smit. If AMS component was installed in a
non-default location, you must use installp to uninstall.
• Uninstall using installp by entering one of the following commands:
– For an installation in the default location /usr/mqm

installp -u mqm.ams.rte

250 Installing IBM MQ

 – For an installation in a non-default location:

installp -R
usil -u mqm.ams.rte

where usil is the path of the User Specified Installation Location (USIL) specified when the
product was installed.
• Uninstall using smit:
a. Select the required smit window using the following sequence:

Software Installation and Maintenance

Software Maintenance and Utilities
Remove Installed Software

b. List the software in the SOFTWARE name field:

i) Enter .
ii) Press F4
c. Select the file sets to uninstall from the list (those beginning with mqm), and press Enter. There
is an option at this stage to do a preview. Leave the option set to the default value of Yes to
preview the file sets you are uninstalling, or select No to not preview these file sets.
d. Press Enter on the Remove Installed Software panel, it asks whether you are sure, press Enter.

Results
The Advanced Message Security component has been uninstalled.

Uninstalling AMS on Linux

Use the rpm command to remove Advanced Message Security component on Linux platforms.

Procedure
1. Stop all IBM MQ applications associated with the installation you are uninstalling.
2. For a server installation, end any IBM MQ activity associated with the installation you are uninstalling:
a) Log in as a user in the group mqm.
b) Set up your environment to work with the installation you want to uninstall. Enter the following
command:

. MQ_INSTALLATION_PATH/bin/setmqenv

where . MQ_INSTALLATION_PATH refers to the location where IBM MQ is installed.

c) Display the state of all queue managers on the system. Enter the following command:

dspmq -o installation

d) Stop all running queue managers associated with the installation you want to uninstall. Enter the
following command for each queue manager:

endmqm QMgrName

e) Stop any listeners associated with the queue managers. Enter the following command for each
queue manager:

endmqlsr -m QMgrName

Installing and uninstalling IBM MQ 251

 3. Log in as root.
4. Run the following command:

rpm -e package_name

where package_name is MQSeriesAMS-V.R.M-F

V
Represents the version of the product that you are uninstalling
R
Represents the release of the product that you are uninstalling
M
Represents the modification of the product that you are uninstalling
F
Represents the fix pack level of the product that you are uninstalling

Results
The Advanced Message Security component has been uninstalled.

Uninstalling AMS on Windows

You can uninstall Advanced Message Security component using the GUI uninstallation wizard, or a
command-line interface.

Using the installation wizard

Procedure
1. Insert the IBM MQ Server DVD into the DVD-ROM drive.
2. If autorun is enabled, the installation process starts.
Otherwise, double-click the Setup icon in the root folder of the DVD to start the installation process.
The IBM MQ Installation Launchpad window is displayed.
3. Click the IBM MQ Installation.
4. Click Launch IBM MQ Installer. Click Next until the IBM MQ Program Maintenance panel is displayed
with a welcome message.
If this panel is not displayed, IBM WebSphere MQ for Windows 7.5 is not installed on this machine.
When presented with the option, select to remove/maintain or upgrade.
5. Select Maintain or upgrade an existing instance, then click Next.
6. If there are any existing queue managers, the Removing Server feature panel is displayed.
Click one of the following options, then click Next:
• Keep - keep existing queue managers and their objects.
• Remove - remove existing queue managers and their objects.
The Program Maintenance panel is displayed, with a summary of the installation to be removed.
7. Click Modify and click Next.
8. On the list of available IBM MQ features, click Advanced Message Security, select Do not install this
feature (remove if already intalled), and click Next.
The Ready to modify IBM MQ panel appears with the summary of your changes.
9. Click Modify and Next on the following panel to continue.

Results
Selected features of Advanced Message Security component have been removed.

252 Installing IBM MQ

 Installing Managed File Transfer
From IBM WebSphere MQ 7.5 onwards, Managed File Transfer is installed as a component of IBM MQ on
AIX, Linux, and Windows. Managed File Transfer remains as a separate product on IBM i and z/OS.

Before you begin

Before you install Managed File Transfer, check that your system meets both the hardware and software
requirements of the product. See System Requirements for IBM MQ.
For all platforms, you must have one IBM WebSphere MQ 7.0, or higher, queue manager available in your
Managed File Transfer network to use as the coordination queue manager.
.

About this task

The following steps describe installing Managed File Transfer as a component of IBM MQ on
AIX, Linux, and Windows.
Note: If you are migrating or upgrading an existing IBM MQ installation, you must update database logger
instances before other parts of the Managed File Transfer network so that these instances can correctly
process the latest versions of the transfer log messages that they receive.

Procedure
1. Decide which Managed File Transfer components to install.
Managed File Transfer can be installed as four different options, depending on your operating system
and overall setup. These options are Managed File Transfer Agent, Managed File Transfer Service,
Managed File Transfer Logger, or Managed File Transfer Tools.
To decide which components to install, review the product options and topology information in the
following topics:
• Managed File Transfer product options
• Managed File Transfer topology overview
2. Install IBM MQ, including Managed File Transfer components.
For information about which specific components to install for your platform, including Managed File
Transfer, see “IBM MQ components and features” on page 6.
For more information about installing IBM MQ on AIX, Linux, and Windows, see the appropriate
information for your platform:

• “Installing and uninstalling IBM MQ on AIX” on page 32

• “Installing and uninstalling IBM MQ on Linux” on page 94

• “Installing and uninstalling IBM MQ on Windows” on page 162

Related concepts
Managed File Transfer
Managed File Transfer topology overview
Related tasks
Installing Managed File Transfer on IBM i
Installing IBM MQ for z/OS
Related reference
Installed MFT command sets

Installing and uninstalling IBM MQ 253

 The following table shows which Managed File Transfer commands are installed with each component.

Managed File Transfer product options

Managed File Transfer can be installed as four different options, depending on your operating system and
overall setup. These options are Managed File Transfer Agent, Managed File Transfer Service, Managed
File Transfer Logger, or Managed File Transfer Tools.

Managed File Transfer Agent

A file transfer agent connects to an IBM MQ queue manager, and transfers file data, as messages, to other
file transfer agents.
You install an agent through either the Managed File Transfer Agent or Managed File Transfer Service
installation options.
The Managed File Transfer Agent option installs an agent that has the following capabilities:
• Make client or bindings mode connections to queue managers.
Note: When the file transfer agent and queue manager are on the same system, consider using the
bindings mode connections.
• Transfer files to and from other Managed File Transfer agents.
• Transfer files to and from Connect:Direct® nodes.
The Managed File Transfer Service option, described in the next section, installs a file transfer agent that
also has additional capability to transfer files to and from legacy FTP, FTPS, or SFTP protocol servers.

Managed File Transfer Service

The Managed File Transfer Service option installs an agent that has the following capabilities:
• Make client or bindings mode connections to queue managers.
Note: When the file transfer agent and queue manager are on the same system, consider using the
bindings mode connections.
• Transfer files to and from other Managed File Transfer agents.
• Transfer files to and from Connect:Direct nodes.
• Create protocol bridge agents that transfer files to and from legacy SFTP, FTP, or FTPS protocol servers.
Some capabilities are available on only a subset of supported platforms. For more information, see IBM
MQ System Requirements.
A Managed File Transfer Service can only be installed on systems where the IBM MQ Server option is
already installed.

Managed File Transfer Logger

A file transfer logger connects to an MQ queue manager, often the queue manager that is designated as
the coordination queue manager, and logs audit-related file transfer data to either a database or a file. A
logger can only be installed on systems where the IBM MQ Server installation option is already installed.

Managed File Transfer Tools

The Managed File Transfer Tools are command line tools that you use to interact with file transfer agents.
The tools allow you to start file transfers, schedule file transfers and create resource monitors from the
command line. The Managed File Transfer Tools need not be installed on the same system as the file
transfer agents that they interact with.

254 Installing IBM MQ

Managed File Transfer Base

On AIX and Linux platforms, there is an additional Managed File Transfer Base installation component.
This component contains files common to all of the installation options. You must install the Managed File
Transfer Base component before installing any of the Agent, Logger, Service, or Tools components.
For more information about the IBM MQ components that are required for each product option on AIX and
Linux platforms, see the following topics:

• “Required MFT components on AIX” on page 255

• “Required MFT components on Linux” on page 256

Related concepts
Managed File Transfer introduction
Managed File Transfer topology overview

Required MFT components on AIX

Managed File Transfer can be installed as four different options, depending on your operating system and
overall setup. On AIX systems, these options are Managed File Transfer Agent, Managed File Transfer
Logger, Managed File Transfer Service, and Managed File Transfer Tools, and each option requires specific
components.

Managed File Transfer Agent

mqm.base.runtime
mqm.java.rte
mqm.jre.rte
mqm.ft.base
mqm.ft.agent

Managed File Transfer Logger

mqm.base.runtime
mqm.server.rte
mqm.java.rte
mqm.jre.rte
mqm.ft.base
mqm.ft.logger

Managed File Transfer Service

mqm.base.runtime
mqm.server.rte
mqm.java.rte
mqm.jre.rte
mqm.ft.base
mqm.ft.agent
mqm.ft.service

Installing and uninstalling IBM MQ 255

 Managed File Transfer Tools
mqm.base.runtime
mqm.java.rte
mqm.jre.rte
mqm.ft.base
mqm.ft.tools

Required MFT components on Linux

Managed File Transfer can be installed as four different options, depending on your operating system and
overall setup. On Linux systems, these options are Managed File Transfer Agent, Managed File Transfer
Logger, Managed File Transfer Service, and Managed File Transfer Tools, and each option requires specific
components.

Managed File Transfer Agent

MQSeriesRuntime
MQSeriesJava
MQSeriesJRE
MQSeriesFTBase
MQSeriesFTAgent

Managed File Transfer Logger

MQSeriesRuntime
MQSeriesServer
MQSeriesJava
MQSeriesJRE
MQSeriesFTBase
MQSeriesFTLogger

Managed File Transfer Service

MQSeriesRuntime
MQSeriesServer
MQSeriesJava
MQSeriesJRE
MQSeriesFTBase
MQSeriesFTAgent
MQSeriesFTService

Managed File Transfer Tools

MQSeriesRuntime
MQSeriesJava
MQSeriesJRE
MQSeriesFTBase

256 Installing IBM MQ

 MQSeriesFTTools

Installed MFT command sets

The following table shows which Managed File Transfer commands are installed with each component.
Table 35. Managed File Transfer commands available in each command set

Redistributable
Managed File
Agent command Service Tools command Logger command Transfer package
Command set command set set set set

fteAnt

fteBundleConfiguration (AIX, Linux,

and Windows
only)

fteCancelTransfer

fteChangeDefaultConfigurationOptio
ns

fteCleanAgent

fteCreateAgent

fteCreateBridgeAgent

fteCreateCDAgent (AIX, Linux, (AIX, Linux,

and Windows and Windows
only) only)

fteCreateEnvironment

fteCreateLogger

“1” on page
259

fteCreateMonitor

fteCreateTemplate

fteCreateTransfer

fteDefine (AIX, Linux,

and Windows
only)

fteDelete (AIX, Linux,

and Windows
only)

fteDeleteAgent

fteDeleteLogger

“1” on page
259

fteDeleteMonitor

fteDeleteScheduledTransfer

fteDeleteTemplates

fteDisplayVersion

Installing and uninstalling IBM MQ 257

Table 35. Managed File Transfer commands available in each command set (continued)

Redistributable
Managed File
Agent command Service Tools command Logger command Transfer package
Command set command set set set set

fteListAgents

fteListMonitors

fteListScheduledTransfers

fteListTemplates

fteMigrateAgent “2”
on page 259

fteMigrateConfigurationOptions
“2” on page 259

fteMigrateLogger
“2” on page 259

fteModifyAgent (Windows (Windows

only) only)

fteModifyLogger (Windows
only)
“1” on page
259

fteObfuscate

ftePingAgent

fteRAS

fteSetAgentLogLevel

fteSetAgentTraceLevel

fteSetLoggerTraceLevel

“1” on page
259

fteSetupCommands

fteSetupCoordination

fteShowAgentDetails

fteShowLoggerDetails

“1” on page
259

fteStartAgent

fteStartLogger

“1” on page
259

fteStopAgent

258 Installing IBM MQ

Table 35. Managed File Transfer commands available in each command set (continued)

Redistributable
Managed File
Agent command Service Tools command Logger command Transfer package
Command set command set set set set

fteStopLogger

“1” on page
259

Notes:

1. For Continuous Delivery from IBM MQ 9.2.1, the Redistributable Managed File Transfer
package also includes the Redistributable Managed File Transfer Logger. For more information, see
Downloading and configuring Redistributable Managed File Transfer components.

2. For Continuous Delivery, the fteMigrateAgent,

fteMigrateConfigurationOptions and fteMigrateLogger commands are removed at IBM MQ
9.2.1.

These commands are still available for IBM MQ 9.2 Long Term Support.

Installing MQ Telemetry
Installation tasks associated with MQ Telemetry are grouped in this section.

About this task

MQ Telemetry is installed as part of the IBM MQ server installation.
MQ Telemetry is a separately installed component of IBM MQ and is another option on the IBM MQ
installer. Make sure that you purchase a license for using IBM MQ Advanced before the installation (see
IBM MQ license information).

Procedure
• Install IBM MQ, including MQ Telemetry.
For information about which specific components to install for your platform, including MQ Telemetry,
see “IBM MQ components and features” on page 6.
For more information about installing IBM MQ on AIX, Linux, or Windows, see the appropriate
information for your platform:

– “Installing and uninstalling IBM MQ on AIX” on page 32

– “Installing and uninstalling IBM MQ on Linux” on page 94

– “Installing and uninstalling IBM MQ on Windows” on page 162

Installation considerations for MQ Telemetry

From IBM WebSphere MQ 7.1, MQ Telemetry is a component of the main IBM MQ product, and is no
longer a separate plugin. You can choose to install MQ Telemetry when you first install IBM MQ, or when
you modify an existing IBM MQ installation.

MQ Telemetry overview
See Introduction to MQ Telemetry for general details about MQ Telemetry.

Installing and uninstalling IBM MQ 259

 Support for IBM MQ Explorer
You can use IBM MQ Explorer to configure and manage the MQ Telemetry runtime component. For a
queue manager to accept connections from a telemetry device, one or more telemetry channels are
needed. To enable MQTT, there is a define sample configuration wizard that can be run from
IBM MQ Explorer. The wizard runs through a series of steps including defining and starting the telemetry
(MQXR) service, setting up the default transmission queue, and configuring a telemetry channel. For
more information about using the define sample configuration wizard, and any implications, see
“Verifying the installation of MQ Telemetry by using IBM MQ Explorer” on page 261.
The IBM MQ Explorer support provides the following capabilities:
• Telemetry node and content panel - providing welcome information, define sample configuration
wizard, run MQTT client utility, Help on MQ Telemetry, and status information about the MQ Telemetry
Service.
• Define sample configuration wizard - quickly configures a queue manager to support MQTT.
• New Telemetry Channel wizard - gathers information required to create a telemetry channel object.
• Telemetry Channels node and content panel - displays telemetry channels in the IBM MQ Explorer
Content view.
• Telemetry Channel Status node and content panel - displays telemetry channel status in the IBM MQ
Explorer Content view.
• MQTT Client Utility - provides a simple GUI for publishing and subscribing to topics.
• Help on MQ Telemetry.
You can install the MQ Telemetry runtime component on one system and configure and manage it
using the IBM MQ Explorer installed on another system. However, the components can be installed only
on systems with the appropriate prerequisites. For information about these prerequisites, see System
Requirements for IBM MQ.

MQ Telemetry client libraries and SDK

To help you write messaging applications for MQTT networks, you can install and use a set of free
example MQTT clients:
• In IBM WebSphere MQ 7.5, the client libraries were supplied with the product, in the Client Software
Development Kit (SDK).
• From IBM MQ 8.0, this SDK was no longer supplied as part of the product. Instead, a version of the
SDK was available as IBM Messaging Telemetry Clients SupportPac. This SupportPac was withdrawn in
September 2020.
• Example clients continue to be freely available from the Eclipse Paho downloads page.
Related concepts
MQ Telemetry
Telemetry use cases
Related tasks
Administering MQ Telemetry
Developing applications for MQ Telemetry
MQ Telemetry troubleshooting
Related reference
MQ Telemetry reference

260 Installing IBM MQ

Verifying the installation of MQ Telemetry
There are three ways to verify the installation of MQ Telemetry. Any can be used, regardless of whether
MQ Telemetry was installed as a custom installation of IBM MQ, or added to an existing installation of IBM
MQ.

About this task

Within IBM MQ you can verify the installation of MQ Telemetry either by using IBM MQ Explorer, or by
using the command line.
You can also verify the installation by using the MQTT messaging client for JavaScript in a browser that
supports the RFC 6455 (WebSocket) standard. A version of this client is installed with MQ Telemetry, and
the latest version is freely available from the Eclipse Paho downloads page. To verify the MQ Telemetry
installation you do not need the latest version of the client.

Procedure
• Verify your installation in one of the following ways:
• By using IBM MQ Explorer as described in “Verifying the installation of MQ Telemetry by using IBM
MQ Explorer” on page 261.
• By using the command line as described in “Verifying the installation of MQ Telemetry using the
command line” on page 263.

Verifying the installation of MQ Telemetry by using IBM MQ

Explorer
Use the Define sample configuration wizard and the MQTT client utility in IBM MQ Explorer to verify that
the MQ Telemetry components have installed. Also check that publish/subscribe works correctly.

Before you begin

The MQ Telemetry runtime and support for IBM MQ Explorer must be installed. The telemetry folder is
part of a queue manager. To view the telemetry folder, you must start a queue manager.
Before running the define sample configuration wizard on an existing queue manager, review the
information provided by the wizard about the configuration changes that are made. The changes might
have implications for the configuration of the existing queue manager. Alternatively, run the sample
configuration wizard on a newly created queue manager to avoid changing any security settings.

About this task

To configure MQ Telemetry there is a define sample configuration wizard that can be run from IBM MQ
Explorer. The wizard runs through a series of steps, including defining and starting the telemetry (MQXR)
service, setting up the default transmission queue, and configuring a telemetry channel.
If you would prefer to do this manually, see Configuring a queue manager for telemetry on Linux and AIX .
For Windows, see Configuring a queue manager for telemetry on Windows .
You can open the define sample configuration wizard from the MQ Telemetry Welcome page in IBM MQ
Explorer. The wizard determines which steps are required based on the current configuration.
For example, the following actions might be specified by the wizard:
• Define the telemetry (MQXR) service.
• Start the telemetry (MQXR) service.
• Define the telemetry transmit queue.
• Set the default transmit queue of the queue manager to SYSTEM.MQTT.TRANSMIT.QUEUE.

Installing and uninstalling IBM MQ 261

 If telemetry is already configured for this queue manager, the link to open the wizard is replaced with
static text. The text confirms that the sample configuration has been set up.
After the configuration has finished, you can use IBM MQ Explorer to open the MQTT client utility. Use the
MQTT client utility to verify that MQ Telemetry is set up correctly.
The following items summarize the main goals that can be achieved using the MQTT client utility:
• Validation of a basic or custom MQ Telemetry configuration by connecting, subscribing to topics and
publishing messages.
• Showcases the main features of MQTT protocol.
• Provides a simple tool to aid in debugging MQ Telemetry applications.
You can find additional information within the IBM MQ Explorer by using the Help menu or pressing the F1
key.

Procedure
1. Start IBM MQ Explorer.
On Windows and Linux systems, you can start IBM MQ Explorer by using the system menu, the
MQExplorer executable file, the mqexplorer command, or the strmqcfg command.
2. Open the Welcome to MQ Telemetry page.
• To use an existing queue manager, click on IBM MQ\Queue Managers\qMgrName\Telemetry
folder to open the Welcome to MQ Telemetry page.
• If, for the reasons mentioned, you decide to use a new queue manager,
a. Click Queue Managers > New > Queue Manager.
b. Type MQTTVerification as the Queue manager name > Next > Next > Next.
c. Change the default port in Listen on port number, if the port is in use > Finish.
d. When the queue manager starts, click on IBM MQ\Queue
Managers\MQTTVerification\Telemetry folder to open the Welcome to MQ Telemetry
page.
3. From the Welcome to MQ Telemetry page in IBM MQ Explorer, click Define sample configuration.
If this link is not present, and instead you see the text, "The sample configuration has been set up for
this queue manager", then telemetry has already been configured. Proceed to step “6” on page 262.
If you clicked Define sample configuration, the page opens, and lists actions that are to be performed
as part of the sample configuration.
4. Leave Launch MQTT client utility checked, if you want to automatically start the MQTT client utility.
The check box is selected by default.
5. Click Finish.
6. Click Connect.
In the MQTT client utility panel, ensure that the host and port names are correct.
If you did not automatically start the MQTT client utility panel in step 4, you can start it either by using
a direct link from the Welcome to MQ Telemetry panel, or by right-clicking a NON-TLS channel, which
allows you to control the channel it runs on.
The client history records a Connected event.
7. Click Subscribe.
The client history records a Subscribed event.
8. Click Publish.
The client history records a Published and Received event.

262 Installing IBM MQ

Results
If the publish/subscribe finishes successfully, the MQ Telemetry installation is verified.
If you encounter problems during the installation process, view the error log:
• On Windows, the default location for this log is, IBM MQ data directory\qmgrs\qMgrName\mqxr
• On AIX and Linux, the default location for this log is, /var/mqm/qmgrs/qMgrName/mqxr/

Verifying the installation of MQ Telemetry using the command line

Follow these instructions to run scripts and a sample application to verify that the MQ Telemetry
components have installed, and are able to publish and subscribe.

Before you begin

Note:
This task uses the mqttv3app sample Java application, and the associated Java client library. These
resources were previously available in the IBM Messaging Telemetry Clients SupportPac, and the detailed
instructions in this task assume that you have a copy of this SupportPac.
The IBM Messaging Telemetry Clients SupportPac is no longer available. Free downloads of the latest
telemetry clients and samples, for a range of programming languages, continue to be available from the
Eclipse Paho project, and from MQTT.org.
The telemetry (MQXR) service must be started to run the sample programs. The user ID must be a
member of the mqm group.
The SampleMQM script creates and uses a queue manager called MQXR_SAMPLE_QM. Therefore, do not
run unaltered on a system that already has a MQXR_SAMPLE_QM queue manager. Any changes made might
have implications for the configuration of the existing queue manager.
There are two commands to run the mqttv3app sample Java application. The first command creates a
subscription, then waits for a message. The second command publishes to that subscription. Therefore
the commands must be entered into different command lines or shell windows.

About this task

To perform verification on a server or device without a GUI, scripts are provided in the samples
directory. The SampleMQM script performs the required steps to configure MQ Telemetry. The mqttv3app
sample Java application can then be run to validate the basic or custom MQ Telemetry configuration by
connecting, subscribing to topics, and publishing messages. The CleanupMQM sample script can be run to
delete the queue manager created by the SampleMQM script.
The following items summarize the main goals that can be achieved using this verification procedure:
• Validate a basic or custom MQ Telemetry configuration by connecting, subscribing to topics and
publishing messages.
• Showcase the main features of the MQTT protocol.
• Provide a simple tool to aid in debugging MQ Telemetry applications.

Procedure
1. Decompress the IBM Messaging Telemetry Clients SupportPac into a directory of your own choosing.
This task uses the mqttv3app sample Java application, and the associated mqttv3 Java client library.
If you have the earlier (MA9B) version of the SupportPac, the sample applications and client libraries
are in the CLIENTPACKDIR/SDK/clients/java directory, where CLIENTPACKDIR is the directory in
which you decompressed the client pack.
Note: The later (MA9C) version of the IBM Messaging Telemetry Clients SupportPac does not have
the /SDK/ directory, and does not include a compiled copy of the mqttv3app sample application. If

Installing and uninstalling IBM MQ 263

 you have this version of the SupportPac, you need to compile the application manually, then create
the /SDK/ directory and contents. For the latest information about available clients and samples, see
IBM MQ Telemetry Transport sample programs.
2. Configure MQ Telemetry.
The SampleMQM script runs through a series of steps, including creating the MQXR_SAMPLE_QM queue
manager, defining and starting the telemetry (MQXR) service, setting up the default transmission
queue, and configuring a telemetry channel.
For information about performing this manually, see Configuring a queue manager for telemetry on
Linux and AIX , or Configuring a queue manager for telemetry on Windows .
• On Windows systems, enter the following command in a command line:

MQINSTDIR\mqxr\samples\SampleMQM.bat

• On AIX or Linux systems, enter the following command in a shell window:

MQINSTDIR/mqxr/samples/SampleMQM.sh

where MQINSTDIR is the installation directory for this installation of IBM MQ.
A queue manager called MQXR_SAMPLE_QM is created, and MQ Telemetry is configured.
3. Run the mqttv3app sample Java application to create a subscription.
• On Windows systems, enter the following commands in a command line:

java -cp
"CLIENTPACKDIR\SDK\clients\java\org.eclipse.paho.sample.mqttv3app.jar;
CLIENTPACKDIR\SDK\clients\java\org.eclipse.paho.client.mqttv3.jar"
org.eclipse.paho.sample.mqttv3app.Sample -a subscribe

• On AIX or Linux systems, enter the following commands in a shell window:

java -cp
CLIENTPACKDIR/SDK/clients/java/org.eclipse.paho.sample.mqttv3app.jar:
CLIENTPACKDIR/SDK/clients/java/org.eclipse.paho.client.mqttv3.jar
org.eclipse.paho.sample.mqttv3app.Sample -a subscribe

The subscription is created, and waits to receive a message.

4. Run the mqttv3app sample Java application to publish to the subscription.
• On Windows systems, enter the following command in a second command line:

java -cp
"CLIENTPACKDIR\SDK\clients\java\org.eclipse.paho.sample.mqttv3app.jar;
CLIENTPACKDIR\SDK\clients\java\org.eclipse.paho.client.mqttv3.jar"
org.eclipse.paho.sample.mqttv3app.Sample -m "Hello from an MQTT v3 application"

• On AIX or Linux systems, enter the following command in a second shell window:

java -cp
CLIENTPACKDIR/SDK/clients/java/org.eclipse.paho.sample.mqttv3app.jar:
CLIENTPACKDIR/SDK/clients/java/org.eclipse.paho.client.mqttv3.jar
org.eclipse.paho.sample.mqttv3app.Sample -m "Hello from an MQTT v3 application"

The message Hello from an MQTT v3 application, that you typed into the second command
line or shell window, is published by that application and received by the application in the first
window. The application in the first window shows it on the screen.
5. Press Enter in the first command line or shell window to end the subscribing application.
6. Remove the queue manager created by the SampleMQM script.
• On Windows systems, enter the following command in a command line:

MQINSTDIR\mqxr\samples\CleanupMQM.bat

264 Installing IBM MQ

 • On AIX or Linux systems, enter the following command in a shell window:

MQINSTDIR/mqxr/samples/CleanupMQM.sh

Results
If the scripts finished, and messages can be sent and received, the MQ Telemetry installation is verified.

What to do next
If you encounter any problems during the verification process, see MQ Telemetry troubleshooting. You
can also view the error log:
• On Windows systems, the default location for the queue manager log is
MQINSTDIR\qmgrs\MQXR_SAMPLE_QM\mqxr
• On AIX and Linux systems, the default location for the queue manager log is /var/mqm/qmgrs/
MQXR_SAMPLE_QM/mqxr/

Installing RDQM (replicated data queue managers)

RDQM is available on x86-64 for RHEL 7 (7.6 or later), RHEL 8 (8.2 or later), and RHEL 9.

Before you begin

RDQM requires that the mqm user has the same UID on each node and that the mqm group has the same
GID on each node. You should create the mqm IDs before running the installation procedure, using the
groupadd and useradd commands to set the UID and GID the same on each node. See “Setting up the
user and group on Linux” on page 99.
Pacemaker is one of the prerequisites for RDQM. Pacemaker requires that certain Linux packages are
installed on the system. The list for supported levels of RHEL 7 assumes that a minimal set of system
packages has been installed that includes of all the mandatory and default packages from the @core
package group and mandatory packages from the @base package group. The list for supported levels of
RHEL 8 and RHEL 9 assumes that a minimal set of system packages has been installed that includes the
mandatory and default packages from the mandatory groups of the Server environment group.

The prerequisites for supported levels of RHEL 7 (Pacemaker 1) are:

• cifs-utils
• libcgroup
• libtool-ltdl
• lm_sensors-libs
• lvm2
• net-snmp-agent-libs
• net-snmp-libs
• nfs-utils
• perl-TimeDate
• psmisc
• redhat-lsb-core

The prerequisites for supported levels of RHEL 8 (Pacemaker 2) are:

• cifs-utils
• libtool-ltdl
• libxslt

Installing and uninstalling IBM MQ 265

 • net-snmp-libs
• nfs-utils
• perl-TimeDate
• psmisc
• python36
• python3-lxml

The prerequisites for supported levels of RHEL 9 (Pacemaker 2) are:

• libxslt
• net-snmp-libs
• nfs-utils
• nfs-utils-coreos
• perl-TimeDate
• python3-lxml
• python-unversioned-command
These packages in turn have their own requirements (which are not listed here). When Pacemaker is
installed, it reports any missing packages that also need to be installed before installation can complete
successfully.
Note: The Pacemaker component of RDQM requires a user named hacluster and a group named
haclient. By default, these use a uid and gid of 189, although it is possible to specify a different uid and
gid if required. The installation of Pacemaker creates the user and group if they do not exist.

About this task

To install support for RDQM (replicated data queue managers), you complete the following tasks:
1. Install DRBD on each node.
2. Install Pacemaker on each node.
3. Install IBM MQ on each node.
4. Install RDQM on each node.
The DRBD and Pacemaker RPM packages are supplied on the IBM MQ media. You should install the
versions supplied with IBM MQ. Do not download your own versions. To ensure that the packages
supplied with RDQM are used, add the following line to the definition of any yum repository that could
supply alternatives, such as the AppStream repository in RHEL 8 or RHEL 9:

exclude=cluster* corosync* drbd kmod-drbd libqb* pacemaker* resource-agents*

For supported levels of RHEL 7, the components are found under the Advanced/RDQM/PreReqs/el7/
directory. For supported levels of RHEL 8, components are found under the Advanced/RDQM/
PreReqs/el8/ directory. For supported levels of RHEL 9, components are found under the Advanced/
RDQM/PreReqs/el9/ directory.
Attention: If you are using UEFI secure boot, you might need to enroll the key for the DRBD
kernel module. See https://linbit.com/drbd-user-guide/drbd-guide-9_0-en/#s-linbit-packages. If
UEFI secure boot is in use and the key is not enrolled, you will see the following error message.

modprobe: ERROR: could not insert 'drbd': Required key not available

The DRBD and Pacemaker packages are signed with the LINBIT GPG key. Use the following command to
import the public LINBIT GPG key:

rpm --import https://packages.linbit.com/package-signing-pubkey.asc

266 Installing IBM MQ

Without this step, an RPM install of these packages issues the following warnings:

warning: rpm-name: Header V4 DSA/SHA1 Signature, key ID 282b6e23: NOKEY"

You can have multiple IBM MQ installations on each server, but only one of these installations should be
an RDQM installation.
Attention: You should retain the installation media, in case there is a need to revert to this level,
after upgrading to a later level.

Procedure
Complete the following steps on each node:
1. Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux.
2. Change into the directory containing the installation image.
3. Determine which DRBD kernel module is needed for the system on which RDQM is being installed.
See https://ibm.biz/mqrdqmkernelmods for up-to-date kernel module information. Helper scripts are
provided in the kmod-drbd-9 directories. For example, on a RHEL 8.2 system, running the helper
script Advanced/RDQM/PreReqs/el8/kmod-drbd-9/modver returns the following information,
identifying the kernel module that you need to install:

kmod-drbd-9.0.23_4.18.0_193-1.x86_64.rpm

4. Install the appropriate DRBD kernel module that you identified in step 1. For example, for RHEL 8.2
you run the following command:

yum install Advanced/RDQM/PreReqs/el8/kmod-drbd-9/kmod-drbd-9.0.23_4.18.0_193-1.x86_64.rpm

5. Install the required DRBD utilities. For example, for RHEL 8.2 you run the following command:

yum install Advanced/RDQM/PreReqs/el8/drbd-utils-9/*

6. Install Pacemaker. For example, for RHEL 8.2 you run the following command:

yum install Advanced/RDQM/PreReqs/el8/pacemaker-2/*

The Pacemaker installer reports any missing packages that also need to be installed before the install
can complete successfully.
7. Accept the IBM MQ license:

./mqlicense.sh

8. Install IBM MQ. This is like a standard IBM MQ install. At the minimum, you must install the following:

yum install MQSeriesGSKit* MQSeriesServer* MQSeriesRuntime*

9. Install RDQM:

yum install Advanced/RDQM/MQSeriesRDQM*

What to do next
You can now configure the Pacemaker cluster and replicated data queue managers, or you can configure
disaster recovery replicated data queue managers. See RDQM high availability or RDQM disaster recovery.
Related tasks
Migrating replicated data queue managers
Applying maintenance level updates for RDQM

Installing and uninstalling IBM MQ 267

 Removing maintenance level updates for RDQM

Uninstalling RDQM (replicated data queue managers) if

no longer required
How to uninstall RDQM if it is no longer required.

Before you begin

If you have applied one or more fix packs to the version of IBM MQ that you want to uninstall, you need to
remove the fix packs in reverse chronological installation order before you remove the base packages.
You must remove any updates before starting the uninstallation procedure. For more information, see
Restoring the previous maintenance level on IBM MQ on Linux .
Important: You must stop all IBM MQ queue managers, other objects, and applications, before you begin
the process to uninstall or modify IBM MQ.

About this task

There are different procedures for uninstalling a high availability (HA) configuration, a disaster recovery
(DR) configuration, or a combined DR/HA configuration.
Important: The following commands are intended as an example of those that would be issued on a
system with a single IBM MQ installation. On systems with multiple IBM MQ installations, or where
there are other packages installed whose name includes either "drbd" or "linbit", the commands must be
updated to ensure that only the packages associated with this IBM MQ installation are removed.
For details of how to uninstall IBM MQ on a system with multiple MQ installations please see “Uninstalling
or modifying IBM MQ on Linux using rpm” on page 155.

Procedure
• To uninstall HA RDQM support if it is no longer required:
a) Delete the RDQM HA queue managers in the HA group, see Deleting an HA RDQM.
b) Delete the RDQM HA group, see Deleting the Pacemaker cluster (HA group).
c) Log in as root or switch to superuser using the su command.
d) If you configured a firewall, run the script MQ_INSTALLATION_PATH/samp/rdqm/firewalld/
unconfigure.sh on each node to undo the firewall configuration. You must run this script as
root.
e) To uninstall IBM MQ and RDQM:

rpm -qa | grep MQSeries | xargs yum -y remove

Alternatively, to uninstall RDQM but leave the IBM MQ installation:

rpm -qa | grep MQSeriesRDQM | xargs yum -y remove

f) Uninstall Pacemaker:

rpm -qa | grep linbit | xargs yum -y remove

g) Uninstall DRBD:

rpm -qa | grep drbd | xargs yum -y remove

• To uninstall DR RDQM support if it is no longer required:

a) Delete all queue managers on all nodes, see Deleting a DR RDQM.
b) Log in as root or switch to superuser using the su command.

268 Installing IBM MQ

 c) If you configured a firewall, run the script MQ_INSTALLATION_PATH/samp/rdqm/firewalld/
unconfigure.sh on each node to undo the firewall configuration. You must run this script as
root.
d) To uninstall IBM MQ and RDQM:

rpm -qa | grep MQSeries | xargs yum -y remove

Alternatively, to uninstall RDQM but leave the IBM MQ installation:

rpm -qa | grep MQSeriesRDQM | xargs yum -y remove

e) Uninstall Pacemaker:

rpm -qa | grep linbit | xargs yum -y remove

f) Uninstall DRBD:

rpm -qa | grep drbd | xargs yum -y remove

•
To uninstall DR/HA RDQM support if it is no longer required:
a) Delete the RDQM HA queue managers in both HA groups on main and recovery sites, see Deleting a
DR/HA RDQM.
b) Delete each RDQM HA group, see Deleting the Pacemaker cluster (HA group).
c) Log in as root or switch to superuser using the su command.
d) If you configured a firewall, run the script MQ_INSTALLATION_PATH/samp/rdqm/firewalld/
unconfigure.sh on each node to undo the firewall configuration. You must run this script as
root.
e) To uninstall IBM MQ and RDQM:

rpm -qa | grep MQSeries | xargs yum -y remove

Alternatively, to uninstall RDQM but leave the IBM MQ installation:

rpm -qa | grep MQSeriesRDQM | xargs yum -y remove

f) Uninstall Pacemaker:

rpm -qa | grep linbit | xargs yum -y remove

g) Uninstall DRBD:

rpm -qa | grep drbd | xargs yum -y remove

Related reference
rdqmadm (administer replicated data queue manager cluster)

Uninstalling RDQM (replicated data queue managers) and

upgrading
How to uninstall RDQM in preparation for upgrading IBM MQ and RDQM.

Before you begin

If you have applied one or more fix packs to the version of IBM MQ that you want to uninstall, you need to
remove the fix packs in reverse chronological installation order before you remove the base packages.
You must remove any updates before starting the uninstallation procedure. For more information, see
Restoring the previous maintenance level on IBM MQ on Linux .

Installing and uninstalling IBM MQ 269

 Important: You must stop all IBM MQ queue managers, other objects, and applications, before you begin
the process to uninstall or modify IBM MQ.

About this task

This topic describes upgrading RDQM between versions. To apply maintenance level updates to RDQM,
see Applying maintenance level updates for RDQM. There are different procedures for uninstalling and
then upgrading a high availability (HA) configuration, a disaster recovery (DR) configuration, or a combined
DR/HA configuration.
For HA configurations, complete steps on each node in the HA group in turn. Processing can continue on
other nodes while this is in progress.
For all configurations, if the upgrade is to a level of IBM MQ that is at a higher command level then, after
a queue manager has been started at the higher level, it cannot run on a node that has not yet been
upgraded. You should plan the sequence of upgrades accordingly.
Important: The following commands are intended as an example of those that would be issued on a
system with a single IBM MQ installation. On systems with multiple IBM MQ installations, or where
there are other packages installed whose name includes either "drbd" or "linbit", the commands must be
updated to ensure that only the packages associated with this IBM MQ installation are removed.
For details of how to uninstall IBM MQ on a system with multiple MQ installations please see “Uninstalling
or modifying IBM MQ on Linux using rpm” on page 155.

Procedure
• Uninstall HA RDQM support and upgrade RDQM and IBM MQ.
a) Suspend the HA group on the node, by entering the following command:

rdqmadm -s

b) Log in as root or switch to superuser using the su command.

c) Uninstall IBM MQ (this step also uninstalls RDQM):

rpm -qa | grep MQSeries | xargs yum -y remove

d) Uninstall Pacemaker:

rpm -qa | grep linbit | xargs yum -y remove

e) Uninstall DRBD:

rpm -qa | grep drbd | xargs yum -y remove

f) Verify that the DRBD kernel was successfully unloaded:

lsmod | grep drbd

If either the drbd or drbd_transport_tcp kernel modules are still loaded, they can be unloaded with
the following commands:

modprobe -r drbd_transport_tcp
modprobe -r drbd

If the unload fails for any reason, reboot the node.

g) Install the new level of IBM MQ and dependent software, see Installing RDQM (replicated data
queue managers).
h) Resume the HA group on the node by entering the following command:

rdqmadm -r

270 Installing IBM MQ

 You can now proceed to the next node in the group.
• Uninstall DR RDQM and IBM MQ and upgrade RDQM and IBM MQ.
a) Upgrade the DR secondary node:
a. Log in as root or switch to superuser using the su command.
b. Uninstall IBM MQ (this step also uninstalls RDQM):

rpm -qa | grep MQSeries | xargs yum -y remove

c. Uninstall Pacemaker:

rpm -qa | grep linbit | xargs yum -y remove

d. Uninstall DRBD:

rpm -qa | grep drbd | xargs yum -y remove

e. Verify that the DRBD kernel was successfully unloaded:

lsmod | grep drbd

If either the drbd or drbd_transport_tcp kernel modules are still loaded, they can be unloaded
with the following commands:

modprobe -r drbd_transport_tcp
modprobe -r drbd

If the unload fails for any reason, reboot the node.

f. Install the new levels of IBM MQ and RDQM, see Installing RDQM (replicated data queue
managers).
b) On the DR primary node, do one of the following steps:
– End the DR queue managers, or
– Perform a managed failover of the DR queue managers to the DR secondary node.
c) Upgrade the DR primary node:
a. Log in as root or switch to superuser using the su command.
b. Uninstall IBM MQ (this step also uninstalls RDQM):

rpm -qa | grep MQSeries | xargs yum -y remove

c. Uninstall Pacemaker:

rpm -qa | grep linbit | xargs yum -y remove

d. Uninstall DRBD:

rpm -qa | grep drbd | xargs yum -y remove

e. Verify that the DRBD kernel was successfully unloaded:

lsmod | grep drbd

If either the drbd or drbd_transport_tcp kernel modules are still loaded, they can be unloaded
with the following commands:

modprobe -r drbd_transport_tcp
modprobe -r drbd

If the unload fails for any reason, reboot the node.

Installing and uninstalling IBM MQ 271

 f. Install the new levels of IBM MQ and RDQM, see Installing RDQM (replicated data queue
managers).
d) On the DR primary node, do one of the following steps:
– Start the DR queue managers (if you previously ended them), or
– Perform a managed failover of the DR queue managers back to the DR primary node.

•
Uninstall DR/HA RDQM and IBM MQ and upgrade RDQM and IBM MQ.
a) Upgrade the HA group on your recovery site (presuming that the DR/HA RDQMs are running on the
main site). Complete the following steps on each node in the group in turn.
a. Log in as root or switch to superuser using the su command.
b. Suspend the HA group on the node, by entering the following command:

rdqmadm -s

c. Uninstall IBM MQ (this step also uninstalls RDQM):

rpm -qa | grep MQSeries | xargs yum -y remove

d. Uninstall Pacemaker:

rpm -qa | grep linbit | xargs yum -y remove

e. Uninstall DRBD:

rpm -qa | grep drbd | xargs yum -y remove

f. Verify that the DRBD kernel was successfully unloaded:

lsmod | grep drbd

If either the drbd or drbd_transport_tcp kernel modules are still loaded, they can be unloaded
with the following commands:

modprobe -r drbd_transport_tcp
modprobe -r drbd

If the unload fails for any reason, reboot the node.

g. Install the new level of IBM MQ and dependent software, see Installing RDQM (replicated data
queue managers).
h. Resume the HA group on the node by entering the following command:

rdqmadm -r

You can now proceed to the next node in the group.

b) On the HA group at the main site, either stop your queue managers, or perform a managed failover
to the HA group that you have just upgraded on the recovery site.
c) Upgrade the HA group on your main site. Complete the following steps on each node in the group in
turn.
a. Log in as root or switch to superuser using the su command.
b. Suspend the HA group on the node, by entering the following command:

rdqmadm -s

c. Uninstall IBM MQ (this step also uninstalls RDQM):

rpm -qa | grep MQSeries | xargs yum -y remove

272 Installing IBM MQ

 d. Uninstall Pacemaker:

rpm -qa | grep linbit | xargs yum -y remove

e. Uninstall DRBD:

rpm -qa | grep drbd | xargs yum -y remove

f. Verify that the DRBD kernel was successfully unloaded:

lsmod | grep drbd

If either the drbd or drbd_transport_tcp kernel modules are still loaded, they can be unloaded
with the following commands:

modprobe -r drbd_transport_tcp
modprobe -r drbd

If the unload fails for any reason, reboot the node.

g. Install the new level of IBM MQ and dependent software, see Installing RDQM (replicated data
queue managers).
h. Resume the HA group on the node by entering the following command:

rdqmadm -r

You can now proceed to the next node in the group.

d) You can now either start your queue managers (if you previously stopped them) or fail them back
over to the main site from the recovery site.
Related reference
rdqmadm (administer replicated data queue manager cluster)

Installing RDQM alongside other IBM MQ installations

You can install RDQM alongside other installations of IBM MQ although there can only be one RDQM
installation.

About this task

When installing multiple instances of IBM MQ on Linux with RPM, you must ensure that each installation is
made from packages with unique names. To create unique packages, you run the crtmqpkg command:

crtmqpkg PACKAGE_SUFFIX

Where PACKAGE_SUFFIX is a string added to package files to make them unique.

To install RDQM alongside existing IBM MQ installations, you must run crtmqpkg twice, once for the main
IBM MQ package and once for the RDQM component that has a separate rpm file under the Advanced/
RDQM subdirectory. For both commands, you should specify the same PACKAGE_SUFFIX. When you run
crtmqpkg for the RDQM package, you supply RPMDIR and SPECDIR arguments to specify where the
RDQM package files reside.
Note:
• By default, the crtmqpkg command writes to the /var/tmp directory. To use a different location, you
can set the TMPDIR environment variable before you run the crtmqpkg command.
• To run the crtmqpkg command used in this task, you must have the pax command or rpmbuild
installed.

Installing and uninstalling IBM MQ 273

 Procedure
To create unique installation packages for RDQM:
1. Decompress the downloaded software to your installation directory, see “Installing the first IBM MQ
installation on Linux using the rpm command” on page 113.
2. From your installation directory, create unique packages for the IBM MQ components:

./crtmqpkg RDQM

3. From your installation directory, create unique packages for the RDQM components:

RPMDIR=install_directory_path/MQServer/Advanced/RDQM SPECDIR=install_directory_path/MQServer/
Advanced/RDQM/repackage ./crtmqpkg RDQM

Where install_directory_path is the full path to your installation directory.

4. Install IBM MQ with RDQM using the packages you created in this task. Note that, as you are installing
an additional instance of IBM MQ, you will need to use the --prefix option with rpm to specify a
non-default installation location.
a) Change to the directory containing the unique packages that were created, for example:

cd /var/tmp/mq_rpms/RDQM/x86_64

b) Install IBM MQ and RDQM:

rpm -ivh --prefix /opt/customLocation MQSeriesGSKit* MQSeriesServer* MQSeriesRuntime*

MQSeriesRDQM*

Applying OS updates with RDQM

RDQM uses a DRBD kernel module which must be compatible with the current OS kernel level.
If OS updates are made which update the OS kernel level then a new DRBD kernel module might be
required. See https://ibm.biz/mqrdqmkernelmods for guidance on compatibility between DRBD kernels
and OS kernels.
Typically, a DRBD kernel update is required when the OS kernel branch is updated. For example, from
RHEL 7.7 (3.10.0_1062) to RHEL 7.8 (3.10.0_1127).
In this case, follow the procedure “Update DRBD kernel module before nodes are rebooted into a new
kernel” on page 274.
If you have already rebooted nodes into a new kernel, and find that RDQM does not run, follow the
procedure “Update DRBD kernel module after a node has rebooted into a new kernel” on page 277.

The rdqmstatus command gives information about the OS kernel level and DRBD kernel
module level, see Viewing RDQM and HA group status, Viewing DR RDQM status, and Viewing DR/HA
RDQM and HA group status.
Related tasks
Applying maintenance level updates for RDQM

Update DRBD kernel module before nodes are rebooted into a new kernel
If an OS update requires a DRBD kernel update, you should follow this procedure before you reboot the
nodes into the new OS kernel.

About this task

There are different procedures for updating the DRBD kernel module for a high availability (HA)
configuration, a disaster recovery (DR) configuration, or a combined DR/HA configuration.
For HA configurations, complete the steps on each node in the HA group in turn. Processing can continue
on other nodes while the update is in progress.

274 Installing IBM MQ

Procedure
• To update the DRBD kernel module before a node is rebooted into a new kernel for RDQM HA:
a) Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux. This information also applies to UNIX systems in general.
b) Suspend the node from the HA group:

rdqmadm -s

c) Update the OS. For example:

yum update

d) Determine which DRBD kernel module is compatible with the new kernel level (see https://
ibm.biz/mqrdqmkernelmods for guidance on which kernel module is compatible). For example,
for moving to RHEL 7.8 (3.10.0_1127) with IBM MQ 9.2.0.0, the required kernel module is kmod-
drbd-9.0.23_3.10.0_1127-1.x86_64.rpm.
e) Update the DRBD kernel module with the one you identified in step 4. For example:

yum install kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm

f) Reboot the node. This will reboot to the new kernel level:

sudo reboot

g) Resume the node in the HA group:

rdqmadm -r

You can now repeat this procedure for the next node in the HA group.
• To update the DRBD kernel module before nodes are rebooted into a new kernel for RDQM DR:
a) Update the OS and the DRBD kernel module on the DR secondary node:
a. Log in as root, or with sufficient authority to run the following commands.
b. Update the OS. For example:

yum update

c. Determine which DRBD kernel module is compatible with the new kernel level (see https://
ibm.biz/mqrdqmkernelmods for guidance on which kernel module is compatible). For example,
for moving to RHEL 7.8 (3.10.0_1127) with IBM MQ 9.2.0.0, the required kernel module is
kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm.
d. Update the DRBD kernel module with the one you identified in step c. For example:

yum install kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm

e. Reboot the node. This will reboot to the new kernel level:

sudo reboot

b) On the DR primary node, complete one of the following steps:

– End the DR queue managers, or
– Perform a managed failover of the DR queue managers to the DR secondary node.
c) Update the OS and the DRBD kernel module on DR primary node:
a. Log in as root, or with sufficient authority to run the following commands.
b. Update the OS. For example:

Installing and uninstalling IBM MQ 275

 yum update

c. Determine which DRBD kernel module is compatible with the new kernel level (see https://
ibm.biz/mqrdqmkernelmods for guidance on which kernel module is compatible). For example,
for moving to RHEL 7.8 (3.10.0_1127) with IBM MQ 9.2.0.0, the required kernel module is
kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm.
d. Update the DRBD kernel module with the one you identified in step c. For example:

yum install kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm

e. Reboot the node. This will reboot to the new kernel level:

sudo reboot

d) On the DR primary node, complete one of the following steps:

– Start the DR queue managers, or
– Perform a managed failover of the DR queue managers to the DR primary node.
• To update the DRBD kernel module before nodes are rebooted into a new kernel for RDQM DR/HA:
a) Update the OS and the DRBD kernel module on your recovery site. Complete the following steps on
each node in the group in turn.
a. Log in as root, or with sufficient authority to run the following commands.
b. Suspend the node from the HA group:

rdqmadm -s

c. Update the OS. For example:

yum update

d. Determine which DRBD kernel module is compatible with the new kernel level (see https://
ibm.biz/mqrdqmkernelmods for guidance on which kernel module is compatible). For example,
for moving to RHEL 7.8 (3.10.0_1127) with IBM MQ 9.2.0.0, the required kernel module is
kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm.
e. Update the DRBD kernel module with the one you identified in step d. For example:

yum install kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm

f. Reboot the node. This will reboot to the new kernel level:

sudo reboot

g. Resume the node in the HA group:

rdqmadm -r

You can now repeat this procedure for the next node in the HA group.
b) Update the OS and the DRBD kernel module on your main site. Complete the following steps on
each node in the group in turn.
a. Log in as root, or with sufficient authority to run the following commands.
b. Suspend the node from the HA group:

rdqmadm -s

c. Update the OS. For example:

yum update

276 Installing IBM MQ

 d. Determine which DRBD kernel module is compatible with the new kernel level (see https://
ibm.biz/mqrdqmkernelmods for guidance on which kernel module is compatible). For example,
for moving to RHEL 7.8 (3.10.0_1127) with IBM MQ 9.2.0.0, the required kernel module is
kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm.
e. Update the DRBD kernel module with the one you identified in step d. For example:

yum install kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm

f. Reboot the node. This will reboot to the new kernel level:

sudo reboot

g. Resume the node in the HA group:

rdqmadm -r

You can now repeat this procedure for the next node in the HA group.

Update DRBD kernel module after a node has rebooted into a new kernel
If a node was rebooted to a new OS kernel level and the DRBD kernel module is now incompatible with
the current OS kernel level then RDQM might fail to start correctly on the node.

About this task

For example, if a node was rebooted into a RHEL 7.8 (3.10.0_1127) kernel with a RHEL 7.7 (3.10.0_1062)
DRBD kernel module installed (for example, kmod-drbd-9.0.23_3.10.0_1062-1.x86_64), RDQM
does not start. The command rdqmstatus -m qmname shows an HA status of Unknown for an HA or
DR/HA queue manager, and a DR status of Unknown for a DR queue manager.
The queue manager will not run on this node until the issue is resolved.
The running kernel can be displayed by using the following command:

$ uname -r
3.10.0-1127.13.1.el7.x86_64

And the installed DRBD kernel module can be displayed by using the following command:

$ rpm -qa | grep kmod-drbd

kmod-drbd-9.0.23_3.10.0_1062-1.x86_64

To recover from this situation, complete the following procedure in turn on each node that has been
rebooted into a new kernel.

Procedure
1. Log in as root, or with sufficient authority to run the following commands.
You can do this by adding sudo before the commands, or by changing to the root user in the shell
with the su command. For more information, see Exploring the differences between sudo and su
commands in Linux.
2. Determine which DRBD kernel module is now needed for the system. Seehttps://ibm.biz/
mqrdqmkernelmods for up-to-date kernel module information. Helper scripts are provided in the
kmod-drbd-9 directories. For example, on a RHEL 7.8 system, running the helper script kmod-
drbd-9/modver returns the following information, identifying the kernel module that you need to
install:

kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm

3. Update the DRBD kernel module to the one that you identified in step 2. For example:

yum install kmod-drbd-9.0.23_3.10.0_1127-1.x86_64.rpm

Installing and uninstalling IBM MQ 277

 4. Reboot the node:

sudo reboot

Installing IBM MQ for z/OS

Installation tasks that are associated with installing IBM MQ on z/OS systems are grouped in this section.

About this task

IBM MQ for z/OS uses the standard z/OS installation procedure. It is supplied with a Program Directory
that contains specific instructions for installing the program on a z/OS system. You must follow the
instructions in the appropriate Program Directory. Program Directories can be downloaded from the IBM
Publications Center (see IBM MQ for z/OS Program Directory PDF files).
The Program Directory includes not only details of the installation process, but also information about the
prerequisite products and their service or maintenance levels.
SMP/E, used for installation on the z/OS platform, validates the service levels and prerequisite and
corequisite products, and maintains the SMP/E history records to record the installation of IBM MQ for
z/OS. It loads the IBM MQ for z/OS libraries and checks that the loads have been successful. You then
have to customize the product to your own requirements.
Before you install and customize IBM MQ for z/OS, you must decide the following:
• Whether you are going to install one of the optional national language features. See National language
support.
• Which communications protocol and distributed queuing facility you are going to use. See
Communications protocol and distributed queuing.
• What your naming convention for IBM MQ objects will be. See Naming conventions.
• What command prefix string (CPF) you are going to use for each queue manager. See Using command
prefix strings.
• When upgrading from a previous Continuous Delivery release through the installation of PTFs, decide
whether any USERMODs that have been applied to IBM MQ for z/OS will still be required. Remove the
USERMODs before installation of the Continuous Delivery PTFs, or use the SMP/E BYPASS(ID) option on
APPLY. If neither of these actions is performed, an SMP/E MODID ERROR GIM38201E will be received.
The PTFs for the latest Continuous Delivery release can be determined by using SMP/E FIXCAT
HOLDDATA category IBM.MQ.V9R0Mn, where n is the modification level. For example, category
IBM.MQ.V9R0M2 identifies fixes that upgrade IBM MQ for z/OS 9.0 Continuous Delivery to modification
level 2.
You also need to plan how much storage you require in your z/OS system to accommodate IBM MQ;
Planning your storage and performance requirements on z/OS helps you plan the amount of storage
required.

Procedure
1. Check that your system hardware, and software levels meet the minimum requirements.
See “Checking requirements on z/OS” on page 281.
2. Plan your installation
See “Planning to install IBM MQ for z/OS” on page 281.
3. Install and configure IBM MQ for z/OS, by following the instructions detailed in the Program Directory.
See also the information in the subtopics for further guidance.

278 Installing IBM MQ

 z/OS installation overview
IBM MQ functions are provided as a number of different products, which are installed together to provide
the capability required.

Note: From IBM MQ for z/OS 9.2, the Managed File Transfer for z/OS binary libraries are provided as part
of the base IBM MQ for z/OS installation.

“Changes caused by making IBM MQ Managed File Transfer for z/OS part of the base
product installation” on page 290, lists the major points this change makes to the installation process
from earlier versions of the product.
The different products are:
IBM MQ for z/OS
Provides IBM MQ capability, connectivity on and off the z/OS platform, and excellent integration
with z/OS software, such as CICS®, IMS, WebSphere Application Server, and Db2. Licensed under a
Monthly License Charge (MLC) model.
IBM MQ for z/OS Value Unit Edition (VUE)
Same functionality as IBM MQ for z/OS; licensed under a One Time Charge (OTC) model. Can coexist
and interact with IBM MQ MLC offerings in other LPARs.
Note that, from an installation perspective, the same FMIDs as for IBM MQ for z/OS are installed,
then the QMGRPROD attribute must be set to VUE, which changes product usage recording for billing
purposes.
IBM MQ Advanced for z/OS
Managed File Transfer (MFT) and Advanced Message Security (AMS) features, plus at Long Term
Support, the Connector Pack. IBM MQ Advanced for z/OS does not include entitlement to run queue
managers and so one of IBM MQ for z/OS or IBM MQ for z/OS VUE is a prerequisite.
The Advanced Message Security feature does not require installation. Both the Managed File Transfer
feature and the Connector Pack component are installed via separate FMIDs.
IBM MQ Advanced for z/OS Value Unit Edition
Bundling of IBM MQ for z/OS VUE and IBM MQ Advanced for z/OS.
From an installation perspective, the same FMIDs as IBM MQ for z/OS VUE and IBM MQ Advanced
for z/OS are installed. Once installed, the QMGRPROD attribute must be set to ADVANCEDVUE, which
changes product usage recording for billing purposes.

Features
The features are:
Advanced Message Security (AMS)
Provides end to end encryption of messages throughout the IBM MQ network. Data is encrypted at
rest, in memory, and when being transmitted over the network.
Managed File Transfer (MFT)
Provides the ability to integrate file data into an IBM MQ network, while providing reliable auditing,
management and recovery.

Connector Pack component (Long Term Support only)

The Connector Pack component provides the IBM Aspera fasp.io Gateway, which can improve the speed
of transfer of IBM MQ data in lossy, high latency, networks.

Installing and uninstalling IBM MQ 279

 Enablement
Enablement of IBM MQ for z/OS VUE or IBM MQ Advanced for z/OS VUE requires setting the QMGRPROD
attribute; enablement of Advanced Message Security requires setting the AMSPROD attribute.
For more information, see “Product usage recording with IBM MQ for z/OS products” on page 286.
Note: Enablement modules for these capabilities are no longer provided.

Licensing models
The two different licensing models, together with their associated bundles, are shown in the following
table:

Licensing Model Product Name Feature Product ID

MLC IBM MQ for z/OS 5655-MQ9
OTC IBM MQ for z/OS Value Unit 5655-VU9
Edition (VUE)
OTC Advanced Message See Note “1” on
Security( AMS) page 280 for more
information.
OTC Managed File Transfer (MFT) See Note “1” on
page 280 for more
information.
OTC IBM MQ Advanced for z/OS Advanced Message 5655-AV9
Security( AMS)

Managed File Transfer (MFT)

OTC IBM MQ Advanced for z/OS (all included) 5655-AV1
Value Unit Edition

Note:
1. As per the 9th July, 2019 announcement letter, 5655-AM9 IBM MQ Advanced Message Security
for z/OS and 5655-MF9 IBM MQ Managed File Transfer for z/OS are withdrawn from sale. Existing
customers can continue to use these products and will continue to receive fixes and future functional
updates (if a valid subscription and support contract is in place). The capabilities will continue to be
available to new and existing customers with IBM MQ Advanced for z/OS and IBM MQ Advanced for
z/OS VUE.

Installation
Program Directories provide instructions for SMP/E installation of the program materials on to a target
system. Program Directories can be downloaded from the IBM Publications Center (see IBM MQ for z/OS
Program Directory PDF files).
The Customizing IBM MQ for z/OS topics guide you through customization of the code, and creating
customized execution units, for example the queue manager and file transfer agents.
Related concepts
“Managed File Transfer product options” on page 254
Managed File Transfer can be installed as four different options, depending on your operating system and
overall setup. These options are Managed File Transfer Agent, Managed File Transfer Service, Managed
File Transfer Logger, or Managed File Transfer Tools.
Related tasks
Maintaining and migrating

280 Installing IBM MQ

Installing Advanced Message Security
Use the information for your platform to guide you through installing the Advanced Message Security
(AMS) component.

Checking requirements on z/OS

Before you install IBM MQ on z/OS, you must check for the latest information and system requirements.

About this task

A summary of the tasks that you must complete to check system requirements is listed here with links to
further information.

Procedure
1. Check that you have the latest information, including information on hardware and software
requirements.
See “Where to find product requirements and support information” on page 9.
2. Check that your systems meet the hardware and software requirements for IBM MQ on z/OS.
Before attempting to install and run IBM MQ for z/OS, ensure that your system hardware, and software
levels meet the minimum requirements. You can check the minimum required levels on the System
Requirements for IBM MQ website. Follow the links for the version of IBM MQ that you are installing in
and select the appropriate Detailed System Requirements report for z/OS. There are separate reports
for Long Term Support and Continuous Delivery.
3. Check that you have the correct licenses.
See “License requirements” on page 8 and IBM MQ license information.

Planning to install IBM MQ for z/OS

To install the IBM MQ product your hardware, and software environment must meet minimum
requirement levels. You must also consider the national language features, communications protocols,
and naming conventions to be used.

National language support

You can choose one of the following national languages for the IBM MQ operator messages and the IBM
MQ operations and control panels (including the character sets used). Each language is identified by one
of the following language letters:
C
Simplified Chinese
E
U.S. English (mixed case)
F
French
K
Japanese
U
U.S. English (uppercase)
The samples, IBM MQ commands, and utility control statements are available only in mixed case U.S.
English.

Communications protocol and distributed queuing

Installing and uninstalling IBM MQ 281

 The distributed queuing facility provided with the base product feature of IBM MQ can either use APPC
(LU 6.2), TCP/IP from IBM, or any TCP product which supports the z/OS Unix Sockets API. The distributed
queuing facility is also known as the channel initiator and the mover.
You must perform the following tasks to enable distributed queuing:
• Choose which communications interface to use. This can be either, or both, of the following:
– APPC (LU 6.2)
– TCP/IP
• Customize the distributed queuing facility and define the IBM MQ objects required.
• Define access security.
• Set up your communications. This includes setting up your TCPIP.DATA data set if you are using TCP/IP,
LU names, and side information if you are using APPC. This is described in Setting up communication for
z/OS .

Naming conventions

It is advisable to establish a set of naming conventions when planning your IBM MQ systems. The names
you choose will probably be used on different platforms, so you should follow the convention for IBM MQ,
not for the particular platform.
IBM MQ allows both uppercase and lowercase letters in names, and the names are case sensitive.
However, some z/OS consoles fold names to uppercase, so do not use lowercase letters for names unless
you are sure that this will not happen.
You can also use numeric characters and the period (.), forward slash (/), underscore (_) and percent (%)
characters. The percent sign is a special character to Security Server (previously known as RACF® ), so do
not use it in names if you are using Security Server as your External Security Manager. Do not use leading
or trailing underscore characters if you are planning to use the Operations and Control panels.
For more information, see Rules for naming IBM MQ objects.
Choosing names for queue managers and queue sharing groups

Each queue manager and queue sharing group within a network must have a unique name. Do
not use the same name for a queue manager and a queue sharing group. On z/OS the names of
queue managers and queue sharing groups can be up to four characters long. Each Db2 system and
data-sharing group within the network must also have a unique name.
The names of queue manager and queue sharing groups can use only uppercase alphabetic
characters, numeric characters, and dollar sign ($), number sign (#) or at sign (@); they must not
start with a numeric character. Queue sharing group names that are less than four characters long are
padded internally with at signs, so do not use names ending in the at sign.
The queue manager name is the same as the z/OS subsystem name. You might identify each
subsystem as a queue manager by giving it the name QM xx (where xx is a unique identifier), or you
might choose a naming convention like ADDX, where A signifies the geographic area, DD signifies the
company division, and X is a unique identifier.
You might want to use your naming convention to distinguish between queue managers and queue
sharing groups. For example, you might identify each queue sharing group by giving it the name QG
xx (where xx is the unique identifier).
Choosing names for objects

Queues, processes, name lists, and clusters can have names up to 48 characters long. Channels can
have names up to 20 characters long and storage classes can have names up to 8 characters long.

282 Installing IBM MQ

 If possible, choose meaningful names within any constraints of your local conventions. Any structure
or hierarchy within names is ignored by IBM MQ, however, hierarchical names can be useful for
system management. You can also specify a description of the object when you define it to give more
information about its purpose.
Each object must have a unique name within its object type. However, each object type has a separate
namespace, so you can define objects of different types with the same name. For example, if a queue
has an associated process definition, it is a good idea to give the queue and the process the same
name. It is also a good idea to give a transmission queue the same name as its destination queue
manager.
You could also use the naming convention to identify whether the object definition is private or
a global. For example, you could call a namelist project_group.global to indicate that the
definition is stored on the shared repository.
Application queues

Choosing names that describe the function of each queue helps you to manage these
queues more easily. For example, you might call a queue for inquiries about the company
payroll payroll_inquiry. The reply-to queue for responses to the inquiries might be called
payroll_inquiry_reply.
You can use a prefix to group related queues. This means that you can specify groups of queues for
administration tasks like managing security and using the dead-letter queue handler. For example, all
the queues that belong to the payroll application might be prefixed by payroll_. You can then define
a single security profile to protect all queues with names beginning with this prefix.
You can also use your naming convention to indicate that a queue is a shared queue. For example, if
the payroll inquiry queue was a shared queue, you might call it payroll_inquiry.shared.
Storage classes and coupling facility structures

The character set you can use when naming storage classes and coupling facility structures is limited
to uppercase alphabetic and numeric characters. You should be systematic when choosing names for
these objects.
Storage class names can be up to 8 characters long, and must begin with an alphabetic character. You
will probably not define many storage classes, so a simple name is sufficient. For example, a storage
class for IMS bridge queues could be called IMS.
Coupling facility structure names can be up to 12 characters long, and must begin with an alphabetic
character. You could use the name to indicate something about the shared queues associated with the
coupling facility structure (that they all belong to one suite of applications for example). Remember
that in the coupling facility, the structure names are the IBM MQ name prefixed by the name of the
queue sharing group (padded to four characters with @ symbols).
Choosing names for channels

To help you manage channels, it is a good idea if the channel name includes the names of the source
and target queue managers. For example, a channel transmitting messages from a queue manager
called QM27 to a queue manager called QM11 might be called QM27/QM11.
If your network supports both TCP and SNA, you might also want to include the transport type in the
channel name, for example QM27/QM11_TCP. You could also indicate whether the channel is a shared
channel, for example QM27/QM11_TCP.shared.
Remember that channel names cannot be longer than 20 characters. If you are communicating with
a queue manager on a different platform, where the name of the queue manager might contain more
than 4 characters, you might not be able to include the whole name in the name of the channel.

Installing and uninstalling IBM MQ 283

 Using command prefix strings

Each instance of IBM MQ that you install must have its own command prefix string (CPF). You use the
CPF to identify the z/OS subsystem that commands are intended for. It also identifies the z/OS subsystem
from which messages sent to the console originate.
You can issue all MQSC commands from an authorized console by inserting the CPF before the command.
If you enter commands through the system command input queue (for example, using CSQUTIL), or use
the IBM MQ operations and control panels, you do not use the CPF.
To start a subsystem called CSQ1 with CPF that is ' +CSQ1 ', issue the command +CSQ1 START QMGR
from the operator console (the space between the CPF and the command is optional).
The CPF also identifies the subsystem that is returning operator messages. The following example shows
+CSQ1 as the CPF between the message number and the message text.

CSQ9022I +CSQ1 CSQNCDSP ' DISPLAY CMDSERV' NORMAL COMPLETION

See Defining command prefix strings (CPFs) for information about defining command prefix strings.

Delivery media
IBM MQ for z/OS is supplied by DVD or electronic media. See the relevant product announcement letter
for complete information on product packaging.
The following language features are available:
• U.S. English (mixed case)
• U.S. English (uppercase)
• French
• Chinese
• Japanese
Refer to the IBM Offering Information site, where you can find more information on the Release For
Announcement (RFA) .

Customizing IBM MQ and its adapters

IBM MQ requires some customization after installation to meet the individual and special requirements of
your system, and to use your system resources in the most effective way.
For a list of tasks that you must perform when you customize your system, see Setting up IBM MQ for
z/OS.

Using queue sharing groups

If you want to use queue sharing groups, you do not have to set them up when you install IBM MQ, you
can do this at any time.
For details of how to manage your queue sharing groups when you have set them up, see Managing queue
sharing groups.

284 Installing IBM MQ

 Verifying your installation of IBM MQ for z/OS
After the installation and customization has been completed, you can use the installation verification
programs (IVPs) supplied with IBM MQ for z/OS to verify that the installation has been completed
successfully.
The IVPs supplied are assembler language programs and you should run them after you have customized
IBM MQ for z/OS to suit your needs. They are described in Running the basic installation verification
program.

Macros intended for customer use

The macros identified in this topic are provided as programming interfaces for customers in support of
features that are specific to IBM MQ for z/OS.
The 'C' include files, COBOL copy files, PL/I include files and assembler macros that are provided as
programming interfaces for customers in support of features that apply across many IBM MQ platforms
are described in the Constants.
Note: Do not use as programming interfaces any IBM MQ macros other than those interfaces identified in
this topic or in the Constants

General-use programming interface macros

The following assembler macros are provided to enable you to write programs that use the services of
IBM MQ. The macros are supplied in library thlqual.SCSQMACS.
• CMQXCALA
• CMQXCFBA
• CMQXCFCA
• CMQXCFLA
• CMQXCDFA
• CMQXCINA
• CMQXCVCA

Product-sensitive programming interface macros

The following assembler macros are provided to enable you to write programs that use the services of
IBM MQ. The macros are supplied in library thlqual.SCSQMACS. Product-sensitive interfaces are open to
change between different releases of the product.
• CSQBDEF
• CSQDQEST
• CSQDQIST
• CSQDQJST
• CSQDQLST
• CSQDQMAC
• CSQDQMST
• CSQDQPST
• CSQDQSST
• CSQDQWHC
• CSQDQWHS
• CSQDQ5ST
• CSQDWQ

Installing and uninstalling IBM MQ 285

 • CSQDWTAS
• CSQQDEFX
• CSQQLITX

Product usage recording with IBM MQ for z/OS products

z/OS can measure how much processing time is spent in doing work on behalf of the various processes
that make up the IBM MQ product. This is known as product usage recording.
Product usage recording works as follows:
• When the IBM MQ for z/OS product is started, it identifies itself to z/OS and requests that the System
Management Facilities (SMF) mechanism within z/OS is to automatically measure how much processor
time it uses.
• When enabled, the z/OS usage measurement facility collects usage figures for each hour of the day, and
generates usage records that are added to a report file on disk.
• At the end of one full month, these usage records are collected by a program, which generates a report
of product usage for the month. This report is used to determine the charge for the IBM MQ for z/OS
product.
For more information about product usage recording and the Sub-Capacity Reporting Tool (SCRT), see
Preparing to use the Sub-Capacity Reporting Tool. For information about the MULCCAPT parameter see,
Using CSQ6SYSP.
As IBM MQ for z/OS is available under several different product IDs (PIDs) you need to ensure that it
registers itself to z/OS with the PIDs that you are entitled to, which will ensure that you are charged
correctly.
This needs to be done for each of the different parts of the IBM MQ for z/OS product that you might be
running:
• Queue manager and channel initiator
• Advanced message security (AMS)
• Managed file transfer (MFT)
• mqweb server
This topic describes how you do this.

IBM MQ for z/OS product IDs

Product Product ID
IBM MQ for z/OS 5655-MQ9
IBM MQ for z/OS Value Unit Edition (VUE) 5655-VU9
IBM MQ Advanced for z/OS 5655-AV9
IBM MQ Advanced for z/OS VUE 5655-AV1

Note: From IBM MQ for z/OS 9.1.3, the older IBM MQ Advanced Message Security for z/OS and IBM MQ
Managed File Transfer for z/OS products are no longer available separately and are instead features of
IBM MQ Advanced for z/OS and IBM MQ Advanced for z/OS VUE.

Associating the queue manager and channel initiator with a PID

The queue manager and channel initiator address spaces are associated with a specific PID using the
QMGRPROD attribute. The following table shows how the value of the QMGRPROD attribute maps to a
product and PID:

286 Installing IBM MQ

QMGRPROD value Product Product ID
MQ IBM MQ for z/OS 5655-MQ9
VUE IBM MQ for z/OS VUE 5655-VU9
ADVANCEDVUE IBM MQ Advanced for z/OS VUE 5655-AV1

The product and PID used by the queue manager address space are output at start up in the CSQY036I
message. Note that the channel initiator does not output an equivalent message, but it uses the same
PID.
Prior to IBM MQ for z/OS 9.1.3, VUE mode for both IBM MQ for z/OS VUE and IBM MQ Advanced for
z/OS VUE could optionally be enabled using an enablement module. From IBM MQ for z/OS 9.1.3 that
enablement module is no longer shipped, and you must use the QMGRPROD attribute.
There are three distinct methods of setting the QMGRPROD attribute:
1. In the CSQ6USGP macro, which is part of the IBM MQ system parameter module. This is the approach
you should use for setting QMGRPROD permanently.
2. As a parameter on the START QMGR command. This needs to be set for each use of the command.
3. As a parameter on the JCL used to start the queue manager address space. See starting and stopping a
queue manager on z/OS for more information.
The second and third approaches can be useful the first few times that QMGRPROD is used, or for test
systems, and will override the values set by CSQ6USGP.

Associating AMS with a PID

The AMS address space is associated with a specific product using the AMSPROD attribute. The table
below shows how the value of the AMSPROD attribute maps to a particular product:

AMSPROD value Product Product ID

AMS IBM MQ Advanced Message Security for z/OS 5655-AM9
ADVANCED IBM MQ Advanced for z/OS 5655-AV9
ADVANCEDVUE IBM MQ Advanced for z/OS VUE 5655-AV1

Prior to IBM MQ for z/OS 9.1.3, an enablement module was required for the AMS address
space to start up. From IBM MQ for z/OS 9.1.3 that enablement module is no longer shipped. Instead, if
your enterprise wants to use Advanced Message Security, you must ensure that AMSPROD is set to one of
AMS, ADVANCED, or ADVANCEDVUE depending on what product you are entitled to. If SPLCAP(YES) is set
in CSQ6SYSP, indicating that the queue manager is to be enabled for AMS, but AMSPROD is not set, then
from IBM MQ for z/OS 9.1.3, the queue manager will not start and message CSQY024I will be output.
The product and PID used by the AMS address space are output at start up in the CSQ0619I message.
There are three distinct methods of setting the AMSPROD attribute:
1. In the CSQ6USGP macro, which is part of the IBM MQ system parameter module. This is the approach
you should use for setting AMSPROD permanently.
2. As a parameter on the START QMGR command. This needs to be set for each use of the command.
3. As a parameter on the JCL used to start the queue manager address space. See starting and stopping a
queue manager on z/OS for more information.
The second and third approaches can be useful the first few times that AMSPROD is used, or for test
systems, and will override the values set by CSQ6USGP.

Installing and uninstalling IBM MQ 287

 Associating Managed File Transfer with a PID
MFT processes are associated with a specific PID using the fteSetProductId command.

Associating the mqweb server with a PID

From IBM MQ for z/OS 9.2.0 the mqweb server, that hosts the IBM MQ Console and REST API, is
associated with the PID provided when it is created using the crtmqweb command.
Once an mqweb server has been created you can change its PID using the setmqweb pid command.
mqweb servers that were created prior to version 9.2.0 will, by default, use the IBM MQ for z/OS PID. You
can use the setmqweb pid command to change the PID that they run under if necessary.
You should not use the older manual approach for setting the mqweb server PID, which involved copying
properties files.
The PID used by the mqweb server is output at start up in the messages.log using the CWWKB0108I
message.
For IBM MQ for z/OS, this looks like:

CWWKB0108I: IBM CORP product MQM MVS/ESA version V9 R2.0 successfully registered with z/OS.

For IBM MQ for z/OS VUE, this looks like:

CWWKB0108I: IBM CORP product MQ z/OS VUE version NOTUSAGE successfully registered with z/OS.

For IBM MQ for z/OS Advanced VUE, this looks like:

CWWKB0108I: IBM CORP product MQ z/OS Adv VUE version NOTUSAGE successfully registered with z/OS.

Default PIDs
In most cases, if a specific PID is not selected, a default PID is used for:
• The queue manager and channel initiator, which is IBM MQ for z/OS
• mqweb servers created prior to version 9.2.0, which is IBM MQ for z/OS
• The AMS address space, which is IBM MQ Advanced Message Security for z/OS
• MFT processes, which is IBM MQ Managed File Transfer for z/OS

Sample scenarios
You have IBM MQ for z/OS
QMGRPROD does not need to be changed, the default PID of 5665-MQ9 is used.
You have installed a new IBM MQ Advanced for z/OS Value Unit Edition queue manager, and want to
enable AMS
In CSQ6USGP, set QMGRPROD=ADVANCEDVUE and AMSPROD=ADVANCEDVUE; the 5655-AV1 PID is
used.
Related reference
IBM MQ license information
IBM MQ product identifiers and export information

Installing and enabling IBM MQ for z/OS Value Unit

Edition
IBM MQ for z/OS Value Unit Edition (VUE) provides all the function and capability of base IBM MQ for
z/OS, in a format that offers a one-time-charge (OTC) price metric
The OTC price metric provides an alternative pricing model for IBM MQ for z/OS workloads.

288 Installing IBM MQ

VUE can connect to other supported versions of IBM MQ for z/OS for workload federation and systems
management.
The VUE feature allows connections from IBM MQ clients, that run on other platforms.

Enabling VUE
VUE uses the same code as IBM MQ for z/OS. From IBM MQ for z/OS 9.1.3 there is no separate
enablement module to be installed.
If your enterprise has purchased VUE, you can enable it by setting the QMGRPROD attribute to VUE.
See product usage recording with IBM MQ for z/OS products for more information about how to set
QMGRPROD.

Characteristics of a VUE-enabled queue manager

A VUE-enabled queue manager has all the function and capability of the base queue manager.
Additionally, clients will be enabled during channel initiator startup.
A VUE-enabled queue manager records usage information in SMF89 records with the product name and
identifier for VUE instead of those for the IBM MQ product.
A VUE-enabled queue manager can:
• Connect to other queue managers and clients in a network, according to the connectivity capabilities of
the base queue manager installation.
• Participate in a queue sharing group with other queue managers provided the base queue manager
versions are able to interoperate, regardless of whether other members are standard or VUE function
queue managers.

Installing IBM MQ Advanced for z/OS

Installation of IBM MQ Advanced for z/OS consists of installation of the Managed File
Transfer (MFT) feature and the Connector Pack component. The Advanced Message Security (AMS)
feature does not require installation. You can choose to just install the MFT feature, just the Connector
Pack component, or both.

Before you begin

Install either the IBM MQ for z/OS or IBM MQ for z/OS VUE products.

About this task

Use this topic to understand how you install IBM MQ Advanced for z/OS on your system.
Important: You should only make use of the IBM MQ Advanced Message Security for z/OS feature if you
have entitlement to one of the IBM MQ Advanced for z/OS, IBM MQ Advanced for z/OS VUE, or IBM MQ
Advanced Message Security for z/OS products.
You should only install and make use of the Managed File Transfer for z/OS feature if you have entitlement
to one of the IBM MQ Advanced for z/OS, IBM MQ Advanced for z/OS VUE, or IBM MQ Managed File
Transfer for z/OS products.
For information about licensing, see IBM MQ license information and IBM MQ for z/OS product identifiers.

Procedure
1. If you want to make use of Advanced Message Security, then no installation is required.
For more information on enabling and configuring AMS, see Configuring Advanced Message Security
for z/OS.

Installing and uninstalling IBM MQ 289

 2. If you want to make use of Managed File Transfer, first plan your Managed File Transfer installation.
For more information, see Planning for Managed File Transfer.
You should then install the Managed File Transfer feature by following the instructions detailed in the
IBM MQ Advanced for z/OS Program Directory.
The IBM MQ Advanced for z/OS Program Directory can be downloaded from the IBM Publications
Center (see IBM MQ for z/OS Program Directory PDF files).
3. If you want to make use of the function in the Connector Pack component, install it by following the
instructions detailed in the IBM MQ Advanced for z/OS Program Directory.

What to do next
When you have installed the product, you should follow the instructions in the Program Directory for
activating it.
Related tasks
Configuring Managed File Transfer for z/OS
Planning for Managed File Transfer

Changes caused by making IBM MQ Managed File

Transfer for z/OS part of the base product installation
Making Managed File Transfer for z/OS part of the base IBM MQ for z/OS product installation simplifies
the installation process, and causes some important changes listed in the following text.
The major changes are:
1. Existing “full product” Managed File Transfer for z/OS (MFT) FMID HMF9110 replaced with subordinate
“part of product” MFT FMID: JMS9xx7 where xx depends on exactly what is installed. For example
JMS9207 (IBM MQ 9.2.0 LTS) or JMS9CD7 (IBM MQ 9.2.0 CD)
Note: In this context JMS has no connection with the Java message service.
2. MFT moved from current component ID of 5655MF900 to base product component ID of 5655MQ900.
3. Installation customization job CSQ8ASYJ updated to allow optional install of MFT component and
customization of related JCL.

Attention: By default, this customization is not performed, to prevent accidental installation by

users who are not entitled to MFT.
4. Two additional JCL scripts have been included:
• CSQ8I7AL for allocation of necessary libraries for MFT, and
• CSQ8M7DD for allocation of DDEFs for MFT.
5. MFT has always required an installation of the z/OS UNIX System Services Component FMID. By
default, this installed into /usr/lpp/mqm/V9R2M0 (or similar for different versions), where:
• R is the number of the release
• M is the number of the modification
MFT used to be installed into a separate directory structure, and by default, this was /usr/lpp/
mqmfte/V9R1Mn/. Under that directory there were three separate directories:
• mqft: the bulk of the MFT install
• bin: the various fte* scripts for launching MFT processes
• java: two jar files containing prerequisites for MFT (com.ibm.mq.allclient.jar and jta.jar)
From IBM MQ for z/OS 9.2, MFT installs directly into the /usr/lpp/mqm/V9R2Mn directory that first
gets installed by the z/OS UNIX System Services (z/OS UNIX) component FMID.

290 Installing IBM MQ

 In addition to the contents of the existing mqft directory being installed, the bin directory is now
installed underneath the mqft directory. TheMFT java directory is no longer installed.
Note: The merging of the directory structures means that there is now a tight version link between
the version of MFT and the version of IBM MQ. That is, if you install Managed File Transfer for z/OS, it
needs to be in an IBM MQ for z/OS 9.2 installation.
6. The following MFT related data sets and their contents have been removed:
• SBFGINST
• ABFGINST
From IBM MQ for z/OS 9.2, MFT uses the IBM MQ for z/OS installation JCL in ACSQINST and
SCSQINST.
7. The following MFT related data sets have been kept, but renamed to use the CSQ prefix:
A|SBFGCMDS renamed to A|SCSQFCMD
JCL for running MFT agents and other tasks.
Note: The 44 JCL members, all named BFG*, contained in the renamed SCSQFCMD data set have
not been renamed.
ABFGOMSH renamed to ACSQOFSH
Part of install process (shell script for extracting ACSQOFPX).
ABFGOMPX renamed to ACSQOFPX
Part of install process (MFT z/OS UNIX files)
8. Installation packaging changes:
• The BFG8MPX1.pax file has been renamed to CSQ8FPX1.pax.
• The BFG8MSH1 shell script that is used to extract the CSQ8FPX1.pax file is renamed to CSQ8FSH1.
• The DDEF pointing to the MFT z/OS UNIX location has been renamed from SBFGMxxx to SCSQFxxx.
Related concepts
“Managed File Transfer product options” on page 254
Managed File Transfer can be installed as four different options, depending on your operating system and
overall setup. These options are Managed File Transfer Agent, Managed File Transfer Service, Managed
File Transfer Logger, or Managed File Transfer Tools.
Related tasks
Maintaining and migrating
Installing Advanced Message Security
Use the information for your platform to guide you through installing the Advanced Message Security
(AMS) component.

Installing IBM MQ Advanced for z/OS Value Unit Edition

IBM MQ Advanced for z/OS Value Unit Edition (VUE) is a bundling of the IBM MQ for z/OS VUE and IBM
MQ Advanced for z/OS products.

About this task

Use this topic to understand how you install IBM MQ Advanced for z/OS VUE on your system.

Procedure
• Install IBM MQ for z/OS Value Unit Edition.
For more information, see “Installing and enabling IBM MQ for z/OS Value Unit Edition” on page 288.
• Install IBM MQ Advanced for z/OS capabilities if required.
For more information, see “Installing IBM MQ Advanced for z/OS” on page 289.

Installing and uninstalling IBM MQ 291

 The IBM MQ Advanced for z/OS Value Unit Edition Program Directory can be downloaded from the IBM
Publications Center (see IBM MQ for z/OS Program Directory PDF files).
Related tasks
“Installing IBM MQ Advanced for Multiplatforms” on page 245
Installation tasks associated with IBM MQ Advanced for Multiplatforms are grouped in this section.
Related reference
DISPLAY QMGR ADVCAP
MQCMD_INQUIRE_Q_MGR MQIA_ADVANCED_CAPABILITY

Installing and uninstalling IBM MQ Explorer as a

stand-alone application on Linux and Windows
The stand-alone IBM MQ Explorer (formerly the MS0T SupportPac) enables you to use IBM MQ Explorer in
environments where IBM MQ (Server component) is not installed.

About this task

You can download the stand-alone IBM MQ Explorer from Fix Central and install it as a stand-alone
application, running on Linux or Windows, on as many machines as you require, either on its own or
alongside an installation of IBM MQ of the same version. However, you can only have a single installation
of the stand-alone IBM MQ Explorer on a given machine, regardless of version.
The installer is not fully translated. However, once installed, the stand-alone IBM MQ Explorer is available
in the same languages as IBM MQ Explorer from an IBM MQ Server installation.

Installing the stand-alone IBM MQ Explorer on Linux

On Linux, you can install the stand-alone IBM MQ Explorer by using the graphical user interface.
Alternatively, you can perform either a silent or a console installation.

Before you begin

Before you install the stand-alone IBM MQ Explorer, review the requirements information in IBM MQ
Explorer installation requirements.
If you already have a previous version of IBM MQ Explorer installed, uninstall that version with the
supplied uninstaller before proceeding with the installation of the new version. For more information, see
“Uninstalling the stand-alone IBM MQ Explorer on Linux” on page 294.
If you try to reinstall IBM MQ Explorer and you previously uninstalled it by deleting the files rather than
by using the supplied uninstaller, the message IBM MQ Explorer is already installed appears.
If this happens, you need to carry out some additional steps to return to a clean system before you can
reinstall the stand-alone IBM MQ Explorer as described in “Uninstalling the stand-alone IBM MQ Explorer
on Linux” on page 294.
Note: In addition to the space used by the installed program, the installer uses space in the /tmp
filesystem. You should allow at least 600MB for this, which will be freed after the installation is complete.
To use somewhere other than /tmp, export the IATEMPDIR environment variable as shown in the
following example:

export IATEMPDIR=/var/tmp

You must do this before running the command ./Setup.bin.

In addition, you should allow 400MB on a filesystem of your choosing for the tar.gz install image and its
contents once uncompressed.

292 Installing IBM MQ

About this task
After downloading the stand-alone IBM MQ Explorer from Fix Central and uncompressing the files, you
can install IBM MQ Explorer in any of the following ways:
• By using the installation wizard.
• By installing silently, using a response file.
• By performing a console (text-based) installation.
If you require an accessible version of the installer, then use the silent install mode to carry out
the installation. A response file is used to configure a silent installation. An example response file,
silent_install.resp is provided in the same directory as the IBM MQ Explorer Setup program. You
can modify this example file as required by using a text editor.

Procedure
1. Download the Linux version of stand-alone IBM MQ Explorer.
Follow this link to Fix Central and select the Linux version of the download package.
2. Create an installation directory on the target machine.
3. Uncompress the tar.gz file that you downloaded, for example, 9.2.0.0-IBM-MQ-Explorer-
LinuxX64.tar.gz, to this directory.
4. Install IBM MQ Explorer.
You can install in any of the following ways:
• To install by using the installation wizard:
a. Log in as root and navigate to the directory where you uncompressed the files.
b. Run the command ./Setup.bin (as root) and follow the onscreen instructions.
c. Launch IBM MQ Explorer either by using the system menu entry, or by using the MQExplorer
executable file in the installation directory.
• To install silently, using a response file:
a. Use a text editor to modify the example response file, silent_install.resp, as required.
Make your changes in line with the comments in the file.
Note: Before performing a silent install, the LICENSE_ACCEPTED property in the response file
must be set to TRUE to indicate that you agree to the terms of the product license. (The license
can be found in the license folder of the product .zip file).
b. Launch the silent install by using the following command:

./Setup.bin -f silent_install.resp

The installation then proceeds without any feedback.

• To perform a console (text-based) installation, launch the installer by using the following command:

./Setup.bin -i console

Note: If you see the following error message, this might be because you have the DISPLAY
environment variable set but do not have a valid X configuration:
Unable to load and to prepare the installer in console or silent mode.

If you do see this message, unset your DISPLAY environment variable and retry the operation in
console mode.
Related tasks
Launching IBM MQ Explorer

Installing and uninstalling IBM MQ 293

Uninstalling the stand-alone IBM MQ Explorer on Linux
On Linux, you uninstall the stand-alone IBM MQ Explorer by running the provided uninstaller.

About this task

On Linux, you uninstall the stand-alone IBM MQ Explorer by running the Change IBM MQ Explorer V9.2
Installation application.
If you remove the IBM MQ Explorer by deleting the files rather by than using the provided uninstaller, you
will be unable to reinstall the product at a later date unless you first carry out some additional steps to
return to a clean system. If you do try to reinstall IBM MQ Explorer after you previously uninstalled it by
deleting the files, the message IBM MQ Explorer is already installed appears.

Procedure
• To uninstall IBM MQ Explorer with the provided uninstaller, go to the installation directory and then
go in the directory named '_IBM MQ Explorer V9.2_installation', then run (as root) the
application named Change IBM MQ Explorer V9.2 Installation.
• If you need to get back to a clean system because you want to reinstall IBM MQ Explorer after
uninstalling it by deleting the files rather by than using the Change IBM MQ Explorer V9.2 Installation
application, complete the following steps:
a) Locate and edit the file .com.zerog.registry.xml.
The .com.zerog.registry.xml file is found either in the /var directory or alternatively in the
user's home directory. Make a backup of this file then edit it by deleting the section that begins with
the XML tag: '<product name="IBM MQ Explorer ' or '<product name="IBM WebSphere
MQ Explorer ' and ends with the next </product> tag. Save the file.
b) Delete the directory /etc/opt/ibm/MQ_Explorer and/or /etc/opt/ibm/
WebSphere_MQ_Explorer.
You should now be able to reinstall IBM MQ Explorer as described in “Installing the stand-alone IBM
MQ Explorer on Linux” on page 292.

Installing the stand-alone IBM MQ Explorer on Windows

On Windows, you can install the stand-alone IBM MQ Explorer by using the graphical user interface.
Alternatively, you can perform either a silent or a console installation.

Before you begin

The stand-alone installation image for IBM MQ Explorer is not currently supported on Windows Server
2019. For Windows Server 2019, install IBM MQ Explorer as part of the main IBM MQ product installation
(see “Installing and uninstalling IBM MQ on Windows” on page 162).
Before you install the stand-alone IBM MQ Explorer, review the requirements information in IBM MQ
Explorer installation requirements.
If you already have a previous version of IBM MQ Explorer installed, uninstall that version before
proceeding with the installation of the new version.

About this task

After downloading the stand-alone IBM MQ Explorer from Fix Central and uncompressing the files, you
can install IBM MQ Explorer in any of the following ways:
• By using the installation wizard.
• By installing silently, using a response file.
• By performing a console (text-based) installation.

294 Installing IBM MQ

If you require an accessible version of the installer, then use the silent install mode to carry out
the installation. A response file is used to configure a silent installation. An example response file,
silent_install.resp is provided in the same directory as the IBM MQ Explorer Setup program. You
can modify this example file as required by using a text editor.
Note: If you silently install the stand-alone IBM MQ Explorer on a Windows system with User Account
Control (UAC) enabled, you must also remove it silently and not by using Programs and Features in the
Control Panel.

Procedure
1. Download the Windows version of the stand-alone IBM MQ Explorer.
Follow this link to Fix Central and select the Windows version of the download package.
2. Create an installation directory on the target machine.
3. Uncompress the .zip file that you downloaded, for example, 9.2.0.0-IBM-MQ-Explorer-
Win64.zip, to this directory.
4. Install IBM MQ Explorer.
You can install in any of the following ways:
• To install by using the installation wizard:
a. Double-click Setup.exe and follow the onscreen instructions.
b. Launch IBM MQ Explorer either by using the Start Menu entry, or by using the MQExplorer
executable file in the installation directory.
• To install silently, using a response file:
a. Use a text editor to modify the example response file, silent_install.resp, as required.
Make your changes in line with the comments in the file.
Note: Before performing a silent install, the LICENSE_ACCEPTED property in the response file
must be sent to TRUE to indicate that you agree to the terms of the product license. (The license
can be found in the license folder of the product .zip file).
b. Launch the silent install by using the following command:

Setup.exe -f silent_install.resp

The installation then proceeds without any feedback.

• To perform a console (text-based) installation, launch the installer by using the following command:

Setup.exe -i console

Related tasks
Launching IBM MQ Explorer

Uninstalling the stand-alone IBM MQ Explorer on Windows

On Windows, you can either uninstall the stand-alone IBM MQ Explorer by using the Control Panel or by
performing a silent uninstallation.

About this task

On Windows, you can uninstall the stand-alone IBM MQ Explorer by using either Add or Remove
Programs or Programs and Features, unless you installed IBM MQ Explorer silently on a Windows
system with User Account Control (UAC). On Windows UAC platforms, if you performed a silent
installation, you must also perform the uninstallation silently,
If you see the following error message it is most likely because you are trying to use Programs and
Features to uninstall an installation of the stand-alone IBM MQ Explorer that was installed silently

Installing and uninstalling IBM MQ 295

 You do not have sufficient access to uninstall IBM MQ Explorer 9.2.
Please contact your system administrator.
.

Procedure
• To uninstall the stand-alone IBM MQ Explorer by using the Control Panel, use either Add or Remove
Programs or Programs and Features as appropriate.
• To perform a silent uninstallation, go to the directory named _IBM MQ Explorer
V9.2_installation in the installation directory and run the following command:

"Change IBM MQ Explorer V9.2 Installation.exe" -i silent

Installing and uninstalling IBM MQ Internet Pass-Thru

This section contains tasks to install any uninstall IBM MQ Internet Pass-Thru (MQIPT).

About this task

MQIPT is an optional component of IBM MQ that can be used to implement messaging solutions between
remote sites across the internet. For more information about MQIPT, see IBM MQ Internet Pass-Thru
If you are upgrading from a previous version of MQIPT, or applying maintenance to an MQIPT installation,
see Migrating IBM MQ Internet Pass-Thru.
Related tasks
Configuring IBM MQ Internet Pass-Thru

Installing MQIPT
IBM MQ Internet Pass-Thru (MQIPT) is available on AIX, Linux, and Windows. You can install MQIPT
wherever you want on your computer, and can have several installations on the same system.

About this task

Each installation can be used and maintained separately. For example, you can have different fix pack
levels of MQIPT installed in different locations if you choose.
The installation location is not fixed. MQIPT can be installed anywhere on the system. It is not necessary
to set the system PATH or CLASSPATH environment variables to refer to MQIPT.
The MQIPT commands can be invoked from any location and MQIPT automatically detects its own
location. You might choose to add the MQIPT bin directory to the PATH environment variable for
convenience, but it is not mandatory to do so.
You can also install MQIPT alongside previous versions of MQIPT. You can have only one installation of
MQIPT version 2.0 on the same system because of the installation method used by version 2.0.

Procedure
To install MQIPT, complete the following steps:
1. Download the MQIPT package for the platform you require from IBM Fix Central for IBM MQ. The
MQIPT packages for IBM MQ 9.2.x are available under the following names:

Platform Archive file

AIX 9.2.x.0-IBM-MQIPT-AIXPPC64.tar.Z
Linux x86 (64 bit) 9.2.x.0-IBM-MQIPT-LinuxX64.tar.gz
Linux zSeries 9.2.x.0-IBM-MQIPT-LinuxS390X.tar.gz

296 Installing IBM MQ

 Platform Archive file
Linux PPC (Little Endian) 9.2.x.0-IBM-MQIPT-LinuxPPC64LE.tar.gz
Windows (64 bit) 9.2.x.0-IBM-MQIPT-Win64.zip
2. Choose the location where you want MQIPT to be installed.
Create a new directory where you want MQIPT to be installed.
For example, on AIX and Linux, you might use the following command:

mkdir /opt/mqipt/installation1

When you unpack the MQIPT installation archive file, a directory called mqipt is created, and the
installation files are placed in this directory. On Windows, the MQIPT installation archive
file also contains a directory called META-INF that contains files relating to code signature verification.
3. Unpack the installation archive file into the MQIPT directory by using an appropriate tool for your
platform.
Note: The tar command on AIX and Linux systems must be run as the root user when installing
MQIPT. Failure to run the tar command as root is likely to result in "permission denied" errors.
For example, on a Linux platform, you might use the following commands, if the archive file was
downloaded to the /tmp directory:

cd /opt/mqipt/installation1
su root
tar xzvf /tmp/9.2.0.0-IBM-MQIPT-LinuxX64.tar.gz

4. To increase security, set the file permissions for the installed files so that they are read-only:

• On AIX or Linux systems, you can use the chmod command. For
example:

chmod -R a-w /opt/mqipt/installation1/mqipt

• On Windows platforms, right-click the installation directory and select Properties.

You can change the file permissions on the Security tab.
5. If you subsequently receive error message MQCPE080 Unable to determine MQIPT
installation directory, set the MQIPT_PATH environment variable to the absolute path of the
MQIPT installation directory.
You do not normally have to set the PATH or CLASSPATH environment variables for MQIPT because
the installation includes a Java runtime environment (JRE). However, under some circumstances
(for example, if you use symbolic links), MQIPT commands are unable to determine the installation
directory. This can be corrected by setting the MQIPT_PATH environment variable.
For example, if your installation directory is /opt/mqipt/installation1/mqipt, you might use
the following commands:

MQIPT_PATH=/opt/mqipt/installation1/mqipt
export MQIPT_PATH

6.
On Windows platforms, create MQIPT icons on the Start menu.
Run the following command from an administrator command prompt:

C:\mqipt_path\bin\mqiptIcons -install installation_name

where

Installing and uninstalling IBM MQ 297

 • mqipt_path is the directory where MQIPT is installed.
• installation_name is a name that you choose to distinguish this installation from any other. The name
is appended to the name of the MQIPT icons.

What to do next
Follow the scenarios in Getting started with IBM MQ Internet Pass-Thru to verify that MQIPT is installed
correctly, and to configure MQIPT in simple scenarios.
For information on configuring and administering MQIPT, see Administering and configuring IBM MQ
Internet Pass-Thru.

Uninstalling MQIPT
Follow this procedure to uninstall MQIPT.

Procedure
1. Make appropriate backups in case you later have to restore any data. See Making backups for details.
2. Prevent the system from trying to start MQIPT automatically, if the MQIPT service has been installed.

• On AIX and Linux, remove the MQIPT service by changing to the bin
directory in the MQIPT installation path, and issuing the following command:

./mqiptService -remove

• On Windows, follow these steps to stop and remove the MQIPT service:
a. Stop MQIPT from the Windows services panel.
b. Open an administration command prompt, go to the bin directory in the MQIPT installation
path, and enter the command:

mqiptService -remove

Note: Only the installation of MQIPT that installed the service can be used to remove it. Attempting to
remove the service using a different installation causes error MQCPE083.

3. On Windows platforms, remove the MQIPT icons from the Start menu by clicking the
MQIPT icon, Remove these icons on the Start menu.
4. Delete the directory where MQIPT is currently installed.
You will need to have root access to the system in order to delete the MQIPT installation directory.

298 Installing IBM MQ

Notices
This information was developed for products and services offered in the U.S.A.
IBM may not offer the products, services, or features discussed in this document in other countries.
Consult your local IBM representative for information on the products and services currently available in
your area. Any reference to an IBM product, program, or service is not intended to state or imply that
only that IBM product, program, or service may be used. Any functionally equivalent product, program, or
service that does not infringe any IBM intellectual property right may be used instead. However, it is the
user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service.
IBM may have patents or pending patent applications covering subject matter described in this
document. The furnishing of this document does not grant you any license to these patents. You can
send license inquiries, in writing, to:

IBM Director of Licensing

IBM Corporation
North Castle Drive
Armonk, NY 10504-1785
U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBM Intellectual Property
Department in your country or send inquiries, in writing, to:

Intellectual Property Licensing

Legal and Intellectual Property Law
IBM Japan, Ltd.
19-21, Nihonbashi-Hakozakicho, Chuo-ku
Tokyo 103-8510, Japan

The following paragraph does not apply to the United Kingdom or any other country where such
provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION
PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer of
express or implied warranties in certain transactions, therefore, this statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically
made to the information herein; these changes will be incorporated in new editions of the publication.
IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in
any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of
the materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without
incurring any obligation to you.
Licensees of this program who wish to have information about it for the purpose of enabling: (i) the
exchange of information between independently created programs and other programs (including this
one) and (ii) the mutual use of the information which has been exchanged, should contact:

IBM Corporation
Software Interoperability Coordinator, Department 49XA
3605 Highway 52 N
Rochester, MN 55901
U.S.A.

© Copyright IBM Corp. 2007, 2023 299

 Such information may be available, subject to appropriate terms and conditions, including in some cases,
payment of a fee.
The licensed program described in this information and all licensed material available for it are provided
by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement, or
any equivalent agreement between us.
Any performance data contained herein was determined in a controlled environment. Therefore, the
results obtained in other operating environments may vary significantly. Some measurements may have
been made on development-level systems and there is no guarantee that these measurements will be
the same on generally available systems. Furthermore, some measurements may have been estimated
through extrapolation. Actual results may vary. Users of this document should verify the applicable data
for their specific environment.
Information concerning non-IBM products was obtained from the suppliers of those products, their
published announcements or other publicly available sources. IBM has not tested those products and
cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM
products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of
those products.
All statements regarding IBM's future direction or intent are subject to change or withdrawal without
notice, and represent goals and objectives only.
This information contains examples of data and reports used in daily business operations. To illustrate
them as completely as possible, the examples include the names of individuals, companies, brands, and
products. All of these names are fictitious and any similarity to the names and addresses used by an
actual business enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which illustrate programming
techniques on various operating platforms. You may copy, modify, and distribute these sample programs
in any form without payment to IBM, for the purposes of developing, using, marketing or distributing
application programs conforming to the application programming interface for the operating platform
for which the sample programs are written. These examples have not been thoroughly tested under
all conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these
programs.
If you are viewing this information softcopy, the photographs and color illustrations may not appear.

Programming interface information

Programming interface information, if provided, is intended to help you create application software for
use with this program.
This book contains information on intended programming interfaces that allow the customer to write
programs to obtain the services of WebSphere MQ.
However, this information may also contain diagnosis, modification, and tuning information. Diagnosis,
modification and tuning information is provided to help you debug your application software.
Important: Do not use this diagnosis, modification, and tuning information as a programming interface
because it is subject to change.

Trademarks
IBM, the IBM logo, ibm.com®, are trademarks of IBM Corporation, registered in many jurisdictions
worldwide. A current list of IBM trademarks is available on the Web at "Copyright and trademark
information"www.ibm.com/legal/copytrade.shtml. Other product and service names might be trademarks
of IBM or other companies.
Microsoft and Windows are trademarks of Microsoft Corporation in the United States, other countries, or
both.

300 Notices
UNIX is a registered trademark of The Open Group in the United States and other countries.
Linux is a registered trademark of Linus Torvalds in the United States, other countries, or both.
This product includes software developed by the Eclipse Project (https://www.eclipse.org/).
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or
its affiliates.

Notices 301
302 Installing IBM MQ
IBM®

Part Number:

(1P) P/N: