dspmqweb properties (display mqweb server configuration properties)

To set the WLP_USER_DIR environment variable, enter the following command:

export WLP_USER_DIR=WLP_user_directory

where WLP_user_directory is the name of the directory that is passed to crtmqweb. For example:

export WLP_USER_DIR=/var/mqm/web/installation1

-u

Displays only the configurable properties that have been modified by the user.

-a

Displays all available configurable properties, including those properties 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.

The following properties can be returned by the dspmqweb properties command on all platforms, including the IBM MQ Appliance. Some of the following properties are not available in a stand-alone IBM MQ Web Server installation.

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.

mqConsoleEnableDashboardBrowse

This configuration property is used to enable or disable queue browsing that is used by the IBM MQ Console to obtain some of the information that is displayed in the MQ Console dashboard.

mqConsoleEnableSystemTopicMonitoring

This configuration property is used to enable or disable system topic monitoring that is used to display system information in the IBM MQ Console.

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.

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.

This property is not returned in a stand-alone IBM MQ Web Server installation. You cannot use the administrative REST API with the stand-alone IBM MQ Web Server.

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.

This property is not returned in a stand-alone IBM MQ Web Server installation. You cannot use the administrative REST API with the stand-alone IBM MQ Web Server.

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.

If the value is set to block, wait for a connection to become available if all the connections in the pool are in use. When this option is used, the wait for a connection is indefinite.

If the value is set to error, return an error if all connections in the pool are in use.

If the value is set to overflow, create a nonpooled connection to use if all the connections in the pool are in use.

mqRestMessagingMaxPoolSize

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

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.

This property is not returned in a stand-alone IBM MQ Web Server installation. You cannot use the REST API for MFT with the stand-alone IBM MQ Web Server.

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.

This property is not returned in a stand-alone IBM MQ Web Server installation. You cannot use the REST API for MFT with the stand-alone IBM MQ Web Server.

mqRestMftEnabled

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

This property is not returned in a stand-alone IBM MQ Web Server installation. You cannot use the REST API for MFT with the stand-alone IBM MQ Web Server.

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.

This property is not returned in a stand-alone IBM MQ Web Server installation. You cannot use the REST API for MFT with the stand-alone IBM MQ Web Server.

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. Some of the following properties are not available in a stand-alone IBM MQ Web Server installation.

httpHost

This configuration property is used to specify the HTTP hostname as an IP address, domain name server (DNS) hostname with domain name suffix, or the DNS hostname 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.

If the value is set to -1 the port is disabled.

httpsPort

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

If the value is set to -1 the port is disabled.

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 applies only 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 that 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.

This property is not returned in a stand-alone IBM MQ Web Server installation. The IBM MQ Console can be used only with remote queue managers in this environment.

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.

This property is not returned in a stand-alone IBM MQ Web Server installation. The IBM MQ Console can be used only with remote queue managers in this environment.

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.

mqRestMessagingConnectionMode

This configuration property is used to specify whether the messaging REST API can send messages to queue managers that are not in the same installation as the mqweb server.

If the value is set to local, the messaging REST API can send messages only to queue managers that are in the same installation as the mqweb server.

If the value is set to remote, the messaging REST API can send messages to any queue manager that is configured for use by the messaging REST API.

This property is not returned in a stand-alone IBM MQ Web Server installation. The messaging REST API can be used only with remote queue managers in this environment.

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

If the value is set to standard, queue managers and listeners can be created and administered in the IBM MQ Console.

If the value is set to 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.