Configuring the connection mode for the messaging REST API

You can configure the messaging REST API to connect to either local or remote queue managers.

Before you begin

Note: If the mqweb server runs in a stand-alone IBM® MQ Web Server installation, this task is not applicable. The stand-alone IBM MQ Web Server supports connections to only remote queue managers.

To complete this task, you must be a user with certain privileges so that you can use the dspmqweb and setmqweb commands:

• On z/OS®, you must have authority to run the dspmqweb and setmqweb commands, and write access to the mqwebuser.xml file.
• On all other operating systems, you must be a privileged user.

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.

• View the current configuration of the messaging REST API by using the following command:

  dspmqweb properties -a

  The mqRestMessagingConnectionMode field shows the current connection mode. If the value is local, the messaging REST API can connect only to queue managers in the same installation as the mqweb server. If the value is remote, the messaging REST API can connect to remote queue managers.
• Configure the mqweb server to allow the messaging REST API to connect only to queue managers that are in the same installation as the mqweb server by using the following commands:

  setmqweb properties -k mqRestMessagingConnectionMode -v local
  endmqweb
  strmqweb

• Configure the mqweb server to allow the messaging REST API to connect to remote queue managers by using the following command:

  setmqweb properties -k mqRestMessagingConnectionMode -v remote
  endmqweb
  strmqweb