setmqweb (set mqweb server configuration)

Add or remove a known mqweb server configuration property.

Purpose

You can use the setmqweb properties command to configure the mqweb server. The mqweb server is used to support the IBM® MQ Console and administrative REST API.

Syntax

Read syntax diagramSkip visual syntax diagram setmqweb properties -r-kname-d-vvalue -l

Parameters

-r
Reset to default values. This parameter removes all user-modified configuration properties .
-k name
The name of the configuration property to add, update or remove. The following list shows the valid values for name on the appliance:
  • ltpaExpiration
  • maxTraceFiles
  • maxTraceFileSize
  • mqConsoleEnableDashboardBrowse
  • mqConsoleEnableSystemTopicMonitoring
  • mqConsoleMaxMsgCharsToDisplay
  • mqConsoleMaxMsgRequestSize
  • mqConsoleMaxMsgsPerRequest
  • mqRestCorsAllowedOrigins
  • mqRestCorsMaxAgeInSeconds
  • mqRestCsrfValidation
  • mqRestGatewayEnabled
  • mqRestGatewayQmgr
  • mqRestMessagingAdoptWebUserContext
  • mqRestMessagingEnabled
  • mqRestMessagingFullPoolBehavior
  • mqRestMessagingMaxPoolSize
  • mqRestMftCommandQmgr
  • mqRestMftCoordinationQmgr
  • mqRestMftEnabled
  • mqRestMftReconnectTimeoutInMinutes
  • mqRestRequestTimeout
  • traceSpec

See setmqweb properties in the main IBM MQ documentation for more details.

-d
Deletes the specified configuration property.
-v value
The value of the configuration property to add to or update. Any existing configuration properties of the same name are overwritten. Duplicate configuration properties are removed. The value is case-sensitive and can be enclosed in double quotation marks to allow for multiple token or empty values. The value that is specified is not validated. If incorrect values are specified a subsequent attempt to start the mqweb server might fail. For possible values for each name, see Configuring the IBM MQ Console and REST API.
-l
Enable verbose logging. Diagnostic information is written to an mqweb server log-file.

Return codes

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