BFAgent.conf 参考

bfagent.conf 文件用于存储 Rational® 构建代理程序运行方式的设置。该文件与 bfagent 可执行文件位于相同的目录中。

该文件列出所有设置和内部缺省值。非活动设置会注释掉。

设置:

activity_log path
打开活动记录。该信息会附加到 path 指定的文件。该路径必须存在,且代理程序用户必须对其具有写许可权。
注: 即使该路径不存在,或者它无法写入该文件,那么代理程序也不会报告错误。
要点: 文件大小没有限制。该文件必须手动进行删除。此设置供临时使用以调试代理程序。它不能用作工作中代理程序的永久日志。
allow IP-address-or-range [...]
此设置仅适用于以下条件:
  • 在 Windows 上运行的代理程序
  • 当启动时使用 -s 选项时,UNIX 或 Linux 上以独立模式运行的代理程序。

此设置会限制与代理程序的连接。仅允许从匹配 IP-address-or-range 的 IP 地址进行连接。缺省情况下,允许从所有地址进行连接。

指定以下一个或两个项目:
  • IP 地址:标准 IPv4 或 IPv6 地址。例如,对于 IPv4,是 255.192.192.003。允许特定 IP 地址。
  • IP 地址范围:部分限定 IPv4 或 IPv6 地址。对于 IPv4,以下示例正确:192.168 或 192.168.63。允许匹配此限制的所有 IP 地址。
注: 如果您正在超级服务器(例如 inetd 或 xinetd)上运行代理程序,请使用其他方法来控制访问。您可以使用防火墙、TCP 包装程序(hosts.allow 和 hosts.deny)或 xinetd 的内置过滤功能。
bind
此设置允许用户为代理程序指定显式绑定地址。此设置与“端口”设置一起,确定当使用 -s 命令行选项启动代理程序时,该代理程序侦听连接的方式。bfagent.conf 文件中提供的值将强制代理程序与 IPv4 本地主机地址绑定;因此,该代理程序将只接收来自同一台机器上控制台的连接。例如:bind 255.192.192.003
注: 这对系统服务体系结构所启动的 Windows 或 UNIX 代理程序(例如 inetd、xinetd 或 launchd)无效。
ccviewroot root-path
此设置指定此主机的缺省视图 root。请参阅 init 上的 ClearCase® 文档,以了解更多信息。内部缺省值如下所示:
  • Windows:ccviewroot M:
  • UNIX 或 Linux:ccviewroot /view
command_output_cache size
此设置会导致代理程序高速缓存输出,直到达到指定的大小(以字节为单位)为止。内部缺省值不用于高速缓存。使用高速缓存可以显著提高代理程序性能并降低网络开销。高速缓存大小取决于该命令产生的输出量。

最小值:2048。如果设置小于值 2048,那么内部使用该值。

cygwin

此设置仅与 Windows 上的代理程序搭配使用。

此设置使得代理程序在使用 Cygwin(类似于 Linux 环境)的 Windows 主机上运行。当使用 Cygwin 时,大量的 Linux 工具对该代理程序可用。

当使用此设置时,您可能需要设置 cygwin_script_magic,还有 Shell 设置。该示例显示一个方法来配置以下设置:
cygwin
shell C:\cygwin\bin\bash.exe --login -c "%s"
cygwin_script_magic #!/bin/bash

Shell 设置必须匹配您的 Cygwin 安装。

cygwin_script_magic

此设置仅在设置了 cygwin 时,与 Windows 上的代理程序搭配使用。

此设置指定 #! 行在执行步骤时使用。缺省值是 #!/bin/bash。

default_logon_domain
指定当认证请求不包括域时所使用的域。如果未指定,那么使用代理程序机器的域。
disable_telnet
要获取最佳结果,请使用 Telnet 来测试代理程序连接。
对于代理程序,有一些与处理和正确处理 Telnet 控制序列相关联的内置处理开销。
使用此设置来禁止代理程序处理能够略微改进性能的特殊 Telnet 字符代码。在产品环境中,使用此环境可以改进性能。
disable_transcode
当操作系统不使用 UTF-8 编码时,关闭代理程序执行以转换内部数据的处理。要避免混合编码和数据毁损,请为代理程序操作系统使用 UTF-8。
如果操作系统未使用 UTF-8 编码,那么代理程序必须将数据转换为正确的操作系统语言环境设置编码。
如果您的操作未使用 UTF-8,那么使用此设置以获取代理程序的最佳结果并改进性能。
enable_agent_dll
此设置会启动 DLL 过程跟踪,这是调试工具。
enable_credential_retention
当代理程序向作业监视器进行认证时,此设置将致使其复用您第一次向其进行认证时指定的凭证。
注意:
  • 如果保留 conf 文件中的 jcl_submit_user 设置,那么它将覆盖 enable_credential_retention 设置,并且代理程序 将使用您在 jcl_submit_user 中指定的用户名和密码。
  • 除了指定这些设置以外,还可以使用 .submitJCL 命令的 -u 选项指定用户名和密码。
