fteListTemplates(列出可用的MFT转送模板)

使用 fteListTemplates 命令可列出协调队列管理器上可用的 Managed File Transfer 传输模板。

用途

该命令列出所有模板名称或过滤的模板名称选择。 列表的输出格式可以是以下任意一种:
  • 仅模板名称(缺省行为)
  • 模板名称和模板摘要(详细方式)
  • 描述模板的完整 XML 消息(-x-o 参数)

该命令使用 coordination.properties 文件连接到协调队列管理器。 有关更多信息,请参阅 MFT coordination.properties 文件

仅当希望使用不同于缺省集的配置选项集时,才对该命令指定可选的 -p 参数。 请参阅 配置选项 以获取更多信息。

Syntax

fteListTemplates

Read syntax diagramSkip visual syntax diagramfteListTemplates-pconfiguration_options-v-x-odirectory_name-f-mquseriduser_id-nolpw-mqpasswordpassword-nolpwtemplate_names

参数

-p
可选。 该参数确定用于删除该模板的配置选项集。 按照约定,请使用非缺省协调队列管理器的名称作为该参数的输入。 然后,命令使用与此非缺省协调队列管理器相关联的属性文件集。
如果未指定该参数,那么将使用基于缺省协调队列管理器的配置选项集。
-v
可选。 指定详细方式并提供每个匹配模板的简短摘要。 如果您还指定了 -x 参数,那么会忽略该参数。
-v 参数包含每个模板的摘要。 例如:
Template Name: STANDBY
    Source Agent Name: AGENT1
    Source QMgr: QM_JUPITER
    Destination Agent Name: AGENT2
    Destination QMgr: QM_NEPTUNE
    Transfer Priority: 0
    Transfer file specification
    File Item Details
        Mode: binary
        Checksum: MD5
        Source File:
            C:\payroll_reports\*.xls
            Recursive: false
            Disposition: leave
        Destination File:
            C:\payroll_backup\*.xls
            Type: file
            Exist: error
如果未指定 -v 参数,那么缺省输出方式为列出匹配的模板名称。
-x
可选。 提供每个匹配模板的 XML 格式消息。 将忽略该参数,除非您还指定 -o 参数。
注意: XML 格式的消息与 fteCreateTemplate命令工具不兼容。
-目录名
可选。 将 XML 格式消息发送到指定目录中的文件。 会为每个模板创建一个文件,每个文件的名称与模板名称相同,后缀为 .xml。 将忽略该参数,除非您还指定 -x 参数。
-f
可选。 强制覆盖任何现有的输出文件。 将忽略该参数,除非您还指定 -o 参数。 如果未指定 -f,但指定了现有输出文件的名称,那么缺省行为是报告错误并继续。
-mquserid 用户ID
可选。 指定通过协调队列管理器进行认证时所使用的用户标识。
-mqpassword 密码
可选。 指定通过协调队列管理器进行认证时所使用的密码。
指定 -mqpassword 参数时,还必须指定 -mquserid 参数。 如果指定 -mquserid,但未指定 -mqpassword,那么系统将提示您提供关联的密码,不会显示该密码。

IBM® MQ 9.3开始,该命令缺省为使用 MQCSP 认证,并将要认证的用户标识和密码发送到 MQCSP 结构中的队列管理器。

-nolpw
可选。 如果命令连接到不支持长度超过 12 个字符的密码的队列管理器,请指定此参数。
指定 -nolpw 参数时,还必须指定 -mquserid 参数。 如果指定 -mquserid-nolpw,但未指定 -mqpassword,那么系统会提示您提供关联的密码,不会显示该密码。
注: 如果指定 -nolpw 选项,并且密码长度超过 12 个字符,那么命令将失败并返回错误消息 BFGCL0829E
模板名称
可选。 要列出的一个或多个模板名称的列表。 模板名称可以包含星号,作为与零个或更多字符匹配的通配符。 根据操作系统,您可能需要对包含通配符的任何模板名称加双引号 (" ") 或单引号 (' '),以避免 shell 扩展。 Shell 扩展会导致意外行为。
如果没有为 template_names 指定任何值,那么缺省行为是列出所有模板。
-或-h
可选。 显示命令语法。

示例

在该示例中,列出名称以 ST 开头的所有模板:
fteListTemplates "ST*"
该示例以 XML 格式消息创建模板 STANDBY,该消息将发送到当前目录中的文件 STANDBY.xml
fteListTemplates -x -o . STANDBY
该命令在 STANDBY.xml 中创建以下输出:
<?xml version="1.0" encoding="UTF-8" ?> 
- <transferTemplate id="1864c1dd-ba02-4b34-bda9-dc6862448418" version="3.00">
    <name>STANDBY</name> 
    <sourceAgentName>AGENT1</sourceAgentName> 
    <sourceAgentQMgr>QM_JUPITER</sourceAgentQMgr> 
    <sourceAgentQMgrHost>null</sourceAgentQMgrHost> 
    <sourceAgentQMgrPort>-1</sourceAgentQMgrPort> 
    <sourceAgentQMgrChannel>null</sourceAgentQMgrChannel> 
    <destinationAgentName>AGENT2</destinationAgentName> 
    <destinationAgentQMgr>QM_NEPTUNE</destinationAgentQMgr> 
  - <fileSpecs>
     - <item checksumMethod="MD5" mode="binary">
       - <source disposition="leave" recursive="false">
          <file>C:\payroll_reports\*.xls</file> 
         </source>
       - <destination exist="error" type="file">
          <file>C:\payroll_backup\*.xls</file> 
         </destination>
       </item>
    </fileSpecs>
    <priority>0</priority> 
  </transferTemplate>

返回码

表 1. 返回代码名称和描述
返回码 描述
0 命令成功完成
1 命令未成功执行