dspmqweb (display mqweb server configuration)

Display information about the configuration of the mqweb server. The mqweb server is used to support the IBM® MQ Console and administrative REST API.

Purpose

Use the dspmqweb properties command to view details of the configuration of the mqweb server.

The following configuration properties are available on the appliance:

ltpaExpiration

This configuration property is used to specify the time, in seconds, before the LTPA token expires.

maxTraceFiles

This configuration property is used to specify the maximum number of mqweb server log files that are generated by the mqweb server.

maxTraceFileSize

This configuration property is used to specify the maximum size, in MB, that each mqweb server log file can reach.

mqConsoleMaxMsgCharsToDisplay

This configuration property is used to specify the maximum characters to retrieve from each message when you browse a queue by using the IBM MQ Console.

mqConsoleMaxMsgRequestSize

This configuration property is used to specify the maximum size, in MB, a browse request can be across all messages when you browse queues by using the IBM MQ Console.

mqConsoleMaxMsgsPerRequest

This configuration property is used to specify the total number of messages to retrieve from a queue when you browse by using the IBM MQ Console.

mqRestCorsAllowedOrigins

This configuration property is used to specify the origins that are allowed to access the REST API. For more information about CORS, see Configuring CORS for the REST API in the main IBM MQ documentation.

mqRestCorsMaxAgeInSeconds

This configuration property is used to specify the time, in seconds, that a web browser can cache the results of any CORS pre-flight checks.

mqRestCsrfValidation

This configuration property is used to specify whether CSRF validation checks are performed. A value of false removes the CSRF token validation checks.

mqRestGatewayEnabled

This configuration property is used to specify whether the administrative REST API gateway is enabled.

mqRestGatewayQmgr

This configuration property is used to specify the name of the queue manager to use as the gateway queue manager. This queue manager must exist on the local appliance. A blank value indicates that no queue manager is configured as the gateway queue manager.

mqRestMessagingAdoptWebUserContext

This configuration property is used to specify the user context that is used for authorization when you send, publish, receive, or browse messages by using the messaging REST API. That is, it specifies which user ID is used for authorization.

If the value is set to true, the ID that is used for authorization is the user ID that is logged in to the REST API.

If the value is set to false, the ID that is used for authorization is the user ID that is used to start the mqweb server.

mqRestMessagingEnabled

This configuration property is used to specify whether the messaging REST API is enabled.

mqRestMessagingFullPoolBehavior

This configuration property is used to specify the behavior of the messaging REST API when all connections in the connection pool are in use.

The value can be one of the following values:

block: When all the connections in the pool are in use, wait for a connection to become available. When this option is used, the wait for a connection is indefinite.; Inactive connections are closed and removed from a queue manager pool automatically. The state of each queue manager pool is interrogated every 2 minutes, and any connections that have been inactive for the last 30 seconds are closed and removed from the associated pool.
error: When all the connections in the pool are in use, return an error.
overflow: When all the connections in the pool are in use, create a nonpooled connection to use. This connection is deleted after it is used.

The value for this property is a string value. The default value is overflow.

mqRestMessagingMaxPoolSize

This configuration property is used to specify the maximum connection pool size for each queue manager connection pool.

The value for this property is an integer value. The default value is 20.

mqRestMftCommandQmgr

This configuration property is used to specify the name of the command queue manager to which create transfer and create, delete, or update resource monitor requests are submitted by the REST API for MFT.

The value for this property is a string value. If this value can be interpreted as number or a Boolean value, it must be enclosed in double quotation marks.

Changes to the value of this property take effect when the mqweb server is next started.

mqRestMftCoordinationQmgr

This configuration property is used to specify the name of the coordination queue manager from which transfer details are retrieved by the REST API for MFT.

mqRestMftEnabled

This configuration property is used to specify whether the REST API for MFT is enabled.

mqRestMftReconnectTimeoutInMinutes

This configuration property is used to specify the length of time, in minutes, after which the REST API for MFT stops trying to connect to the coordination queue manager.

mqRestRequestTimeout

This configuration property is used to specify the time, in seconds, before a REST request times out.

traceSpec

This configuration property is used to specify the level of trace that is generated by the mqweb server. For a list of possible values, see Configuring logging for the IBM MQ Console and REST API in the main IBM MQ documentation.

traceTAI

This configuration property is used to enable tracing of the Trust Association Interceptor (TAI) in the mqweb server.

Syntax

Optional parameters

properties

Displays information about the configurable properties of the mqweb server. That is, which properties are configurable by the user and those that have been modified.

-u: Displays only the configurable properties that have been modified by the user.
-a: Displays all available configurable properties, including those which have been modified by the user.
-t: Formats the output as text name-value pairs.
-c: Formats the output as command text which can be used as input to the corresponding setmqweb properties command.

-l: Enable verbose logging. Diagnostic information is written to a mqweb server log-file.

Return codes

Return code	Description
0	Command successful
>0	Command not successful.