[toc]

Jinja2

用jinja2来生成规范的配置模板.

试验环境阐明：

python版本：3.6.9
jinja2版本：2.11.2
python IDE：pycharm

装置

python -m pip install Jinja2

根本语法

定义变量
格局阐明：左右双花括号
```
logging host {{ log_server }}
```

if条件管制
格局阐明：花括号和百分号组合，if开始，endif完结。

{# 伪代码 #}{% if vendor == 'cisco' %}    logging host {{ log_server }}{%elif vendor == 'huawei' %}    info-center loghost {{ log_server }}{%else %}    pass{% endif %}

for循环
格局阐明：花括号和百分号组合，for开始，endfor完结。

{# 伪代码 #}{% for log_server in server %}    {% if vendor == 'cisco' %}        logging host {{ log_server }}    {%elif vendor == 'huawei' %}        info-center loghost {{ log_server }}    {%else %}        pass    {% endif %}{% endfor %}

还能够联合range()函数

{%- for i in range(1, 11) -%}    序号 {{ i }}{% endfor%}

空白符
格局阐明：在百分号的后面或前面加-，上面举例看清楚咯，能够去除前后的空白块。
```
{# 去掉右边空白符 #}{%- for server in servers %}{# 去掉左边边空白符 #}{% for server in servers -%}
```

示例1：简略的栗子

from  jinja2 import Templatetpl = Template(source="欢送关注-{{name}}-公众号.")print(tpl.render(name="点滴技术"))# 运行后果如下所示：欢送关注-点滴技术-公众号.

阐明：Template是一个类，将字符串作为参数传给source，source不写也行，而后通过render()渲染，render能够把参数传到template变量中去。

示例2：调用模板文件

创立新的文件夹，在文件夹里新建文件first.conf.tpl：
文件门路："templates\first.conf.tpl"
```
This first Jinja2 template!
```

创立python文件render_template.py

# 导入两个类from jinja2 import FileSystemLoader, Environment# 加载模板文件夹loader = FileSystemLoader(searchpath='templates')# 环境对象enviroment = Environment(loader=loader)# 指定模板文件tpl = enviroment.get_template('first.conf.tpl')# 渲染模板output = tpl.render()print(output)

阐明：FileSystemLoader能够反对传入列表，反对多个文件夹。

执行python 脚本:

(py376) [root@localhost Jinja2_t]# python render_template.py This first Jinja2 template!

示例3：传变量渲染

在templates目录下新建模板文件vars.conf.tpl
```
logging host {{ data.ip }}
```

新建python文件vars.py

from jinja2 import FileSystemLoader, Environmentloader = FileSystemLoader('templates')environment = Environment(loader=loader)tpl = environment.get_template('vars.conf.tpl')data = {'ip': '1.1.1.1'}output = tpl.render(data=data)print(output)

执行后果如下：

(py376) [root@localhost Jinja2_t]# python vars.py logging host 1.1.1.1

示例4：渲染的模板写入文件

在templates目录下新建模板文件vars.conf.tpl
```
logging host {{ data.ip }}
```

新建python文件save_to_file.py

from jinja2 import FileSystemLoader, Environmentloader = FileSystemLoader('templates')env = Environment(loader=loader)tpl = env.get_template('vars.conf.tpl')data = {'ip': '1.1.1.1'}# print(tpl.render(data=data))# 办法1: render()with open('cisco_logging.conf', 'w') as f:    f.write(tpl.render(data=data))# 办法2:stream()# tpl.stream(data=data).dump('cicso_logging.conf')

阐明：stream()返回的是一个模板流对象，通过dump()办法建流写入文件中。

执行脚本，后果如下：

(py376) [root@localhost Jinja2_t]# python save_to_file.py (py376) [root@localhost Jinja2_t]# more cisco_logging.conflogging host 1.1.1.1

示例5：生成ACL配置模板

在templates目录下新建模板文件acl.conf.tpl

{% for host in disallowed -%}    access-list 20 deny host {{ host }}{% endfor -%}{% for host in allowed -%}    access-list 20 permit host {{ host }}{% endfor -%}line vty 0 4    access-class 20 in

新建python文件jinja_loops.py

from jinja2 import FileSystemLoader, Environmentallowed = ['192.168.1.1',           '192.168.1.2',           '192.168.1.3']disallowed = ['192.168.2.1',           '192.168.2.2',           '192.168.2.3']loader = FileSystemLoader('templates')env = Environment(loader=loader,trim_blocks=True)tpl = env.get_template('acl.conf.tpl')output = tpl.render(allowed=allowed, disallowed=disallowed)print(output)

阐明：trim_blocks=True，能够把新行的空白块删除，默认为False，也能够联合在jinja2模板减少-删除多余空白块。

执行脚本，后果如下:

(py376) [root@localhost Jinja2_t]# python jinja_loops.py access-list 20 deny host 192.168.2.1access-list 20 deny host 192.168.2.2access-list 20 deny host 192.168.2.3access-list 20 permit host 192.168.1.1access-list 20 permit host 192.168.1.2access-list 20 permit host 192.168.1.3line vty 0 4    access-class 20 in

示例6：生成接口配置模板

在templates目录下新建模板文件ports.conf.tpl

{% for port in ports -%}interface {{ port['type'] }} {{ port['slot'] }}/{{ port['port_num'] }}{%- if port['intf_type'] == "access" %}    switchport mode {{ port['intf_type'] }}    switchport access vlan {{ port['vlan'] }}{%- endif %}{%- if port['intf_type'] == "trunk" %}    switchport mode {{ port['intf_type'] }}    switchport trunk allowed vlan add {{ port['vlan'] }}{%- endif %}{% endfor -%}

阐明：在jinja2这里，字典取值形式port['type']和port.type都能够应用，成果是一样的.

新建python文件jinja_loops.py

from jinja2 import FileSystemLoader, Environmentports = [{        "type": "ethernet",        "slot": 1,        "port_num": 1,        "intf_type": "access",        'vlan': 10        }, {        "type": "ethernet",        "slot": 1,        "port_num": 2,        "intf_type": "trunk",        'vlan': 20        }]loader = FileSystemLoader('templates')env = Environment(loader=loader)tpl = env.get_template('ports.conf.tpl')output = tpl.render(ports=ports)print(output)

执行脚本，后果如下:

(py376) [root@localhost Jinja2_t]# python jinja_if.py interface ethernet 1/1    switchport mode access    switchport access vlan 10interface ethernet 1/2    switchport mode trunk    switchport trunk allowed vlan add 20

示例7：模块化模板

在templates目录下新建主模板文件modular.conf.tpl
```
{% for port in ports -%}{% with port=port -%}{% include "port_conf.sub.conf.tpl" %}{% endwith -%}{% endfor -%}
```
阐明：with在这里其实是从新命令变量而已。

在templates目录下新建子模板文件port_conf.sub.conf.tpl

interface {{ port['type'] }} {{ port['slot'] }}/{{ port['port_num'] }}{%- if port['intf_type'] == "access" %}    switchport mode {{ port['intf_type'] }}    switchport access vlan {{ port['vlan'] }}{%- endif %}{%- if port['intf_type'] == "trunk" %}    switchport mode {{ port['intf_type'] }}    switchport trunk allowed vlan add {{ port['vlan'] }}{%- endif %}

新建python文件jinja_modular.py

from jinja2 import FileSystemLoader, Environmentports = [{        "type": "ethernet",        "slot": 1,        "port_num": 1,        "intf_type": "access",        'vlan': 10        }, {        "type": "ethernet",        "slot": 1,        "port_num": 2,        "intf_type": "trunk",        'vlan': 20        }]loader = FileSystemLoader('templates')env = Environment(loader=loader)tpl = env.get_template('modular.conf.tpl')output = tpl.render(ports=ports)print(output)

执行脚本，后果如下所示:

(py376) [root@localhost Jinja2_t]# python jinja_modular.py interface ethernet 1/1    switchport mode access    switchport access vlan 10interface ethernet 1/2    switchport mode trunk    switchport trunk allowed vlan add 20

示例8：过滤器

在templates目录下新建主模板文件filter.conf.tpl
```
{{ vendor_list|vendor_filter() }}
```

新建python文件jinja_filter.py

from jinja2 import FileSystemLoader, Environment# 自定义一个函数def vendor_filter(vendor):    new_vendor = vendor[0:3] + ['...']    return new_vendorvendor_list = ['cisco', 'huawei', 'h3c', 'ruijie', 'fortinet', 'sangfor']loader = FileSystemLoader('templates')environment = Environment(loader=loader)environment.filters["vendor_filter"] = vendor_filtertpl = environment.get_template("filter.conf.tpl")output = tpl.render(vendor_list=vendor_list)print(output)

执行脚本，后果如下所示:

(py376) [root@localhost Jinja2_t]# python jinja_filter.py ['cisco', 'huawei', 'h3c', '...']

示例9：模板继承

在templates目录下新建主模板文件base.conf.tpl
```
# 这个头部{% block head -%}欢送来到母版的世界.{% endblock -%}hostname {% block hostname_suffix %}default{%endblock %}# 这个是尾部
```
阐明：块的语法，起始block，完结用endblock，标识这段是一个块, block的命名须要惟一.
在templates目录下新建子模板文件child.conf.tpl
```
{% extends 'base.conf.tpl' %}{% block head -%}{{ super() }}我来自子模版的世界.{% endblock -%}{% block hostname_suffix %} router-01 {% endblock %}
```
通过extends办法继承模板(也叫根底模板)
super()办法能够继承母版上的配置，而后本人能够减少配置(说白了就是在母版基本上追加配置).
block的益处就是能够继承或者重写内容。

新建python文件jinja_base.py

from jinja2 import FileSystemLoader, Environmentloader = FileSystemLoader('templates', encoding="gbk")environment = Environment(loader=loader)tpl = environment.get_template("child.conf.tpl")output = tpl.render()print(output)

执行脚本，后果如下所示:

(py376) [root@localhost Jinja2_t]# python jinja_base.py # 这个头部欢送来到母版的世界.我来自子模版的世界.hostname  router-01 # 这个是尾部

好了，大家学到这里，应该对jinja2有更深的理解了，通过netmiko联合jinja2能够完满实现标准配置生成与下发了。

最初来一个，点赞、珍藏、三连击......

如果喜爱的我的文章，欢送关注我的公众号：点滴技术，扫码关注，不定期分享