[MQ 9.3.0 Jun 2022]

Configuring remote queue manager connection behavior for the IBM MQ Console

When you use the IBM® MQ Console, you can create connections to remote queue managers. That is, you can connect to queue managers that are not part of the same installation as the mqweb server that runs the IBM MQ Console. There are a number of configuration options you can set to control the behavior of the remote queue manager connections.

Before you begin

To complete this task, you must be a user with certain privileges so that you can use the dspmqweb and setmqweb commands:
  • [z/OS]On z/OS®, you must have authority to run the dspmqweb and setmqweb commands, and write access to the mqwebuser.xml file.
  • [UNIX, Linux, Windows, IBM i]On all other operating systems, you must be a privileged user.
  • [Linux][MQ 9.3.5 Feb 2024]If the mqweb server is part of a stand-alone IBM MQ Web Server installation, you must have write access to the mqwebuser.xml file in the IBM MQ Web Server data directory.
[z/OS]Attention:

Before you issue either the setmqweb or dspmqweb commands on z/OS, you must set the WLP_USER_DIR environment variable so that the variable points to your mqweb server configuration.

To set the WLP_USER_DIR environment variable, issue the following command:
export WLP_USER_DIR=WLP_user_directory
where WLP_user_directory is the name of the directory that is passed to crtmqweb. For example:
export WLP_USER_DIR=/var/mqm/web/installation1

For more information, see Create the mqweb server.

[Linux][MQ 9.3.5 Feb 2024]Attention:

Before you issue either the setmqweb or dspmqweb commands in a stand-alone IBM MQ Web Server installation, you must set the MQ_OVERRIDE_DATA_PATH environment variable to the IBM MQ Web Server data directory.

About this task

You can set the following configuration options:
  • Whether remote queue manager connections are allowed.
  • Whether the connections can be added by using the IBM MQ Console, or by only the command line.
  • Whether local queue managers are displayed in the IBM MQ Console when remote queue manager connections are allowed.
  • Whether remote queue manager connections are automatically established when the IBM MQ Console is started, or when there is a connection failure.
  • The length of time between each refresh of the list of remote queue managers displayed in the IBM MQ Console.

Procedure

  • To view the current remote queue manager connection configuration settings, enter the following command:

    dspmqweb properties -a

    • The mqConsoleRemoteSupportEnabled field indicates whether remote queue manager connections are allowed.
    • The mqConsoleRemoteUIAdmin field indicates whether remote queue manager connections can be added by using the IBM MQ Console.
    • The mqConsoleRemoteAllowLocal field indicates whether the local queue managers are displayed.
    • The mqConsoleRemotePollTime field indicates how many seconds there are between each refresh of the list of remote queue managers.
  • To prevent or allow remote queue manager connections with the IBM MQ Console, enter the following command:

    setmqweb properties -k mqConsoleRemoteSupportEnabled -v true or false

    where true allows remote queue manager connections, or false prevents remote queue manager connections.

    [MQ 9.3.5 Feb 2024][Linux]Note: If the mqweb server runs in a stand-alone IBM MQ Web Server installation, the mqConsoleRemoteSupportEnabled property is not valid. The stand-alone IBM MQ Web Server supports connections to only remote queue managers.
  • To prevent or allow remote queue manager connections to be added by using the IBM MQ Console, or by only the command line, enter the following command:

    setmqweb properties -k mqConsoleRemoteUIAdmin -v true or false

    where true allows remote queue manager connections to be added by using the IBM MQ Console and the command line, or false allows remote queue manager connections to be added only by using the setmqweb remote command on the command line.

  • To prevent or allow the display of local queue managers in the IBM MQ Console when remote queue manager connections are allowed, enter the following command:

    setmqweb properties -k mqConsoleRemoteAllowLocal -v true or false

    where true allows local queue managers to be displayed, or false hides the local queue managers.

    [MQ 9.3.5 Feb 2024][Linux]Note: If the mqweb server runs in a stand-alone IBM MQ Web Server installation, the mqConsoleRemoteAllowLocal property is not valid. The stand-alone IBM MQ Web Server supports connections to only remote queue managers.
  • To set the length of time between each refresh of the list of remote queue managers displayed in the IBM MQ Console, enter the following command:

    setmqweb properties -k mqConsoleRemotePollTime -v seconds

    where seconds is set to an integer value of the number of seconds between each refresh of the list of remote queue managers.