fteCreateWebAgent (创建一个 WebSphere MQ Managed File Transfer 网络代理)

fteCreateWebAgent 命令创建代理及其关联的配置,以用于 Web 网关。 此命令随 WebSphere® MQ Managed File Transfer Server 提供。

用途

使用 fteCreateWebAgent 命令以创建 Web 代理。 该命令为您提供 MQSC 命令,必须在代理使用的队列管理器上运行这些 MQSC 命令才能创建以下代理队列:
  • SYSTEM.FTE.AUTHADM1.代理名称
  • SYSTEM.FTE.AUTHAGT1.代理名称
  • SYSTEM.FTE.AUTHMON1.代理名称
  • SYSTEM.FTE.AUTHOPS1.代理名称
  • SYSTEM.FTE.AUTHSCH1.代理名称
  • SYSTEM.FTE.AUTHTRN1.代理名称
  • SYSTEM.FTE.COMMAND。代理名称
  • SYSTEM.FTE.DATA.agent_name
  • SYSTEM.FTE.EVENT。代理名称
  • SYSTEM.FTE.REPLY。代理名称
  • SYSTEM.FTE.STATE.代理名称
由于代理用于 Web 网关,因此除了先前列表外,还将创建两个队列:
  • SYSTEM.FTE.WEB.RESP。代理名称
  • SYSTEM.FTE.WEB.网关名称

这些队列是内部系统队列,除非您要删除该代理,否则不得修改、删除或读取这些队列中的消息。 以下位置的文件中也提供了要运行的 MQSC 命令:MQ_DATA_PATH\mqft\config\coordination_qmgr_name\agents\agent_name\agent_name_create.mqsc

如果稍后要删除代理,该命令还为您提供 MQSC 命令,必须运行这些 MQSC 命令才能清除然后删除属于代理的队列。 MQSC 命令位于以下位置的文件中:MQ_DATA_PATH\mqft\config\coordination_qmgr_name\agents\agent_name\agent_name_delete.mqsc

WebSphere MQ Managed File Transfer 提供了帮助您配置代理的高级代理属性。 IBM® WebSphere MQ File Transfer Edition 的属性文件中描述了这些属性。

注: 运行 Web 代理程序的用户必须与运行应用程序服务器的用户相同,或者与运行应用程序服务器的用户在同一组中相同。

Web 代理的限制

  • Web 代理只能是通过 Web 网关启动的传输的源代理。 如果尝试通过另一种方法,将 Web 代理用作源代理来执行传输,那么传输将失败,返回码为 68 (TRANSFER_NOT_SUPPORTED)。
  • 在将目标指定为文件空间时,Web 代理只能是传输的目标代理。 如果尝试将 Web 代理用作目标代理(但作为不同目标类型)来执行传输,那么该传输将失败,并返回以下错误消息:BFGCH0103: 传输请求指定 Web 网关代理“web_agent_name”作为目标代理。 Web 网关代理只能是到文件空间的传输的目标。
  • Web 代理不能监视资源。 如果尝试为 Web 代理创建资源监视器,那么该命令将失败,返回码为 113 (MONITOR_NOT_SUPPORTED)。

Syntax

fteCreateWebAgent

Read syntax diagramSkip visual syntax diagramfteCreateWebAgent-agentName? agent_name-agentQMgr? agent_qmgr_name-webGatewayName? gateway_name-agentQMgrHost?agent_qmgr_host-agentQMgrPort?agent_qmgr_port-agentQMgrChannel?agent_qmgr_channel-agentDesc?agent_description-ac-authorityChecking-pconfiguration_options-f-s?service_name-su?user_name-sp?password-sj?options-sl?options-n

参数

-agentName代理名称
必需。 要创建的代理的名称。 代理名称对其协调队列管理器必须唯一。

有关命名代理程序的更多信息,请参阅 对象命名约定

-agentQMgr代理程序队列管理器名称
必需。 代理队列管理器的名称。

-webGatewayName网关名称
必需。 代理是其一个组件的 Web 网关的名称。

有关对 Web 网关进行命名的更多信息,请参阅 对象命名约定

-agentQMgrHost代理程序队列管理器主机
可选。 代理队列管理器的主机名或 IP 地址。 如果未指定该参数,那么将采用绑定方式连接。

