[MQ 9.3.0 2022 年 6 月]

setmqweb remote (设置 mqweb 服务器远程队列管理器配置)

为 mqweb 服务器配置远程队列管理器连接信息。 远程队列管理器连接信息用于 IBM® MQ Console以及用于连接到远程队列管理器的消息传递 REST API

用途

您可以使用 setmqweb remote 命令来设置要与 IBM MQ Console 和消息传递 REST API配合使用的远程队列管理器连接。

[z/OS]

z/OS 上使用命令

z/OS®上发出 setmqwebdspmqweb 命令之前,必须设置 WLP_USER_DIR 环境变量,以便该变量指向 mqweb 服务器配置。

要设置 WLP_USER_DIR 环境变量,请输入以下命令:
export WLP_USER_DIR=WLP_user_directory
其中,WLP_user_directory 是传递到 crtmqweb 的目录的名称。 例如:
export WLP_USER_DIR=/var/mqm/web/installation1

有关更多信息,请参阅创建 mqweb 服务器

您还必须设置 JAVA_HOME 环境变量以在系统上引用 64 位版本的 Java

运行该命令的用户标识需要对以下目录的写访问权:
  • WLP_user_directory 及其子目录。
  • /tmpTMPDIR 变量引用的另一个目录。 如果您无权访问 /tmp,那么该命令将失败并返回消息FSUMF315 Cannot define temporary file. 如果需要设置 TMPDIR 变量,请在 z/OS UNIX shell 中发出以下命令: export TMPDIR=user_directory
[MQ 9.3.5 2024 年 2 月][Linux]

在独立 IBM MQ Web Server 安装中使用该命令

在独立 IBM MQ Web Server 安装中发出 setmqwebdspmqweb 命令之前,必须将 MQ_OVERRIDE_DATA_PATH 环境变量设置为 IBM MQ Web Server 数据目录。

运行该命令的用户标识需要对数据目录及其子目录的写访问权。

[UNIX、Linux、Windows][z/OS][MQ 9.3.0 2022 年 6 月]

语法

读取语法图跳过可视语法图 setmqweb remote -r-uniqueNameuniqueId-dadd-group-uniqueNameuniqueId-qmgrNameqmgrName-jsonkey-d-i-sfkeyfilePath -l
[UNIX、Linux、Windows][z/OS][MQ 9.3.0 2022 年 6 月]

参数

添加
将条目添加到远程队列管理器连接信息,而不是编辑现有条目。
[MQ 9.3.3 2023 年 6 月]-组
此远程队列管理器连接是否属于队列管理器组。
此选项只能在添加新的远程队列管理器连接时使用,并且仅对消息传递 REST API有效。
-uniqueName uniqueID
远程队列管理器连接的唯一名称。 这是 IBM MQ Console中显示的名称。
请使用使队列管理器处于远程状态的名称。 例如,如果要为与队列管理器 QM2的远程连接指定唯一名称,那么可以指定远程名称 "remote-QM2"
必须在以下情况下指定唯一名称:
  • 当远程队列管理器连接信息中可能已存在同名的队列管理器时,添加新的远程队列管理器连接。 在这种情况下,您还必须指定 -qmgrName 参数以指定要为其创建唯一名称的队列管理器。
  • 删除具有唯一名称的远程队列管理器连接。
  • 修改具有唯一名称的远程队列管理器连接。
