dspmqweb プロパティー (mqweb サーバー構成プロパティーの表示)

IBM® MQ Console および REST APIをサポートするために使用される mqweb サーバーの構成可能プロパティーに関する情報を表示します。 つまり、このコマンドは、ユーザーが構成可能なプロパティーと、変更されたプロパティーを表示します。

目的

mqweb サーバーの構成の詳細情報を表示するには、dspmqweb properties コマンドを使用します。 mqweb サーバーが実行中である必要はありません。

[z/OS]

z/OS でのコマンドの使用

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

WLP_USER_DIR 環境変数を設定するには、次のコマンドを入力します。
export WLP_USER_DIR=WLP_user_directory
ここで、WLP_user_directoryは、crtmqwebに渡されるディレクトリーの名前です。 以下に例を示します。
export WLP_USER_DIR=/var/mqm/web/installation1

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

システム上の Java の 64 ビット・バージョンを参照するように JAVA_HOME 環境変数を設定する必要もあります。

[MQ 9.3.5 2024 年 2 月][Linux]

スタンドアロン IBM MQ Web Server インストール済み環境でのコマンドの使用

スタンドアロン IBM MQ Web Server インストール済み環境で setmqweb コマンドまたは dspmqweb コマンドを発行する前に、 MQ_OVERRIDE_DATA_PATH 環境変数を IBM MQ Web Server データ・ディレクトリーに設定する必要があります。

コマンドを実行するユーザー ID には、データ・ディレクトリーとそのサブディレクトリーに対する書き込み権限が必要です。

構文

構文図を読むビジュアル構文図をスキップ dspmqweb properties -u-a-t-c -l

オプション・パラメーター

-u
ユーザーが変更した構成可能プロパティーのみ表示します。
-a
ユーザーによって変更されたプロパティーを含む、使用可能なすべての構成可能プロパティーを表示します。
-t
出力の形式をテキストの名前と値のペアにします。
-c
出力をコマンド・テキストとしてフォーマット設定します。これは、対応する setmqweb properties コマンドへの入力として使用できます。
-l
詳細ロギングを使用可能にします。 mqweb サーバーのログ・ファイルに診断情報が書き込まれます。

コマンドによって返すことができるプロパティー

