Configuring autostart

By default, the IBM® MQ Console is automatically started when the mqweb server starts. You can configure whether the IBM MQ Console and the REST API start automatically by using the setmqweb command.

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.

Procedure

  • View the current configuration of the autostart by using the following command:

    dspmqweb properties -a

    The mqRestAutostart field shows whether the REST API is automatically started, and the mqConsoleAutostart field shows whether the IBM MQ Console is automatically started.
  • Configure whether the IBM MQ Console starts automatically by using the following command:

    setmqweb properties -k mqConsoleAutostart -v start

    where start is the value true if you want the IBM MQ Console to automatically start, or false otherwise.

  • Configure whether the REST API starts automatically by using the following command:

    setmqweb properties -k mqRestAutostart -v start

    where start is the value true if you want the REST API to automatically start, or false otherwise.