env_recursion_limit number-of-recursions
设置预解析的 variable-replacement 递归限制。如果未设置,那么限制是 32。
extensions
此设置指定外部函数库的路径。函数可用作步骤中的点命令。如果未指定此设置,那么不会装入外部库。

解析期间,步骤命令中的第一个令牌将用作函数名。第二个令牌是字符串,而第三个是整数超时值(以秒为单位)。

需求:操作系统中的动态装入程序支持。例如,在 UNIX 或 Linux 上,您需要 /usr/include/dlfcn.h。这些缺省值在内部使用。
  • UNIX 或 Linux:/usr/local/bin/bfextensions.so
  • Windows:c:\program files\ibm\build forge\agent\bfextensions.dll
getaddrinfo_using_addrconfig
此设置仅用于在 UNIX 或 Linux 操作系统 (bfagent -s) 上将代理程序作为独立服务运行。此设置使得代理程序在呼叫 getaddrinfo() 以选择侦听接口时使用 AI_ADDRCONFIG。缺省情况下,不使用 AI_ADDRCONFIG。

如果您使用此设置,那么代理程序会忽略未正确配置地址的接口。它只会侦听已适当配置地址的接口。

jcl_submit_user user:encoded-password
作业监视器需要有效的凭证以提交作业。要指定将要向 JES 提交作业的用户的用户名和密码,必须使用 jcl_submit_user 参数。要生成经过编码的密码,请从 z/OS® Shell 运行 bfagent -e [Password] 并将代理程序所显示的值与用户标识一起粘贴到此设置中。
lang lang-code

此设置指定代理程序用来编写消息和命令输出的语言。

内部缺省值是 en,前提是已按如下所示显式对其进行设置:

lang en
leave_tmp_file

仅当您进行故障诊断时使用此设置。

此设置导致在执行命令之后,保留而非删除用来保留步骤命令的临时文件。

注: 请勿将此设置用于典型操作。
locale locale-code.charset-code

此设置仅与 UNIX 和 Linux 操作系统搭配使用。Windows 会以不同的方式处理各种语言环境。

此设置会指定本地化应用程序使用的语言和多字节字符集。此设置通过设置代理程序上下文的 LANG 环境变量工作。

要设置代理程序以将命令输出视为 US English UTF-8,请对您的操作系统使用 UTF-8 语言环境。例如,在 Linux 上使用以下说明。
locale en_US.UTF-8

要对您的操作系统确定正确的 UTF-8 语言环境说明,请运行 locale -a 命令。

如果未指定此设置,那么代理程序会使用操作系统的语言环境。此设置很便利。如果操作系统的缺省语言环境不是您想要代理程序使用的语言环境,那么此设置特别有用。如果无法更改系统语言环境以满足代理程序需求,那么该设置特别有用。

magic_login user:encoded-password

代理程序通常会使用管理特权(例如 root 或 admin)来登录操作系统。magic_login 设置是标准系统认证的备用设置。使用此设置,系统可以使用单一用户名和密码认证登录。

如果以 root 或 admin 用户身份运行代理程序,那么会忽略此设置,并尝试常规认证。

代理程序使用启动代理程序的用户(而非用来登录的用户名)的许可权运行所有命令。

此设置仅适用于以下状况:
  • 不能使用管理特权运行代理程序的时候。例如,将此设置与不会与 PAM 一起工作的 UNIX 系统搭配使用。
  • 由于安全策略,不允许使用管理特权运行代理程序的时候。
如果要配置代理程序的登录,请创建使用用户名和密码的服务器认证。对于此示例,用户名是 build,且密码是 MySecretPassword.
  1. 创建使用代理程序的服务器。在认证字段中,将服务器认证与此服务器相关联。
  2. 为代理程序生成经过编码的密码。在代理程序的安装目录中,使用您选择的密码运行 bfagent -P。

    会返回 SMD5 散列编码的密码,如下所示:

    bfagent -P MySecretPassword
    eca0b7f2f4fbf110f7df570c70df844e1658744a4871934a
  3. 在 bfagent.conf 中,设置 magic_login 以使用想要的用户名和经过编码的密码。
    magic_login build:eca0b7f2f4fbf110f7df570c70df844e1658744a4871934a
  4. 启动代理程序。
  5. 测试服务器连接。在服务器中,选择服务器,然后单击测试服务器。
