[V9.0.1 Nov 2016]

Getting started with the IBM MQ Console

Before you can start the IBM® MQ Console you must install the correct components and start the mqweb server. You can then start the IBM MQ Console in a browser.

Before you begin

[IBM i]On IBM i, the commands should be running in QSHELL.

About this task

The procedure for this task focuses on basic steps to get started quickly with the IBM MQ Console. For more information about customizing your configuration, see the links that are listed under what to do next.
Note: You have the option during installation of configuring the IBM MQ Console without security.

Procedure

  1. Install the IBM MQ Console and REST API component:
    • [AIX][V9.0.4 Oct 2017]On AIX®,install the mqm.web.rte fileset.
    • [Linux]On Linux®, install the MQSeriesWeb component. For more information about installing components and features on Linux, see Linux installation tasks.
    • [Windows]On Windows, install the Web Administration feature. For more information about installing components and features on Windows, see Windows installation tasks.
    • [z/OS]On z/OS®, install the IBM MQ for z/OS Unix System Web Services Components feature. For more information about installing components and features on z/OS, see z/OS installation tasks.
  2. Configure basic security to allow users and groups to access the IBM MQ Console.
    1. Copy the sample basic_registry.xml file from the MQ_INSTALLATION_PATH/web/mq/samp/configuration directory to:
      • [UNIX, Linux, Windows]On UNIX, Linux, and Windows: MQ_DATA_DIRECTORY/web/installations/installationName/servers/mqweb
      • [z/OS]On z/OS: WLP_user_directory/servers/mqweb

        where WLP_user_directory is the directory that was specified when the crtmqweb.sh script ran to create the mqweb server definition.

    2. Rename the sample XML file to mqwebuser.xml.
      Note: This renamed file replaces an existing file that is also used for the administrative REST API. Therefore, if you changed the mqwebuser.xml file for the administrative REST API, copy your changes to the new XML file before you rename it.
  3. Dependent on platform, enable remote connections to the mqweb server:
    • [Linux]Optionally on Linux
    • [Windows]Optionally on Windows
    • [z/OS]On z/OS
    [V9.0.4 Oct 2017]
    • From IBM MQ 9.0.4, use the setmqweb command:

      setmqweb properties -k httpHost -v hostname

    • From IBM MQ 9.0.1, add the following XML to the mqwebuser.xml file, within the <server> tags:

      <variable name="httpHost" value="hostname"/>

    where hostname specifies the IP address, domain name server (DNS) host name with domain name suffix, or the DNS host name of the server where IBM MQ is installed. Use an asterisk, *, to specify all available network interfaces.

    [V9.0.4 Oct 2017][z/OS]Attention:

    Before issuing 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 do this, 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.sh. For example:
    export WLP_USER_DIR=/var/mqm/web/installation1

    For more information, see Create the Liberty server definition.

  4. Start the mqweb server that supports the IBM MQ Console:
  5. Connect to the IBM MQ Console by entering the following URL in a browser:

    https://hostname:9443/ibmmq/console

    where hostname specifies the IP address or domain name server (DNS) host name with domain name suffix, or the DNS host name of the server where IBM MQ is installed. If you did not configure remote connections in step 3, the value of hostname is localhost.

  6. Log in to the IBM MQ Console. From IBM MQ 9.0.2, use the user name mqadmin, and the password mqadmin. At IBM MQ 9.0.1, use the user name admin, and the password admin.

What to do next