模板系统¶

NetPulse 通过其插件系统提供可拓展的模板功能。模板系统具备两大功能：命令输出解析和配置渲染。模板系统还支持从本地文件、HTTP(S)、FTP 等多种来源加载模板。

核心功能¶

模板系统的核心功能是将命令输出解析为结构化数据，或将结构化数据渲染为设备配置。

解析模式将命令输出转换为结构化数据，一般在设备命令执行后使用。

graph LR
    A[Command Output] --> B[Template Parser]
    B --> C[Structured Data]
    D[Template Source] -.-> B

渲染模式从模板生成设备配置，一般在推送配置前使用。

graph LR
    A[Context Data] --> B[Template Renderer]
    B --> C[Device Config]
    D[Template Source] -.-> B

模板 API¶

模板系统既提供独立的 API 接口，也可以和设备操作相关 API 集成使用。

Tip

详细的 API 使用文档请参考 Postman 文档。

独立模板接口¶

渲染模板¶

POST /template/render/{name} HTTP/1.1

请求体：

{
  "name": "jinja2",
  "template": "interface {{ interface }}\n description {{ description }}",
  "context": {
    "interface": "GigabitEthernet1/0/1",
    "description": "Core Link"
  }
}

响应：

{
  "code": 0,
  "message": "success",
  "data": "interface GigabitEthernet1/0/1\n description Core Link"
}

解析输出¶

POST /template/parse/{name} HTTP/1.1

请求体：

{
  "name": "textfsm",
  "template": "Value INTERFACE (\\S+)\nValue IP ([\\d\\.]+)\n\nStart\n  ^${INTERFACE}\\s+${IP} -> Record",
  "context": "GigabitEthernet1/0/1    192.168.1.1"
}

响应：

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "INTERFACE": "GigabitEthernet1/0/1",
      "IP": "192.168.1.1"
    }
  ]
}

设备操作集成接口¶

拉取后解析¶

{
  "driver": "netmiko",
  "connection_args": {
    "device_type": "cisco_ios",
    "host": "192.168.1.1",
    "username": "admin",
    "password": "pwd123"
  },
  "command": "show ip interface brief",
  "parsing": {
    "name": "textfsm",
    "template": "file:///templates/show_ip_int_brief.textfsm"
  }
}

推送前渲染¶

{
  "driver": "netmiko",
  "connection_args": {
    "device_type": "cisco_ios",
    "host": "192.168.1.1",
    "username": "admin",
    "password": "pwd123"
  },
  "config": {
    "interfaces": [
      {"name": "Gi1/0/1", "description": "Server Port"},
      {"name": "Gi1/0/2", "description": "Uplink Port"}
    ]
  },
  "rendering": {
    "name": "jinja2",
    "template": "file:///templates/interfaces.j2"
  }
}

模板源¶

模板可以使用 URI 格式从各种源加载：

纯文本：直接模板内容（默认）

{
  "template": "interface {{ interface }}\n description {{ description }}"
}

文件系统：本地文件路径

{
  "template": "file:///templates/interfaces.j2"
}

HTTP(S)：远程模板

{
  "template": "https://templates.example.com/acl.j2"
}

FTP：FTP 服务器上的模板

{
  "template": "ftp://ftp.example.com/templates/interfaces.j2"
}

Note

在容器中部署时，本地文件路径必须是容器内可读取的路径。

模板源优先级

系统按以下顺序识别模板源类型： 1. HTTP/HTTPS（以 http:// 或 https:// 开头） 2. FTP（以 ftp:// 开头） 3. 文件系统（以 file:// 开头） 4. 纯文本（默认，直接使用模板内容）

开发者可以修改模板源的 URI 解析器，以支持更多的源类型。

模板引擎¶

Tip

具体的模板语法和引擎实现，请参考相关项目的文档。

Jinja2¶

用于渲染模板，生成网络设备配置。

{
  "name": "jinja2",
  "template": "file:///templates/interface.j2",
  "context": {
    "interface": "GigabitEthernet1/0/1",
    "description": "Access Port"
  },
  "args": {
    "trim_blocks": true,
    "lstrip_blocks": true,
    "variable_start_string": "{{",
    "variable_end_string": "}}"
  }
}

TextFSM¶

用于解析命令输出，支持使用 ntc_template 中的内置模板。

{
  "name": "textfsm",
  "template": "file:///templates/show_ip_int_brief.textfsm",
  "context": "GigabitEthernet1/0/1    172.16.1.1    YES manual up    up"
}

TTP¶

模板文本解析器，支持使用 ttp_template 中的内置模板。

{
  "name": "ttp",
  "use_ttp_template": true,
  "ttp_template_args": {
    "platform": "cisco_ios",
    "command": "show ip interface brief"
  },
  "context": "GigabitEthernet1/0/1    172.16.1.1    YES manual up    up"
}

设计思考¶

为什么需要模板系统？¶

问题：网络设备的配置和输出格式多样，如何统一处理？

答案：通过模板系统实现： 1. 配置生成：使用 Jinja2 将结构化数据渲染为设备配置 2. 输出解析：使用 TextFSM/TTP 将命令输出解析为结构化数据

这样可以将不同厂商、不同格式的设备操作统一为结构化的数据处理流程。

模板源的设计¶

支持多种模板源（文件、HTTP、FTP）的原因： - 灵活性：模板可以集中管理，也可以分散存储 - 版本控制：通过 HTTP 源可以实现模板的版本管理 - 动态更新：无需重启服务即可更新模板

模板引擎的选择¶

Jinja2：成熟的模板引擎，适合配置生成
TextFSM：专门用于解析网络设备输出，社区模板丰富
TTP：更灵活的解析引擎，支持复杂的数据提取

选择多种引擎是为了满足不同场景的需求，用户可以根据具体情况选择合适的引擎。