将 Junos PyEZ 表与 TextFSM 模板配合使用

了解 TextFSM 模板

Junos PyEZ 操作表可以从网络设备的 CLI 或 VTY 命令输出中提取数据。表可以引用视图以将命令输出中的字段映射到 Python 对象。Junos PyEZ op 表还可以单独或与视图一起引用 TextFSM 模板来解析命令输出。Junos PyEZ op 表可以使用 TextFSM 模板来解析来自任何网络设备的命令输出，无论供应商、网络操作系统或命令如何。

TextFSM 是一个 Python 库，用于解析来自网络设备的半格式化 CLI 输出，例如 show 命令输出。它由 Google 开发，后来在 Apache 2.0 许可下发布。该模块需要一个模板和一些输入文本。该模板使用正则表达式来描述如何解析数据，您可以定义多个模板并将其应用于同一数据。

TextFSM的 CliTable 类使用户能够将给定平台上的命令映射到解析命令输出的模板。网络自动化公司 Network to Code 开发了 Python 包装器 CliTable 以及 用于网络设备的 TextFSM 模板存储库。您可以根据需要在 Junos PyEZ 服务器或虚拟环境中安装该 ntc-templates 库。然后引用 Junos PyEZ 表中的 NTC 模板和其他 TextFSM 模板。

NTC 模板可解析网络设备的 show 命令输出。每个 NTC 模板定义给定命令的预期输出字段，并为每个项将数据映射到标头。NTC 模板文件名标识平台（供应商和网络操作系统）和命令（带下划线），以便系统可以轻松确定要使用的模板。文件名格式使用以下语法：

例如，考虑 juniper_junos_show_arp_no-resolve.textfsm 模板。

该模板可 show arp no-resolve 解析运行 Junos OS 或 Junos OS 演化版的瞻博网络设备的命令输出。

Junos PyEZ 操作表可以使用 NTC 模板或其他 TextFSM 模板来解析非结构化命令输出。该表通过定义以下字段来使用 TextFSM 模板。Junos PyEZ 使用和platformcommand值来确定模板的文件名。

• command: command- 生成要解析的输出的命令。命令必须映射到 NTC 模板或其他 TextFSM 模板文件名中的命令字符串。

• key: key- 在 TextFSM 模板或 Junos PyEZ 视图中定义的字段，用于唯一标识记录项。

• platform: platform- TextFSM 模板的供应商和操作系统，例如 juniper_junos。平台值必须与 NTC 模板或其他 TextFSM 模板文件名中的平台字符串匹配。

• use_textfsm: True- 设置为 True 以使用给定平台和命令的 TextFSM 模板解析命令输出。

如何使用 TextFSM 模板解析命令输出

Junos PyEZ 表可以使用 TextFSM 模板（包括预定义的 NTC 模板）来解析 Junos 设备的 show 命令输出。

要在 Junos PyEZ 表中使用 TextFSM 模板，请执行以下操作：

1. 在 Junos PyEZ 服务器或虚拟环境中安装该 ntc-templates 库。

2. 创建自定义 Junos PyEZ 表，其中包括 command、 、 keyplatform和use_textfsm参数，以及操作所需的任何其他参数。

   Junos PyEZ 应用程序使用 和 command 值platform来确定模板的文件名，在本例中为 juniper_junos_show_arp_no-resolve.textfsm。该key值必须与模板中的标头匹配。

3. 创建使用表检索数据的 Junos PyEZ 应用程序。

4. 执行应用程序。

   该表使用 NTC 模板提取输出字段。对于每个表项，应用程序返回定义的键和每个字段的数据。

如何将 TextFSM 模板与 Junos PyEZ 视图配合使用来解析命令输出

Junos PyEZ 表可以组合 TextFSM 模板和 Junos PyEZ 视图来解析命令输出。TextFSM 模板将数据映射到标头。在视图中，您可以将变量名称映射到模板中定义的要返回的字段的标题。将模板和视图组合在一起，例如，当您想要使用与模板中定义的变量名称不同的变量名称时，或者当您想要返回不同的字段时。Junos PyEZ 仅返回 TextFSM 模板和 Junos PyEZ 视图通用的字段。

以下示例使用 juniper_junos_show_arp_no-resolve.textfsm 模板来解析命令输出。Junos PyEZ 视图将数据映射到新的变量名称，并仅返回字段的子集。要查看模板，请参阅 了解 TextFSM 模板。

要在 Junos PyEZ 表中使用 TextFSM 模板和视图：

1. 创建自定义 Junos PyEZ 表，其中包括 command、 key、 platformuse_textfsm、 和view参数，以及操作所需的任何其他参数。

2. 创建 Junos PyEZ 视图，定义要返回的模板字段以及每个字段的相应变量名称。

   在这种情况下，视图不会映射 FLAGS TextFSM 模板中定义的字段，并且解析的数据不包含此值。

3. 创建使用表检索数据的 Junos PyEZ 应用程序。

4. 执行应用程序。

   该表使用 NTC 模板和 Junos PyEZ 视图来提取输出字段。对于每个表项，应用程序将返回“视图”中定义的字段的定义键和数据。

如何使用自定义 TextFSM 模板

Junos PyEZ 表可以使用作为软件包的一部分 ntc-templates 安装的 TextFSM 模板。它们还可以引用自定义 TextFSM 模板。要在 Junos PyEZ 应用程序中使用自定义 TextFSM 模板，必须先暂存模板。然后，当您在应用程序中定义 Table 实例时，指定模板目录的绝对路径。

要在 Junos PyEZ 表中使用自定义 TextFSM 模板，请执行以下操作：

1. 为您的自定义模板创建目录。

2. 在 templates 目录中，创建模板并使用 .textfsm 文件名约定命名platform_command文件。

3. 创建一个 Junos PyEZ 表，其定义与模板文件名相同的 platform 和 command 值。

4. 在 Junos PyEZ 应用程序中，定义 Table 实例时，指定自定义模板目录的绝对路径。

5. 执行应用程序。

如何使用带有 TextFSM 模板的 Junos PyEZ 表来解析任何供应商的命令输出

Junos PyEZ 表可以使用 TextFSM 模板来解析来自任何供应商网络设备的命令输出。Python 应用程序可以从设备检索输出，也可以从文件读取输出。然后，在创建 Junos PyEZ 表实例时，可以将命令输出字符串传递给表的 raw 参数，而不是传入 Device 实例。

例如，请考虑以下 TextFSM 模板：

该模板将 show alarms detail 解析来自给定设备的命令输出。

以下示例定义了一个Junos PyEZ 表，该表使用自定义 TextFSM 模板 cisco_xr_show_alarms_detail.textfsm 和 View 来解析 show alarms detail 命令输出。该示例使用库直接 netmiko 从设备检索数据。当应用程序创建 Table 实例时， raw 参数将传入命令输出，并且参数 template_dir 定义包含自定义模板的目录的路径。

当您执行应用程序时，它会从设备检索命令输出。然后，应用程序使用指定目录中的 TextFSM 模板以及 View 来解析输出。Junos PyEZ 仅返回 TextFSM 模板和 Junos PyEZ 视图通用的字段。应用程序会将命令输出保存到文件中，以便您稍后可以处理输出，如下一个示例所示。

以下示例使用与上一个示例相同的 TextFSM 模板和 Junos PyEZ 视图，但在这种情况下，应用程序会从文件中读取命令输出。