setmqinst (set IBM MQ installation)

Set IBM® MQ installations, on AIX®, Linux®, and Windows and IBM i.

Purpose

You can use the setmqinst command to change the installation description of an installation, to set or unset an installation as the primary installation, or to set the entitlement of the installation. To change the primary installation, you must unset the current primary installation before you can set a new primary installation. This command updates information contained in the mqinst.ini file.

You can use the dspmqinst command to display the installations.

After unsetting the primary installation, the setmqinst command will not be available unless you specify the full path or have an appropriate installation directory on your PATH (or equivalent). The default path in a system standard location will have been deleted.

[AIX] [Linux] On AIX and Linux, you should not assume that the current directory is in the path. If you are in /opt/mqm/bin and want to run, for example, /opt/mqm/bin/dspmqver, you need to enter "/opt/mqm/bin/dspmqver" or "./dspmqver".

File mqinst.ini contains information about all IBM MQ installations on a system. For more information about mqinst.ini, see Installation configuration file, mqinst.ini.

Attention: Only the user root can run this command.

On AIX and Linux, you must run this command as root. On Windows, you must run this command as a member of the Administrators group. The command does not have to be run from the installation you are modifying.

Note: By default, user mqm does not have sufficient authority to use this command.

[MQ 9.3.0 Jun 2022] [IBM i] From IBM MQ 9.3.0, this command is supported on IBM i to set and unset HA Replica and Non-Production IBM License Metric Tool (ILMT) tags for an installation.

Syntax

Action

Installation

Entitlement

Parameters

-d DescriptiveText

Text that describes the installation.

The text can be up to 64 single-byte characters, or 32 double-byte characters. The default value is all blanks. You must use double quotation marks around the text if it contains spaces.

-i

Set this installation as the primary installation.

-x

Unset this installation as the primary installation.

-n InstallationName

The name of the installation to modify.

-p InstallationPath

The path of the installation to modify, for example, opt/mqm. You must use double quotation marks around the path if it contains spaces.

-l entitlement -e y|yes|n|no

Set or unset the entitlement of the installation.

The entitlement can be set only if an applicable component is installed and entitlement is not already set to IBM MQ Advanced for Developers. entitlement is one of the following values:

hareplica: Sets the entitlement to High Availability Replica.; The hareplica entitlement cannot be set with the IBM MQ Advanced (Non-production) entitlement.
advanced: Sets the entitlement to IBM MQ Advanced.
nonprod: For Continuous Delivery from IBM MQ 9.3.4, sets the entitlement to IBM MQ (Non-Production) or IBM MQ Advanced (Non-Production), depending on whether the installation is IBM MQ Advanced or not.
For Long Term Support (and Continuous Delivery before IBM MQ 9.3.4), sets the entitlement to IBM MQ Advanced (Non-Production).; The nonprod entitlement cannot be set with the High Availability Replica entitlement. The server component must be installed to set this entitlement.

From IBM MQ 9.3.0, you can set the options of hareplica and nonprod for entitlement on IBM i.

The entitlement is picked up automatically by the IBM License Metric Tool (ILMT) after it is set. See IBM MQ license information.

Use -e y or -e yes to set the entitlement.

Use -e n or -e no to unset the entitlement.

Return codes

Table 1. Return code identifiers and descriptions
Return code	Description
0	Entry set without error
36	Invalid arguments supplied
37	Descriptive text was in error
44	Entry does not exist
59	Invalid installation specified
71	Unexpected error
89	ini file error
96	Could not lock ini file
98	Insufficient authority to access ini file
131	Resource problem

Examples

This command sets the installation with the name of myInstallation as the primary installation:
```
setmqinst -i -n myInstallation
```
This command sets the installation with an installation path of /opt/myInstallation as the primary installation:
```
setmqinst -i -p /opt/myInstallation
```
This command unsets the installation named myInstallation as the primary installation:
```
setmqinst -x -n myInstallation
```
This command unsets the installation with an installation path of /opt/myInstallation as the primary installation:
```
setmqinst -x -p /opt/myInstallation
```
This command sets the descriptive text for the installation named myInstallation:
```
setmqinst -d "My installation" -n myInstallation
```
The descriptive text is enclosed in quotation marks as it contains spaces.
This command specifies that the installation at /opt/myInstallation has High Availability Replica entitlement:
```
setmqinst -l hareplica -e yes -p /opt/myInstallation
```
This command specifies that the installation myInstallation does not have High Availability Replica entitlement:
```
setmqinst -l hareplica -e no -n myInstallation
```
This command specifies that the installation myInstallation has non-production entitlement:
```
setmqinst -l nonprod -e y -n myInstallation
```
This command specifies that the installation at /opt/myInstallation does not have non-production entitlement:
```
setmqinst -l nonprod -e n -p /opt/myInstallation
```