fteSetAgentLogLevel（打开或关闭将某些 "MFT代理操作记录到文件的功能）

[长期支持]使用 fteSetAgentLogLevel 命令为协议网桥代理与文件服务器之间的交互以及资源监视器活动打开或关闭日志记录。 [MQ 9.2.4 2021 年 11 月]使用 fteSetAgentLogLevel 命令为协议网桥代理与文件服务器之间的交互，资源监视器活动和传输日志打开或关闭日志记录。

用途

IBM® MQ Managed File Transfer 提供了可用于捕获的日志记录机制:
  • 有关协议网桥代理与文件服务器之间的流的信息
  • 有关资源监视器执行的轮询的详细信息
  • [MQ 9.2.4 2021 年 11 月]传输进度
使用 fteSetAgentLogLevel 命令对协议网桥代理启用日志记录时，代理会记录发送到文件服务器的 FTP ， SFTP 和 FTPS 命令的详细信息以及接收到的响应。 此信息将写入名为 agenteventN.log的日志文件，其中 N 代表数字。
  • [UNIX、Linux、Windows、IBM i]在 Multiplatforms 版上， agenteventN.log 文件位于 MQ_DATA_PATH/mqft/logs/coordination_qmgr_name/agents/agent_name 目录中。
  • [z/OS]在 z/OS®上， agenteventN.log 文件位于 BFG_DATA/mqft/logs/coordination_qmgr_name/agents/agent_name 目录中。

日志文件中的信息可用于诊断涉及协议网桥代理的文件传输期间可能发生的问题。

使用 fteSetAgentLogLevel 命令对资源监视器启用日志记录时，代理程序会将有关监视器执行的轮询的信息记录到名为 resmoneventN.log的日志文件中，其中 N 代表数字。
  • [UNIX、Linux、Windows、IBM i]在 Multiplatforms 版上， resmoneventN.log 文件位于 MQ_DATA_PATH/mqft/logs/coordination_qmgr_name/agents/agent_name 目录中。
  • [z/OS]在 z/OS上， resmoneventN.log 文件位于 BFG_DATA/mqft/logs/coordination_qmgr_name/agents/agent_name 目录中。
日志文件中的信息包括:
  • 监视器启动和完成轮询的时间。
  • 作为轮询结果提交的任何受管传输的详细信息。

有关资源监视器日志记录的更多信息，请参阅 记录 MFT 资源监视器。

您可以通过两种方式开启，关闭和设置所需的日志记录级别:
  • 使用 fteSetAgentLogLevel 命令在代理程序运行时启用或禁用日志记录。 您不需要重新启动代理程序以使对日志记录级别的更改生效。
  • 设置 agent.properties 文件中的属性以启用或禁用日志记录启动。 需要设置的属性取决于是对协议网桥代理启用日志记录，还是对资源监视器启用日志记录:
    • 对于协议网桥代理，使用 agentLog 属性来控制日志记录。
    • 要启用或禁用资源监视器日志记录，请使用 resourceMonitorLog 属性。
[MQ 9.2.4 2021 年 11 月] 如果使用 fteSetAgentLogLevel 命令来启用传输日志记录，那么代理会将有关传输进度的信息记录到名为 transferlog0.json的日志文件中。
  • [UNIX、Linux、Windows、IBM i]在 Multiplatforms 版上， transferlog0.json 文件位于 MQ_DATA_PATH/mqft/logs/coordination_qmgr_name/agents/agent_name/logs 目录中。
  • [z/OS]在 z/OS上， transferlog0.json 文件位于 BFG_DATA/mqft/logs/coordination_qmgr_name/agents/agent_name/logs 目录中。
有关更多信息，请参阅 agent.properties 文件。
注意: 当命令在运行高可用性 (HA) 代理程序的备用实例的系统上运行时，新日志级别仅应用于该实例。 将不会更改代理程序的活动实例以及任何其他备用实例上的日志级别。

Syntax - LogAgent option

Read syntax diagramSkip visual syntax diagram fteSetAgentLogLevel -p configuration_options -logAgent ,,ftpftpssftp=on=off -logfilterhost=valuemetadata=value agent_name

Syntax - log monitor option

Read syntax diagramSkip visual syntax diagram fteSetAgentLogLevel -p configuration_options-logMonitor,,monitor_name=info=moderate=verbose=off agent_name
[MQ 9.2.4 2021 年 11 月]

语法-日志传输选项

