+

Search Tips | Advanced Search

IBM MQ Internet Pass-Thru configuration reference

IBM MQ Internet Pass-Thru (MQIPT) uses a configuration file called mqipt.conf to define routes and to control the actions of the MQIPT server. From Version 9.2, configuration properties for the mqiptAdmin command can also be specified in a properties file.


The MQIPT configuration file

The MQIPT configuration file comprises a number of sections. There is one [global] section, and an additional [route] section for each route through MQIPT that has been defined.

Each section contains name/value property pairs. Some properties can appear only in the [global] section, some can appear only in the [route] sections, and some can appear both in [route] and [global] sections. If a property appears in both route and [global] sections, the value of the property in the [route] section overrides the global value, but only for the route in question. In this way, the [global] section can be used to establish the default values to be used for those properties not set in the individual [route] sections.

The [global] section starts with a line containing the characters [global] and ends when the first [route] section starts. The [global] section must precede all [route] sections in the file.

Each [route] section starts with a line containing the characters [route] and ends when the next [route] section starts, or when the end of the configuration file is reached.

Any unrecognized property name is ignored. If a property in a [route] section has a recognized name but has an invalid value (for example MinConnectionThreads=x or HTTP=unsure), that route is disabled (that is, it does not listen for any incoming connections).

Invalid values for properties in the [global] section might prevent MQIPT, or the command server, from starting. If the command server does not start, MQIPT does not listen for administrative commands sent by the mqiptAdmin command to the affected command port. If properties with invalid values in the [global] section are present when MQIPT is refreshed, a warning message is issued and the effective value of the property remains unchanged. This prevents invalid property values from causing an active instance of MQIPT to shut down when it is refreshed.

Where a property is listed as taking the values true or false, any mixture of uppercase and lowercase characters can be used in the property value.

We can change the value of a property by editing the mqipt.conf file. To apply any changes, refresh MQIPT by using the mqiptAdmin command with the -refresh keyword.

To include comments in the configuration file, start a line with a "#" character.

Changes to certain properties cause a route to be restarted only if other properties are already enabled. For example, any changes to the HTTP properties have an effect only if the HTTP property is also enabled.

When a route is restarted, existing connections are terminated. To override this behavior, set the RouteRestart property to false. This prevents the route from restarting, allowing existing connections to remain active until the RouteRestart property is re-enabled.

For information about how to set up some simple configurations, see Getting started with MQIPT. For a sample configuration, see the mqiptSample.conf file in the MQIPT installation directory.


The mqiptAdmin properties file

Configuration properties for the mqiptAdmin command can be specified in a separate properties file. These configuration properties are needed when mqiptAdmin connects to the MQIPT TLS command port.

For the list of properties that can be specified in the mqiptAdmin properties file, see mqiptAdmin properties. Property names are case-sensitive. Any unrecognized properties are ignored.

Comments can be included in the properties file by starting a line with a "#" character.

Parent topic: Configuration reference

Last updated: 2020-10-04