map drive-and-user-spec[; ...]
此设置会指定映射的驱动器。某些系统可能需要驱动器映射。例如,因为 Shell 是从共享驱动器运行,所以可能需要驱动器映射。先执行在代理程序上指定的映射,然后执行在“管理控制台上”由 _MAP 环境变量指定的映射。此示例说明了两个驱动器映射:
map X:=//host1/share;Z:=//host2/share(username,password)
map_drive_is_failure
指定时,此设置会导致在步骤执行之前,步骤在遇到未映射的驱动器规范时失败。如果未指定此设置,那么步骤会忽略驱动器失败,并尝试运行步骤。在该情况下,确保失败会生成有用的错误消息。
no_preparse_command
此设置会禁用在将命令传递到 Shell 之前,代理程序通常对命令执行的 variable-expansion 解析。另请参阅 _NO_PREPARSE_COMMAND 环境变量,该环境变量可用于单一项目或步骤。
no_pty

此设置仅与在 UNIX 或 Linux 系统上运行的代理程序搭配使用。

此设置可用来帮助阻止在 Shell 与代理程序伪终端交互时系统 Shell 锁定。此设置通常与 HP/UX 和 z/OS 搭配使用。还可以使用两个其他方法帮助阻止这种锁定:
  • 使用备用 Shell。
  • 使用 nologonshell 设置
no_pty 设置会禁用伪终端分配。
注: 使用 no_pty 会影响某些命令。例如,ls 命令会在单一列而非三列中返回输出。如果您使用此设置,那么在将作业部署到生产环境之前进行整体测试。
nologonshell

此设置仅与在 UNIX 或 Linux 上运行的代理程序搭配使用。

此设置会导致代理程序运行的 Shell 成为一般 Shell,而非登录 Shell。此设置通常用于以下情况:
  • 登录 Shell 提供详细输出。
  • 登录 Shell 以不想要的方式更改环境设置。
  • 登录 Shell 会尝试与用户交互通信。

设置时,会使用要求 Shell 作为一般 Shell 而非登录 Shell 的标准方法。这可能不会在所有平台上工作,而在这种情况下,可能使用 shellflag 设置将标志传递到 Shell,以便修改其行为。

因为代理程序以用户身份运行,而非作为交互用户,所以代理程序不想要那些行为。
注: Mac OS X 10.5 系统使用不对 nologonshell 进行响应的 /bin/bash。使用 shellflag -l。
注: z/OS 操作系统总是将 /etc/profile 脚本同时用于登录 Shell 和非登录 Shell。如果脚本的行为与代理程序不匹配,那么您可能需要更改脚本的内容,或者使用其他 Shell。

另请参阅 shellflag 设置。可以使用标志更改登录脚本行为。

password_encrypt_module dll_path;conf_path
在代理程序上启用 SSL 需要此内容。他指定 DLL 和配置文件的路径。
  • dll_path 是 bfcrypt.dll 的路径(它通常是 ./bfcyrpt.dll)。
  • conf_path 是 bfpwcrypt.conf 的路径(它通常是 ./bfcrypt.conf)。
port port-number-or-range [...]

此设置仅与当您在启动时发出 -s 选项时,在 UNIX 或 Linux 上以独立方式运行的代理程序搭配使用。

此设置指定代理程序用来侦听与“管理控制台”连接的端口。
  • UNIX 或 Linux 上以独立方式运行的代理程序(启动时 -s 选项)。
指定代理程序用来侦听与“管理控制台”连接的端口。
注: 缺省情况下,该端口设置为 5555。对于 UNIX 或 Linux,该设置位于 /etc/services 中。
shell shell_name [options]
此设置指定缺省 Shell。内部缺省值如下所示:
  • Windows:shell cmd.exe /q /c "%s",除非使用以下设置:
    • 如果使用了 cygwin 设置,那么缺省值是 shell C:\cygwin\bin\bash.exe --login -c "%s"
    • 如果未使用 cygwin 设置,那么缺省值是 shell cmd.exe /u /q /c "%s"
  • UNIX 或 Linux:为用户帐户设置的 Shell,或者 /bin/sh(如果无法确定用户的 Shell)。请注意,您不能在此设置中指定参数,但是可以使用 shellflag 设置传递这些参数。代理程序会通过插入连字符,自动将缺省值强制为登录 Shell。例如,/bin/ksh 作为 -ksh 发送。如果明式设置了 shell,那么会暗示设置 nologonshell。请参阅 nologonshell。
  • System i®:将 Shell 值设置为 /bin/sh

