setmqinst

Set IBM® MQ installations, on UNIX, Linux®, and Windows.

Purpose

You can use the setmqinst command to change the installation description of an installation, or to set or unset an installation as the primary 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.

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.

On UNIX platforms 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.

On UNIX or Linux systems, you must run this command as root. On Windows systems, 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.

Syntax

Read syntax diagramSkip visual syntax diagram setmqinst Action Installation
Action
Read syntax diagramSkip visual syntax diagram-i-x-dDescriptiveText
Installation
Read syntax diagramSkip visual syntax diagram-pInstallationPath-nInstallationName-pInstallationPath-nInstallationName1-nInstallationName-pInstallationPath1
Notes:
  • 1 When specified together, the installation name and installation path must refer to the same installation.

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. You must use double quotation marks around the path if it contains spaces

Return codes

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

  1. This command sets the installation with the name of myInstallation as the primary installation: 
    
setmqinst -i -n myInstallation
  2. This command sets the installation with an installation path of /opt/myInstallation as the primary installation: 
    
setmqinst -i -p /opt/myInstallation
  3. This command unsets the installation named myInstallation as the primary installation: 
    
setmqinst -x -n myInstallation
  4. This command unsets the installation with an installation path of /opt/myInstallation as the primary installation: 
    
setmqinst -x -p /opt/myInstallation
  5. 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.