Configuring the REST management interface by using the command line

You can configure the REST management interface by using the command interface.

About this task

To configure the REST management interface from the command line, you enter rest-mgmt mode and enter the required rest-mgmt commands.

Procedure

  1. Connect to the IBM® MQ Appliance as described in Command line access. Log in as an administrative user.
  2. Type config to enter global configuration mode.
  3. Type rest-mgmt to enter rest-mgmt mode.
  4. Type the following command to enable the REST management interface:
    admin-state enabled
  5. Specify the local interface that the appliance listens on for REST requests:
    local-interface IPaddress
    You can specify an IP address of 0.0.0.0 to listen on all appliance interfaces.
  6. Specify the port number to listen on:
    port port_number
    The appliance listens on port 5554 by default.
  7. If you want to secure REST requests and responses by using SSL (TLS), specify the SSL configuration type of server and supply the name of the SSL server profile that you have created for this purpose (see Configuring certificates for the REST management interface).
    ssl-config-type server
    ssl-server server_profile
  8. After you configure the REST management interface, enter exit to save the configuration and exit, or type cancel to exit without saving.