您可以从步骤内部覆盖此设置。以包含 #! 的行开始的步骤会覆盖 Shell 设置,且 nologonshell 设置用来运行步骤命令。

shell_compatible_undef_vars
此设置会将未定义的变量说明强制为空字符串。如果未设置,那么说明是格式为 $VAR、${VAR} 或 %VAR% 的变量的变量名称,而 $[VAR] 表示空字符串。
shellarg

此设置仅与正在 UNIX 或 Linux 上运行的代理程序搭配使用。

如果命令看起来混乱,那么使用此设置。Red Hat Linux Enterprise 上的某些 Shell 需要此设置。

该设置会更改将命令脚本传递给 Shell 的方法。通常脚本是通过标准输入进行传递的:
   /bin/sh < /tmp/bfshellscript.sh
此设置通过将脚本作为参数进行传递,从而运行脚本:
/bin/sh /tmp/bfshellscript.sh
shellflag flag

此设置仅与正在 UNIX 或 Linux 上运行的代理程序搭配使用。

此设置会在 Shell 运行时添加标志。只能指定一个标志。它通常用来禁用 rc 脚本处理,从而减少输出或不想要的处理。

示例:
  • csh 和 derivatives:使用 shellflag -f 来禁用 rc 脚本处理。
  • bash:使用 shellflag --noprofile 来禁用概要文件脚本处理。
ssl_ca_location path
指定其中包含在客户机认证结果为 true 时使用的认证中心的密钥库文件。如果代理程序作为服务运行,那么使用绝对路径。
ssl_cert_location path
指定其中包含公用证书的密钥库。如果代理程序作为服务运行,请使用绝对路径。
ssl_client_authentication [true | false]
设置为 true,以在连接至代理程序时需要客户机认证。如果值为 true,那么必须将 Build Forge® 引擎的证书添加至代理程序的认证中心密钥库(由 ssl_ca_location 指定)。
ssl_cipher_group [grouplist | ALL]
指定要使用的单个 cipher 组。可以设置为 ALL。
ssl_cipher_override cyphers
覆盖密码组。指定要使用的密码。
ssl_key_location path
指定其中包含专用密钥的密钥库文件。如果代理程序作为服务运行,那么使用绝对路径。
ssl_key_password password
专用密钥的密码。缺省情况下,此属性以明文存储。您可以使代理程序使用其自己的密钥或 Build Forge 服务器的密钥,来加密此密码。
ssl_protocol protocol
要使用的 SSL 握手协议,SSL、SSLv2、SSLv3、SSL_TLS、TLS、TLSv1 其中之一。该协议必须匹配 Build Forge 服务器使用的协议。
tmpdir
指定代理程序需要创建的任何临时文件的位置。如果省略了 tmpdir 关键字,那么代理程序将使用 /tmp 作为临时文件的位置。
update_path path
此设置会识别 Build Forge 代理程序可执行文件的完整路径。在安装期间会自动建立该设置。该目录是您指定的操作系统或安装目录的缺省目录。
注: 在 Windows 代理程序上会忽略此设置。更新路径从注册表键中获取。在代理程序安装期间设置这些键。
win_reexec_after_auth
如果您需要使用 Build Forge 服务器认证凭证在网络共享文件系统上运行代理程序命令,请添加此设置。例如,要在 ClearCase 动态视图中修改文件,代理程序必须访问网络化的共享文件系统上的 ClearCase 文件。
Build Forge 代理程序最初是使用 Windows 系统帐户凭证启动。要运行命令,稍后代理程序会使用 Build Forge 服务器认证凭证,向 Windows 进行认证。
没有此设置,网络共享只会识别初始 Windows 系统帐户凭证,并忽略访问和写入网络共享文件系统上的文件所需要的后续服务器认证凭证。
win_reexec_after_auth 通过使用服务器认证凭证,再次向 Windows 进行认证之后启动新的过程,并强制共享文件系统识别更改的凭证。
当您使用 win_reexec_after_auth 设置时,代理程序作为服务运行,且不会区分访问网络共享文件的命令与不访问网络共享文件的那些命令,因此您可以能会发现性能影响。
注: jazz.net 库中有关在 IBM i 上安装 Rational solution for CLM 产品的最新条目

反馈