-agentQMgrPort代理程序队列管理器端口
可选。 用于客户机与代理队列管理器的连接的端口号。 只有当同时指定了 agentQMgrHost 参数时,才能使用该参数。 如果未指定 agentQMgrPort 参数,那么将使用缺省端口 1414。

-agentQMgrChannel代理程序队列管理器通道
可选。 只有当同时指定了 agentQMgrHost 参数时,才能使用该参数。 如果未指定 agentQMgrChannel 参数,那么将使用缺省通道 SYSTEM.DEF.SVRCONN。

-agentDesc代理程序描述
可选。 代理程序的描述,显示在 IBM WebSphere MQ Explorer 中。

-ac-authorityChecking
可选。 此参数允许进行权限检查。 如果指定该参数,那么代理将检查提交请求的用户是否有权执行请求的操作。

-p配置选项
可选。 用于创建代理的配置选项集的名称。 按照约定,这是协调队列管理器的名称。 如果未指定该参数,那么会使用缺省的配置选项集。

-f
可选。 强制该命令覆盖现有配置。

-s服务名称
可选 (仅限 Windows)。 指示代理程序将作为 Windows 服务运行。 如果未指定 服务名称,那么服务将命名为 mqmftAgent<AGENT><QMGR>,其中 <AGENT> 是代理名称, <QMGR> 是代理队列管理器名称。

服务的显示名称 (在 Windows 服务 窗口的 名称 列中显示) 始终为 WebSphere MQ Managed File Transfer 代理程序 <AGENT>@<QMGR>

-su用户名
可选 (仅限 Windows)。 当代理程序要作为 Windows 服务运行时,此参数指定应在其下运行服务的帐户的名称。 要使用 Windows 域用户帐户运行代理程序,请以 DomainName\UserName格式指定值。 要使用本地内置域中的帐户来运行该服务,请以 UserName 格式指定该值。

使用 -su 参数指定的 Windows 用户帐户必须具有 Log on as a service 权限。 有关如何授予此权限的信息,请参阅 关于将代理程序或记录器作为 Windows 服务运行的指南

在指定 -s 时为必需项。 等同于 -serviceUser

-sp密码
可选 (仅限 Windows)。 由 -su-serviceUser 参数设置的用户帐户的密码。

该参数仅在指定 -s 时才有效。 等同于 -servicePassword。 如果在指定 -s 参数时不指定该参数,将生成警告消息。 此消息警告您必须先使用 Windows 服务工具设置密码,然后服务才能成功启动。

-sj选项
可选 (仅限 Windows)。 当代理作为Windows服务启动时,会以 -D 或 -X 的形式定义一系列选项,这些选项将传递给JVM。 这些选项使用井号 (#) 或分号 (;) 字符进行分隔。 如果需要嵌入任何 # 或 ; 字符,请使用单引号将其引起来。

该参数仅在指定 -s 时才有效。 等同于 -serviceJVMOptions

-sl选项
可选 (仅限 Windows)。 设置 Windows 服务日志级别。 有效选项包括:error、info、warn 和 debug。 缺省值为 info。 如果您在 Windows 服务方面迂到问题,那么此选项很有用。 如果将其设置为 debug,那么会在服务日志文件中提供更详细的信息。

该参数仅在指定 -s 时才有效。 等同于 -serviceLogLevel

-n
可选 (仅限 Windows)。 指示代理将作为正常进程运行。 这与 -s 选项互斥。 如果既未指定 -s 选项,也未指定 -n 选项,那么会将代理程序配置为正常 Windows 进程。

等同于 -normal

-? or -h
可选。 显示命令语法。

示例

在本示例中,使用代理队列管理器 QM_NEPTUNE 和 Web 网关 GATEWAY_ONE 来创建代理 WEBAGENT1。 该代理使用缺省的协调队列管理器:
fteCreateWebAgent -agentName WEBAGENT1 -webGatewayName GATEWAY_ONE -agentQMgr QM_NEPTUNE
                  -agentQMgrHost myhost.ibm.com -agentQMgrPort 1415 -agentQMgrChannel CHANNEL1

返回码

0
命令成功完成。
1
命令结束但未成功。