读取语法图跳过可视语法图 fteSetAgentLogLevel -pconfiguration_options -logTransfer ,=info=moderate=verbose=offagent_name
注：
[长期支持]必须仅选择 logAgent 和 logMonitor 选项之一。 如果同时指定这两个选项，那么该命令将失败并返回以下错误消息:
BFGCL0756E:Invalid 命令选项无效。 请指定 logAgent 或 logMonitor 选项，但不能同时指定。
[MQ 9.2.4 2021 年 11 月]必须仅选择 logAgent， logMonitor 或 logTransfer 选项之一。 如果指定多个选项，那么该命令将失败并显示以下错误消息:
BFGCL0756E:Invalid 命令选项无效。 只指定logAgent, logMonitor,或logTransfer选项中的一个。

参数

--logMonitor monitor_name=log_level
必需。
资源监视器和日志记录级别的逗号分隔列表，其中:
Monitor_Name
可选。 要应用日志记录级别的资源监视器的名称或以逗号分隔的资源监视器列表。 如果未指定监视器名称或以逗号分隔的资源监视器列表，那么会将日志记录级别应用于代理程序中运行的所有资源监视器。
注意: 如果在命令中指定了不存在的资源监视器名称，那么控制台上不会显示任何错误。
LOG_LEVEL
必需。
要使用的日志记录级别。 这可以为以下值之一：
info
开启信息级别日志记录。 这是缺省值，并为代理程序的资源监视器启用高级别日志记录。
要对代理 AGENT1 的监视器 MON1 启用 info 级别的日志记录：
fteSetAgentLogLevel -logMonitor MON1=info AGENT1
moderate
开启适量级别日志记录。
要对代理 AGENT1 的监视器 MON1 和 MON2 启用 moderate 级别日志记录：
fteSetAgentLogLevel -logMonitor MON1,MON2=moderate AGENT1
verbose
开启详细级别日志记录。
要对代理 AGENT1 的所有监视器启用 verbose 级别日志记录：
fteSetAgentLogLevel -logMonitor =verbose AGENT1
关
关闭日志记录。
要对代理 AGENT1 的监视器 MON1 和 MON2 关闭日志记录：
fteSetAgentLogLevel -logMonitor MON1,MON2=off AGENT1
要对监视器 MON1 关闭日志记录并对代理 AGENT1 的监视器 MON2 启用 info 级别日志记录：
fteSetAgentLogLevel -logMonitor MON1=off,MON2=info AGENT1
要对代理 AGENT1 的所有监视器关闭日志记录：
fteSetAgentLogLevel -logMonitor=off AGENT1
如果在命令中重复使用同一个资源监视器名称，那么会将最后一次出现的组件视为有效组件。 例如：
fteSetAgentLogLevel -logMonitor MON1=info,MONZ=off,MON1=off AGENT1 turns off logging for resource monitor MON1.
有关不同日志记录级别以及在每个级别记录的资源监视器事件的更多信息，请参阅 日志记录 MFT 资源监视器。

[MQ 9.2.4 2021 年 11 月]不能将 logMonitor 选项与 logAgent 和 logTransfer 选项配合使用。

--logAgent component=operation
必需。
可以对 FTP ， FTPS 和 SFTP 协议启用或禁用协议网桥代理日志记录。 指定三个可能的服务器协议之一，并添加操作值以关闭或打开协议网桥代理的日志记录。
组件
可选。
有效组件包括:
ftp
日志记录操作将应用于协议网桥代理与使用 FTP 协议的文件服务器之间的所有通信。
ftps
日志记录操作将应用于协议网桥代理与使用 FTPS 协议的文件服务器之间的通信。
sftp
日志记录操作将应用于协议网桥代理与使用 SFTP 协议的文件服务器之间的通信。
如果组件以加号 (+) 开头，那么将向目前正在记录的所有现有日志组件添加加号后面的组件列表。
操作
有效日志级别操作选项如下：
关
对协议网桥代理禁用所有日志记录。 此选项为缺省值。
fteSetAgentLogLevel -logAgent =off PBA1
要对协议网桥代理连接到的指定组件禁用日志记录，请使用以下命令：
fteSetAgentLogLevel -logAgent ftp=off PBA1
fteSetAgentLogLevel -logAgent ftps=off PBA1
fteSetAgentLogLevel -logAgent sftp=off PBA1
开启
要对协议网桥代理连接到的全部三个可能的文件服务器组件启用日志记录，请使用以下命令：
fteSetAgentLogLevel -logAgent =on PBA1
要对协议网桥代理连接到的指定组件启用日志记录，请使用以下命令：
fteSetAgentLogLevel -logAgent ftp=on PBA1
fteSetAgentLogLevel -logAgent ftps=on PBA1
fteSetAgentLogLevel -logAgent sftp=on PBA1
如果任何组件以加号 (+) 开头，那么会将加号后面的组件列表添加到当前正在记录的任何现有日志组件。
有关更多配置选项，请参阅 示例 1 和 示例 2。
[MQ 9.2.4 2021 年 11 月]不能将 logAgent 选项与 logTransfer 和 logMonitor 选项配合使用。
--logFilter 过滤器=值
可选。
使用 logFilter 参数可根据指定的过滤条件来限制协议网桥代理日志记录。 必须为一个或多个文件服务器主机指定值，或者为受管传输指定用户元数据中的属性。
主机
使用 host 按以下内容进行过滤:
  • 文件服务器所在系统的主机名。
  • 以逗号分隔的主机名或 IP 地址的列表。