IBM MQ Applianceを含むすべてのプラットフォームで、 dspmqweb properties コマンドによって以下のプロパティーを返すことができます。 [MQ 9.3.5 2024 年 2 月]以下のプロパティーの一部は、スタンドアロンの IBM MQ Web Server インストール済み環境では使用できません。
ltpaExpiration
この構成プロパティーを使用して、LTPA トークンの有効期限が切れるまでの時間を秒数で指定します。
maxTraceFiles
この構成プロパティーを使用して、mqweb サーバーで生成される mqweb サーバー・ログ・ファイルの最大数を指定します。
maxTraceFileSize
この構成プロパティーを使用して、各 mqweb サーバー・ログ・ファイルの最大サイズを MB で指定します。
[MQ 9.3.4 2023 年 10 月]mqConsoleEnableDashboardBrowse
この構成プロパティーは、 IBM MQ ConsoleMQ コンソール・ダッシュボードに表示される情報の一部を取得するために使用するキュー参照を有効または無効にするために使用されます。
[MQ 9.3.4 2023 年 10 月]mqConsoleEnableSystemTopicMonitoring
この構成プロパティーは、 IBM MQ Consoleでシステム情報を表示するために使用されるシステム・トピック・モニターを使用可能または使用不可にするために使用されます。
[MQ 9.3.0 Jun 2022]mqConsoleMaxMsgCharsToDisplay
この構成プロパティーを使用して、 IBM MQ Consoleを使用してキューを参照するときに各メッセージから取得する最大文字数を指定します。
[MQ 9.3.0 Jun 2022]mqConsoleMaxMsgRequestSize
この構成プロパティーを使用して、 IBM MQ Consoleを使用してキューを参照するときに、すべてのメッセージにわたるブラウズ要求の最大サイズを MB 単位で指定します。
[MQ 9.3.0 Jun 2022]mqConsoleMaxMsgsPerRequest
この構成プロパティーを使用して、 IBM MQ Consoleを使用して参照するときにキューから取得するメッセージの総数を指定します。
mqRestCorsAllowedOrigins
この構成プロパティーを使用して、 REST APIへのアクセスが許可される起点を指定します。 CORS について詳しくは、 REST API用の CORS の構成を参照してください。
mqRestCorsMaxAgeInSeconds
この構成プロパティーを使用して、Web ブラウザーが CORS プリフライト検査の結果をキャッシュできる時間を秒数で指定します。
mqRestCsrfValidation
この構成プロパティーを使用して、CSRF 妥当性検査のチェックを実行するかどうかを指定します。 値falseは、CSRF トークン検証チェックを除去します。
mqRestGatewayEnabled
この構成プロパティーを使用して、 administrative REST API ゲートウェイを有効にするかどうかを指定します。
[MQ 9.3.5 2024 年 2 月]この環境では administrative REST API を使用できないため、スタンドアロンの IBM MQ Web Server インストール済み環境ではこのプロパティーは返されません。
mqRestGatewayQmgr
この構成プロパティーを使用して、ゲートウェイ・キュー・マネージャーとして使用するキュー・マネージャーの名前を指定します。 このキュー・マネージャーは、mqweb サーバーと同じインストール済み環境に配置する必要があります。 値がブランクの場合は、ゲートウェイ・キュー・マネージャーとして構成されるキュー・マネージャーがないことを示します。
[MQ 9.3.5 2024 年 2 月]この環境では administrative REST API を使用できないため、スタンドアロンの IBM MQ Web Server インストール済み環境ではこのプロパティーは返されません。
[MQ 9.3.2 2023 年 2 月]mqRestMessagingAdoptWebUserContext
この構成プロパティーを使用して、 messaging REST APIを使用してメッセージを送信、パブリッシュ、受信、または参照するときに許可に使用するユーザー・コンテキストを指定します。 つまり、どのユーザー ID が許可に使用されるかを指定します。
値が trueに設定されている場合、許可に使用される ID は、 REST APIにログインしているユーザー ID です。
値が falseに設定されている場合、許可に使用される ID は、mqweb サーバーの開始に使用されるユーザー ID です。
mqRestMessagingEnabled
この構成プロパティーを使用して、 messaging REST API を有効にするかどうかを指定します。
mqRestMessagingFullPoolBehavior
この構成プロパティーを使用して、接続プール内のすべての接続が使用中の場合の messaging REST API の動作を指定します。
値が blockに設定されている場合、プール内のすべての接続が使用中であれば、接続が使用可能になるまで待機します。 このオプションを使用した場合、接続を無期限に待機します。
値が errorに設定されている場合、プール内のすべての接続が使用中であればエラーを返します。
値が overflowに設定されている場合、プール内のすべての接続が使用中の場合に使用する非プール接続を作成します。
mqRestMessagingMaxPoolSize
この構成プロパティーでは、各キュー・マネージャー接続プールの最大接続プール・サイズを指定します。
mqRestMftCommandQmgr
この構成プロパティーを使用して、 REST API for MFTによって作成転送、作成、削除、または更新リソース・モニター要求が実行依頼されるコマンド・キュー・マネージャーの名前を指定します。
[MQ 9.3.5 2024 年 2 月]スタンドアロンの IBM MQ Web Server インストール済み環境では、 MFTREST API を使用できないため、このプロパティーは返されません。
mqRestMftCoordinationQmgr
この構成プロパティーを使用して、 REST API for MFTによって転送の詳細が取得される調整キュー・マネージャーの名前を指定します。
[MQ 9.3.5 2024 年 2 月]スタンドアロンの IBM MQ Web Server インストール済み環境では、 MFTREST API を使用できないため、このプロパティーは返されません。
mqRestMftEnabled
この構成プロパティーを使用して、 MFTREST API を有効にするかどうかを指定します。
[MQ 9.3.5 2024 年 2 月]スタンドアロンの IBM MQ Web Server インストール済み環境では、 MFTREST API を使用できないため、このプロパティーは返されません。
mqRestMftReconnectTimeoutInMinutes
この構成プロパティーを使用して、 REST API for MFT が調整キュー・マネージャーへの接続の試行を停止するまでの時間の長さを分単位で指定します。
[MQ 9.3.5 2024 年 2 月]スタンドアロンの IBM MQ Web Server インストール済み環境では、 MFTREST API を使用できないため、このプロパティーは返されません。
mqRestRequestTimeout
この構成プロパティーを使用して、REST 要求がタイムアウトになるまでの時間を秒数で指定します。
traceSpec
この構成プロパティーを使用して、mqweb サーバーで生成されるトレースのレベルを指定します。 可能な値のリストについては、 IBM MQ Console および REST APIのロギングの構成を参照してください。
[AIX、Linux、Windows][z/OS]以下のプロパティーは、 z/OS( AIX®, Linux®, and Windows) で dspmqweb properties コマンドによって返すことができる追加のプロパティーです。 [MQ 9.3.5 2024 年 2 月]以下のプロパティーの一部は、スタンドアロンの IBM MQ Web Server インストール済み環境では使用できません。
httpHost
この構成プロパティーを使用して、 HTTP ホスト名を IP アドレス、ドメイン・ネーム・サフィックス付きのドメイン・ネーム・サーバー (DNS) ホスト名、または IBM MQ がインストールされているサーバーの DNS ホスト名として指定します。
アスタリスクは使用可能なすべてのネットワーク・インターフェースを指定し、値localhostはローカル接続のみを許可します。
httpPort
この構成プロパティーを使用して、HTTP 接続に使用する HTTP ポート番号を指定します。
値が -1 に設定されている場合、ポートは無効になります。
httpsPort
この構成プロパティーを使用して、HTTPS 接続に使用する HTTPS ポート番号を指定します。
値が -1 に設定されている場合、ポートは無効になります。
ltpaCookieName
この構成プロパティーを使用して、LTPA トークンの Cookie の名前を指定します。
デフォルトでは、このプロパティーの値は LtpaToken2_${env.MQWEB_LTPA_SUFFIX} on AIX, Linux, and Windows または LtpaToken2_${httpsPort} on z/OSです。 LtpaToken2_ 接頭部の後の変数は、Cookie の固有の名前を生成するために mqweb サーバーによって使用されます。 この変数は設定できませんが、ltpaCookieNameを任意の値に変更できます。
maxMsgTraceFiles
この構成プロパティーを使用して、 IBM MQ Consoleの mqweb サーバーによって生成されるメッセージング・トレース・ファイルの最大数を指定します。
maxMsgTraceFileSize
この構成プロパティーを使用して、各メッセージング・トレース・ファイルの最大サイズを MB で指定します。
このプロパティーは、 IBM MQ Consoleにのみ適用されます。
mqConsoleAutostart
この構成プロパティーを使用して、mqweb サーバーの始動時に IBM MQ Console を自動的に開始するかどうかを指定します。
mqConsoleFrameAncestors
この構成プロパティーを使用して、IFrame に IBM MQ Console を埋め込むことができる Web ページのオリジンのリストを指定します。
[MQ 9.3.0 Jun 2022]mqConsoleRemoteAllowLocal
この構成プロパティーを使用して、リモート・キュー・マネージャー接続が許可されている場合に、リモート・キュー・マネージャーとローカル・キュー・マネージャーを IBM MQ Console で可視にするかどうかを指定します。 このプロパティーを true に設定すると、ローカル・キュー・マネージャーとリモート・キュー・マネージャーの両方が表示されます。
[MQ 9.3.5 2024 年 2 月]スタンドアロンの IBM MQ Web Server インストール済み環境では、 IBM MQ Console はこの環境内のリモート・キュー・マネージャーでのみ使用できるため、このプロパティーは返されません。
[MQ 9.3.0 Jun 2022]mqConsoleRemotePollTime
この構成プロパティーを使用して、リモート・キュー・マネージャー接続リストの更新間隔時間を秒単位で指定します。 更新時に、失敗した接続は再試行されます。
[MQ 9.3.0 Jun 2022]mqConsoleRemoteSupportEnabled
この構成プロパティーを使用して、 IBM MQ Console がリモート・キュー・マネージャー接続を許可するかどうかを指定します。 このプロパティーを true に設定すると、リモート・キュー・マネージャー接続が許可されます。
[MQ 9.3.5 2024 年 2 月]スタンドアロンの IBM MQ Web Server インストール済み環境では、 IBM MQ Console はこの環境内のリモート・キュー・マネージャーでのみ使用できるため、このプロパティーは返されません。
[MQ 9.3.0 Jun 2022]mqConsoleRemoteUIAdmin
この構成プロパティーを使用して、コンソールを使用してリモート・キュー・マネージャーを IBM MQ Console に追加できるかどうか、または setmqweb remote コマンドを使用することによってのみリモート・キュー・マネージャーを追加できるかどうかを指定します。 このプロパティーを true に設定すると、 IBM MQ Consoleを使用してリモート・キュー・マネージャーを追加できます。
mqRestAutostart
この構成プロパティーを使用して、mqweb サーバーの始動時に REST API を自動的に開始するかどうかを指定します。
[MQ 9.3.3 2023 年 6 月]mqRestMessagingConnectionMode
この構成プロパティーを使用して、メッセージング REST API が、mqweb サーバーと同じインストール済み環境にないキュー・マネージャーにメッセージを送信できるかどうかを指定します。
値が localに設定されている場合、メッセージング REST API は、mqweb サーバーと同じインストール済み環境にあるキュー・マネージャーにのみメッセージを送信できます。
値が remoteに設定されている場合、メッセージング REST API は、メッセージング REST APIで使用するように構成されている任意のキュー・マネージャーにメッセージを送信できます。
[MQ 9.3.5 2024 年 2 月]スタンドアロンの IBM MQ Web Server インストール済み環境では、 messaging REST API はこの環境内のリモート・キュー・マネージャーでのみ使用できるため、このプロパティーは返されません。
[MQ 9.3.0 Jun 2022]remoteKeyfile
この構成プロパティーを使用して、リモート・キュー・マネージャー接続情報に保管されているパスワードの暗号化解除に使用される初期暗号鍵を含む鍵ファイルの場所を指定します。
secureLtpa
この構成プロパティーを使用して、すべての要求の LTPA トークンを保護するかどうかを指定します。 ブラウザーから HTTP 要求を送信するには、非セキュア LTPA トークンが必要です。
[AIX、Linux、Windows]以下のプロパティーは、 AIX, Linux, and Windowsdspmqweb properties コマンドによって返すことができる追加のプロパティーです。
managementMode
この構成プロパティーを使用して、キュー・マネージャーおよびリスナーを IBM MQ Consoleによって作成、削除、開始、および停止できるかどうかを指定します。
値が standardに設定されている場合、 IBM MQ Consoleでキュー・マネージャーとリスナーを作成して管理できます。
値が externallyprovisionedに設定されている場合、 IBM MQ Consoleでキュー・マネージャーとリスナーを作成することはできません。 管理できるのは、 IBM MQ Console の外部で作成されたキュー・マネージャーとリスナーのみです。

戻りコード

表 1. 戻りコードの ID と説明
戻りコード 説明
0 コマンドが成功しました。
>0 コマンドが成功しませんでした。
サーバー・コマンド終了コードの完全なリストについては、 WebSphere® Application Server 資料の Liberty: server command options を参照してください。

関連コマンド

表 2. 関連コマンドと説明
コマンド 説明
dspmqweb status mqweb サーバー状況の表示
dspmqweb リモート mqweb サーバーのリモート・キュー・マネージャー構成の表示
strmqweb mqweb サーバーを開始します。
endmqweb mqweb サーバーを停止します。
setmqweb PID (setmqweb pid) z/OS上で mqweb サーバーを実行する製品 ID を構成します。
setmqweb プロパティー (mqweb サーバー構成プロパティーの設定) mqweb サーバー・プロパティーを構成します。
setmqweb remote (mqweb サーバーのリモート・キュー・マネージャー構成の設定) mqweb サーバーのリモート・キュー・マネージャー接続を構成します。