dspmqweb (display 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 passed to crtmqweb. For example:

export WLP_USER_DIR=/var/mqm/web/installation1

The following properties can be returned by the dspmqweb properties command on all platforms, including the IBM MQ 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 browsing a queue via 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 browsing queues via the IBM MQ Console.

mqConsoleMaxMsgsPerRequest

This configuration property is used to specify the total number of messages to retrieve from a queue when browsing via 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.

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 be in the same installation as the mqweb server. A blank value indicates that no queue manager is configured as the gateway queue manager.

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 non-pooled connection to use. This connection is destroyed 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.

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.

The following properties are the additional properties that can be returned by the dspmqweb properties command on z/OS, AIX®, Linux®, and Windows:

httpHost

This configuration property is used to specify the HTTP host name as an 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.

An asterisk specifies all available network interfaces, and the value localhost allows only local connections.

httpPort

This configuration property is used to specify the HTTP port number that is used for HTTP connections.

A value of -1 disables the port.

httpsPort

This configuration property is used to specify the HTTPS port number that is used for HTTPS connections.

A value of -1 disables the port.

ltpaCookieName

This configuration property is used to specify the name of the LTPA token cookie name.

By default, the value of this property is LtpaToken2_${env.MQWEB_LTPA_SUFFIX} on AIX, Linux, and Windows , or LtpaToken2_${httpsPort} on z/OS, . The variable after the LtpaToken2_ prefix is used by the mqweb server to generate a unique name for the cookie. You cannot set this variable, but you can change the ltpaCookieName to a value of your choosing.

maxMsgTraceFiles

This configuration property is used to specify the maximum number of messaging trace files that are generated by the mqweb server for the IBM MQ Console.

maxMsgTraceFileSize

This configuration property is used to specify the maximum size, in MB, that each messaging trace file can reach.

This property only applies to the IBM MQ Console.

mqConsoleAutostart

This configuration property is used to specify whether the IBM MQ Console automatically starts when the mqweb server starts.

mqConsoleFrameAncestors

This configuration property is used to specify the list of origins of web pages which can embed the IBM MQ Console in an IFrame.

mqConsoleRemoteAllowLocal

This configuration property is used to specify whether remote and local queue managers are visible in the IBM MQ Console when remote queue manager connections are allowed. When this property is set to true, both local and remote queue managers are displayed.

mqConsoleRemotePollTime

This configuration property is used to specify the time, in seconds, before the remote queue manager connections list is refreshed. On refresh, unsuccessful connections are retried.

mqConsoleRemoteSupportEnabled

This configuration property is used to specify whether the IBM MQ Console allows remote queue manager connections. When this property is set to true, remote queue manager connections are allowed.

mqConsoleRemoteUIAdmin

This configuration property is used to specify whether remote queue managers can be added to the IBM MQ Console by using the Console, or if remote queue managers can be added only by using the setmqweb remote command. When this property is set to true, remote queue managers can be added by using the IBM MQ Console.

mqRestAutostart

This configuration property is used to specify whether the REST API automatically starts when the mqweb server starts.

remoteKeyfile

This configuration property is used to specify the location of the key file that contains the initial encryption key that is used to decrypt the passwords that are stored in the remote queue manager connection information.

secureLtpa

This configuration property is used to specify whether the LTPA token is secured for all requests. An unsecured LTPA token is required in order send HTTP requests from a browser.

The following properties are the additional properties that can be returned by the dspmqweb properties command on AIX, Linux, and Windows:

managementMode

This configuration property is used to specify whether queue managers and listeners are able to be created, deleted, started, and stopped by the IBM MQ Console.

The value for this property is a string value and can be one of the following values:

standard

Queue managers and listeners can be created and administered in the IBM MQ Console.

externallyprovisioned

Queue managers and listeners cannot be created in the IBM MQ Console. Only queue managers and listeners that are created outside of the IBM MQ Console can be administered.

status

Displays information about the status of the mqweb server. That is, whether the mqweb server is running. If the mqweb server is running, information about the available root context URLs and associated ports that are used by the IBM MQ Console and administrative REST API are displayed. The command returns non-zero if the mqweb server is not running, or its status could not be successfully queried.

For example:

Server mqweb is running.
URLs:
  https://localhost:9443/ibmmq/console/
  https://localhost:9443/ibmmq/rest/v1/

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. It is not necessary for the mqweb server to be running.

-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.

remote

Displays information about the remote queue manager connections that are configured for use with the IBM MQ Console.

-li

Displays all the remote queue manager unique IDs.

-a

Displays all the remote queue manager connection definitions and properties.

-uniqueName uniqueName

Displays the remote queue manager connection definition and properties for the specified queue manager.

-l

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