administrative REST API の使用開始

administrative REST API を開始する前に、正しいコンポーネントをインストールし、 REST APIを有効にし、 セキュリティーを構成し、 mqweb サーバーを開始する必要があります。

1. IBM MQ Console および REST API コンポーネントをインストールします。
   • AIX®の場合、 mqm.web.rte ファイルセットをインストールします。
   • Linux®の場合は、 MQSeriesWeb コンポーネントをインストールします。 Linuxでのコンポーネントおよびフィーチャーのインストールについて詳しくは、 Linux のインストール・タスクを参照してください。
   • Windowsの場合は、 Web Administration フィーチャーをインストールします。 Windowsでのコンポーネントおよびフィーチャーのインストールについて詳しくは、 Windows のインストール・タスクを参照してください。
   • z/OS®の場合は、 IBM MQ for z/OS Unix System Services Web Components フィーチャーをインストールします。 z/OSでのコンポーネントおよびフィーチャーのインストールについて詳しくは、 z/OS のインストール・タスクを参照してください。
2. オプション: IBM MQ 9.0.2以降、 administrative REST API はデフォルトで有効になっています。 ただし、 IBM MQ 9.0.1では、 administrative REST API はデフォルトで無効になっています。 IBM MQ 9.0.1を使用している場合は、 mqwebuser.xml ファイルの <server> タグ内に以下の XML を追加して、 REST API を有効にします。

   <variable name="mqRestAutostart" value="true"/>

   mqwebuser.xml は、以下のいずれかのディレクトリーにあります。

   • MQ_DATA_DIRECTORY/web/installations/installationName/servers/mqweb
   • WLP_user_directory/servers/mqweb

     ここで、 WLP_user_directory は、mqweb サーバー定義を作成するために crtmqweb.sh スクリプトを実行したときに指定したディレクトリーです。

3. IBM MQ 9.0.2以降、 administrative REST APIのセキュリティーが有効になっています。 administrative REST APIを使用するには、その前にユーザーと役割を構成する必要があります。
   1. basic_registry.xml ファイルを MQ_INSTALLATION_PATH/web/mq/samp/configuration ディレクトリーからコピーします。
   2. サンプル XML ファイルを適切なディレクトリーに配置します。
      • UNIX, Linux, and Windowsの場合: MQ_DATA_DIRECTORY/web/installations/installationName/servers/mqweb
      • z/OSの場合: WLP_user_directory/servers/mqweb

        ここで WLP_user_directory は、mqweb 定義を作成するために crtmqweb.sh スクリプトを実行した際に指定されたディレクトリーです。

   3. サンプル XML ファイルの名前を mqwebuser.xmlに変更します。
      注: この名前変更されたファイルは、 IBM MQ Consoleにも使用される既存のファイルを置き換えます。 したがって、 IBM MQ Consoleの mqwebuser.xml ファイルを変更した場合は、その変更内容を新しい XML ファイルにコピーしてから名前変更します。
   4. オプション: mqwebuser.xml ファイルを編集して、ユーザーおよびグループを追加します。 それらのユーザーおよびグループに、 administrative REST APIの使用を許可する適切な役割を割り当てます。 デフォルトで定義されているユーザーのパスワードを変更し、新規パスワードをエンコードすることもできます。 詳しくは、 ユーザーと役割の構成を参照してください。
4. mqweb サーバーへのリモート接続を有効にします。
   • バージョン 9.0.4 から、setmqweb コマンドを使用します。

     setmqweb properties -k httpHost -v hostname

   • バージョン 9.0.1 から、以下の XML を mqwebuser.xml ファイルの <server> タグ内に追加します。

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

   ここで、 hostname は、 IBM MQ がインストールされているサーバーの IP アドレス、ドメイン・ネーム接尾部付きのドメイン・ネーム・サーバー (DNS) ホスト名、または DNS ホスト名を指定します。 使用可能なすべてのネットワーク・インターフェースを指定するには、アスタリスク (*) を使用します。

   重要:

   z/OSで setmqweb コマンドまたは dspmqweb コマンドを発行する前に、WLP_USER_DIR 環境変数が mqweb サーバー構成を指すように設定する必要があります。

   そのためには、以下のコマンドを実行します。

   export WLP_USER_DIR=WLP_user_directory

   ここで、WLP_user_directoryは、crtmqweb.shに渡されるディレクトリーの名前です。 以下に例を示します。

   export WLP_USER_DIR=/var/mqm/web/installation1

   詳しくは、 Liberty サーバー定義の作成を参照してください。

5. REST APIをサポートする mqweb サーバーを開始します。
   • Windows および Linuxでは、 特権ユーザーとして、コマンド行に以下のコマンドを入力します。

     strmqweb

   • z/OSで、 タスク 29: IBM WLP サーバー用のプロシージャーの作成で作成したプロシージャーを開始します。