dspmqweb remote (display mqweb server remote queue manager configuration)

Use the dspmqweb remote command to view details of the remote queue manager connections that are configured for use with the IBM® MQ Console and the messaging REST API.

[z/OS]

Using the setmqweb and dspmqweb commands on z/OS

Before you issue either the setmqweb or dspmqweb commands on z/OS®, you must set the WLP_USER_DIR environment variable so that the variable points to your mqweb server configuration.

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

For more information, see Create the mqweb server.

You must also set the JAVA_HOME environment variable to reference a 64-bit version of Java on your system.

[MQ 9.4.0 Jun 2024][Linux]

Using the setmqweb and dspmqweb commands in a stand-alone IBM MQ Web Server installation

Before you issue either the setmqweb or dspmqweb commands in a stand-alone IBM MQ Web Server installation, you must set the MQ_OVERRIDE_DATA_PATH environment variable to the IBM MQ Web Server data directory.

The user ID running the command needs write access to the data directory and its subdirectories.

Syntax

Read syntax diagramSkip visual syntax diagram dspmqweb remote -li-a-uniqueNameuniqueName -l

Optional parameters

-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 queue manager that is associated with the unique name.
-l
Enable verbose logging. Diagnostic information is written to a mqweb server log-file.

Properties that can be returned by the command

The following global properties can be returned when the -a parameter is used:
globalTrustStorePath
The path to the truststore JKS file. This truststore is used for all remote connections unless it is overridden by specific remote queue manager connection information in the trustStorePath entry.
globalTrustStorePassword
The password for the global truststore.
This value is encrypted and is displayed as a series of asterisks.
globalKeyStorePath
The path to the keystore JKS file. This keystore is used for all remote connections unless it is overridden by a specific remote queue manager connection information in the keyStorePath entry.
globalKeyStorePassword
The password for the global keystore.
This value is encrypted and is displayed as a series of asterisks.
For each remote queue manager connection, the following properties can be returned:
uniqueName
The unique name for the remote queue manager connection.
qmgrName
The name of the queue manager.
ccdtURL
The path to the CCDT file that is associated with the remote queue manager connection.
[MQ 9.4.0 Jun 2024]group
Whether this remote queue manager connection is part of a queue manager group. If the value is true, then the uniqueName specifies the group name.
This property is valid only for the messaging REST API.
[MQ 9.4.0 Jun 2024]visibility
Whether this remote queue manager connection can be used by the messaging REST API, the IBM MQ Console, or both.
username
The username that is used for the remote queue manager connection.
password
The password that is associated with the username that is used for the remote queue manager connection.
This value is encrypted in the remote queue manager connection information and is displayed as a series of asterisks.
enableMutualTLS
Whether this remote queue manager connection uses mutual TLS.
trustStorePath
The path to the truststore JKS file. This value overrides the global truststore value.
trustStorePassword
The password for the truststore file.
This value is encrypted in the remote queue manager connection information and is displayed as a series of asterisks.
keyStorePath
The path to the keystore JKS file. This value overrides the global keystore value.
keyStorePassword
The password for the keystore file.
This value is encrypted in the remote queue manager connection information and is displayed as a series of asterisks.

Return codes

Table 1. Return code identifiers and descriptions
Return code Description
0 Command successful.
>0 Command not successful.
For a full list of server command exit codes, see Liberty:server command options in the WebSphere® Application Server documentation.