要记录发送到文件服务器 ftpprod.ibm.com的 FTP 命令以及从该文件服务器接收的响应，请使用以下命令:
fteSetAgentLogLevel -logAgent ftp=on -logFilter host=ftpprod.ibm.com PBA1
要记录发送到具有以 9.182.*开头的 IP 地址的所有文件服务器的 SFTP 命令以及从这些服务器接收的响应，请使用以下命令:
fteSetAgentLogLevel -logAgent sftp=on -logFilter host=9.182.* PBA1
元数据
以 key=value 格式按用户在传输创建期间的定义指定任何文本。 例如，metadata="BANK=WORLD BANK"。
要对使用 FTP 协议连接到协议网桥代理 PBA1 的所有文件服务器启用日志记录，并将输出过滤为仅包括包含元数据 "BANK=WORLD BANK"的受管传输的条目，请使用以下命令:
fteSetAgentLogLevel -logAgent ftp=on metadata="BANK=WORLD BANK" PBA1
注: 为了按元数据进行过滤，必须在 -md 参数下指定要作为文件传输的一部分进行过滤的值。 更多信息，请参阅fteCreateTransfer（开始新的文件传输）。
[MQ 9.2.4 2021 年 11 月]-logTransfer log_level
必需。
注意: 如果 fteSetAgentLogLevel 命令由启动代理程序的其他用户运行，那么会在控制台上输出错误消息 BFGNV0066E :
打开或关闭传输日志。 可能的日志级别为:
info
开启传输的高级别日志记录信息。
要启用代理程序 AGENTQM的 info 级别传输日志记录:
fteSetAgentLogLevel -p AGENTQM -logTransfer info SRC
这是缺省值，这意味着将为每个传输写入高级别传输日志，并且将使用文件系统空间，最多为 100MB。
moderate
打开传输的中间级别日志信息
verbose
打开传输的详细日志信息。
启用代理程序 AGENTQM的详细级别日志记录:
fteSetAgentLogLevel -p AGENTQM -logTransfer verbose SRC
关
关闭传输日志记录。
要关闭代理程序 AGENTQM的传输日志记录:
fteSetAgentLogLevel -p AGENTQM -logTransfer off SRC
不能将 logTransfer 选项与 logAgent 和 logMonitor 选项配合使用。

请参阅 LogTransfer 函数生成的输出 ，以获取生成的日志记录信息的示例。

--p 配置选项
可选。
确定用于设置代理日志级别的配置选项集。 将配置选项集的名称用作 -p 参数的值。
按照约定，这是协调队列管理器的名称。 如果未指定该参数，那么会使用缺省的配置选项集。
-或-h
可选。 显示命令语法。
agent_name
必需。 为其启用或禁用日志记录的协议网桥代理的名称。
注意: 如果在命令中指定了不存在的资源监视器名称，那么控制台上不会显示任何错误。

示例 1

在此示例中，通过使用命令定界组在一个命令中指定多个组件。 在协议网桥代理 PBA1上，将对 FTP 和 SFTP 协议启用日志记录，并对 FTPS 协议禁用日志记录。
fteSetAgentLogLevel -logAgent ftp=on,ftps=off,sftp=on PBA1
您还可以使用逗号分隔组件以实现相同的结果，例如：
fteSetAgentLogLevel -logAgent ftp,sftp=on,ftps=off PBA1

示例 2

在此示例中，在命令中重复了同一组件。 component=operation 对的最后一个实例被视为有效。 此示例在协议网桥代理 PBA1上禁用 FTP 协议的日志记录。
fteSetAgentLogLevel -logAgent ftp=on,ftp=off PBA1
上一个示例具有与此示例相同的效果：
fteSetAgentLogLevel -logAgent ftp=off PBA1

示例 3

此示例启用代理程序 AGENT1的监视器 MON1 的 info 级别日志记录的缺省值:
fteSetAgentLogLevel -logMonitor MON1=info AGENT1

示例 4

此示例针对代理程序 AGENT1的监视器 MON1 和 MON2 启用 moderate 级别日志记录:
fteSetAgentLogLevel -logMonitor MON1,MON2=moderate AGENT1

示例 5

此示例关闭监视器 MON1 的日志记录，并对代理程序 AGENT1的监视器 MON2 启用 info 级别日志记录:
fteSetAgentLogLevel -logMonitor MON1=off,MON2=info AGENT1

返回码

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