-qmgrName qmgrName
要添加或更新的队列管理器的名称。
必须指定此参数以添加新的远程队列管理器连接。 在 IBM MQ Console 中,该名称显示为 remote_qmgrName
-sf keyfilePath
密钥文件的位置,该文件包含用于对远程队列管理器连接信息中存储的密码进行加密的初始加密密钥。
初始键是必须包含至少一个字符的单行的文件。 但是,您应该使用至少为 16 个字符的密钥。 例如,初始密钥文件可能包含以下加密密钥:
Th1sIs@n3Ncypt|onK$y
请确保使用操作系统许可权对密钥文件进行充分保护,并确保加密密钥对于密钥文件是唯一的。
如果未提供密钥文件,那么将使用缺省密钥。
您还可以使用 MQS_REMOTE_KEYFILE 环境变量来提供密钥文件的路径。
-jsonkey value| -d | -i
jsonkey
要添加,更新或除去的属性的名称。 要添加或更新值,请在 jsonkey 属性之后指定值。 要删除值,请在 jsonkey 属性后指定 -d 标志。
您可以添加,更新或除去两种类型的属性。 第一种类型是可以使用 setmqweb remote 命令设置的全局属性,而不指定队列管理器名称或唯一名称。 第二种类型是特定于单个远程队列管理器连接的属性。 仅当您还指定了队列管理器名称和/或唯一名称时,才能使用 setmqweb remote 命令设置这些属性。
以下值是必须在没有队列管理器名称或 setmqweb remote 命令中唯一名称的情况下指定的有效 jsonkey 值:
globalTrustStorePath
信任库 JKS 文件的路径。 除非 trustStorePath 条目中的特定远程队列管理器连接信息覆盖此信任库,否则此信任库将用于所有远程连接。
此 jsonkey 的值是字符串值。
globalTrustStorePassword
全局信任库的密码。
此 jsonkey 的值是字符串值,并且在远程队列管理器连接信息中对其进行加密。
globalKeyStorePath
密钥库 JKS 文件的路径。 此密钥库用于所有远程连接,除非它被 keyStorePath 条目中的特定远程队列管理器连接信息覆盖。
globalKeyStorePassword
全局密钥库的密码。
此 jsonkey 的值是字符串值,并且在远程队列管理器连接信息中对其进行加密。
以下值是需要您在 setmqweb remote 命令中指定队列管理器名称或唯一名称的有效 jsonkey 值:
ccdtURL
与远程队列管理器关联的 CCDT 文件的路径。
此 jsonkey 的值是字符串值。
username
用于远程队列管理器连接的用户名。
此 jsonkey 的值是字符串值。
密码
与用于远程队列管理器连接的用户名相关联的密码。
此 jsonkey 的值是字符串值,并且在远程队列管理器连接信息中对其进行加密。
enableMutualTLS
此远程队列管理器连接是否添加密钥库以启用相互 TLS。
此 jsonkey 的值是布尔值。
keyStorePath
密钥库 JKS 文件的路径。
此 jsonkey 的值是字符串值,它将覆盖全局密钥库值。
keyStorePassword
密钥库文件的密码。
此 jsonkey 的值是字符串值,并且在远程队列管理器连接信息中对其进行加密。
trustStorePath
信任库 JKS 文件的路径。
此 jsonkey 的值是字符串值,它将覆盖全局信任库值。
trustStorePassword
信任库文件的密码。
此 jsonkey 的值是字符串值,并且在远程队列管理器连接信息中对其进行加密。
[MQ 9.3.3 2023 年 6 月]可见性
此远程队列管理器连接是否可由消息传递 REST API和/或 IBM MQ Console使用。
此 jsonkey 的值可以是下列其中一个值:
消息传递
队列管理器连接只能由消息传递 REST API使用。
控制台
队列管理器连接只能由 IBM MQ Console使用。
消息传递,控制台
队列管理器连接可以由消息传递 REST APIIBM MQ Console使用。
此 jsonkey 的值是字符串值。 缺省值为 messaging,console
要添加或更新的 JSON 密钥条目的值。
这些值区分大小写,必须用双引号括起。
-d
从远程连接信息中删除指定的属性。
-i
对指定的 JSON 密钥条目启用交互方式。 然后,在命令运行时,系统会提示您输入 JSON 键值。
-d
删除具有指定唯一名称的队列管理器的连接信息。
-r
重置并除去所有远程连接信息。
-l
启用详细日志记录。 诊断信息将写入 mqweb 服务器日志文件。

返回码

表 1. 返回码标识和描述
返回码 描述
0 Command successful.
>0 命令不成功。
有关服务器命令退出代码的完整列表,请参阅 WebSphere® Application Server 文档中的 Liberty: server command options
[MQ 9.3.0 2022 年 6 月]

示例

以下示例设置远程队列管理器连接的全局密钥库的路径:
setmqweb remote -globalTrustStorePath "c:\supersecure\keys.jks"
以下示例在远程队列管理器连接信息中为队列管理器 QM2创建新条目。 此示例设置 CCDT URL,要用于连接的用户名和密码以及密钥库路径:
setmqweb remote add -qmgrName "QM2" -ccdtURL "c:\myccdts\cdt.json" -username "user" -password "password" -keyStorePath "c:\supersecure\keys.jks"
以下示例为另一个也名为 QM2的队列管理器创建新条目,并指定用于区分两个 QM2 队列管理器的唯一名称。 此示例设置 CCDT URL,用户名和密码。 此示例使用 -i 选项在命令运行时以交互方式输入与用户名关联的密码:
setmqweb remote add -uniqueName qm2remote -qmgrName "QM2" -ccdtURL "c:\myccdts\cdt.json" -username "mqadmin" -password -i 

相关命令

表 2. 相关命令和描述
命令 描述
setmqweb 属性 (设置 mqweb 服务器配置属性) 配置 mqweb 服务器属性。
setmqweb pid (设置 mqweb 服务器产品标识) 配置 mqweb 服务器在 z/OS 上运行时所使用的产品标识
strmqweb 启动 mqweb 服务器。
endmqweb 停止 mqweb 服务器。
dspmqweb status 显示 mqweb 服务器的状态。
dspmqweb 属性 显示 mqweb 服务器配置属性。
dspmqweb 远程 显示 mqweb 服务器远程队列管理器配置。