Ansible学习笔记——JINJA2模板的语法及使用（template模块）

最新推荐文章于 2025-04-01 20:01:00 发布
最新推荐文章于 2025-04-01 20:01:00 发布
阅读量7.4k 收藏 14
点赞数 1
分类专栏： Linux 文章标签： 运维
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_37387363/article/details/115207964
版权

JINJA2模板的语法及使用

JINJA2模板的语法

个人理解非常像shell脚本或者开发语言，例如一些逻辑运算等。
如果有开发基础，更易懂吧。比如我哈哈哈哈哈

1、变量

  • 可以在j2模板中引入facts变量，直接使用。
This is the system {{ ansible_facts['fqdn'] }}.
This is a {{ ansible_facts['distribution'] }} version {{ ansible_facts['distribution_version'] }} system.
Only use this system with permission.
  • 也可以直接引用playbook中的变量
  • 也可以在j2模板中定义变量——此时的优先级高于playbook中的优先级。

例如，在j2模板中定义了username变量：

{% set username = 'zhang' %}
The username id {{ username }}

在yml文件中也定义了变量

  vars:
    - username: wangxc

执行后，文件中的结果为：

The username id zhang

此时可以证明，j2模板中的变量优先级是更高的。
当移除掉j2模板中的变量定义时，将会引用yml文件中的变量。

The username id wangxc

2、逻辑控制——ifelse

{% if 条件表达式 %}
……
{% endif %}

{% if 条件表达式 %}
……
{% elif 条件表达式 %}
……
{% else %}
……
{% endif %}

jinja2的支持使用for循环、ifelse判断控制。逻辑控制语句，需要写在{% ………………%} 中

{# {% if filter01 is defined %} #}
{% if myhosts is defined %}
variable is defined
{% else %}
variable is undefined
{% endif %}

在yml文件中定义变量矩阵

  vars:
    myhosts:
      - servera
      - serverb

输出的结果：

variable is defined

3、逻辑控制——for循环

jinja2的支持使用for循环、ifelse判断控制

{% for myhost in groups['myhosts'] %}
my host is {{ myhost }}
{% endfor %}

在yml文件中定义变量矩阵

  vars:
    myhosts:
      - servera
      - serverb

运行结果：

my host is servera
my host is serverb

4、算术运算符

用的很少

+：把两个对象加到一起。如：{{ 1 + 1 }} 等于 2。但是如果两者是字符串或列表，你可以用这种方式来衔接它们【连接字符串推荐使用 ~ 运算符】。

-：用第一个数减去第二个数。如：{{ 3 - 2 }} 等于 1 。

/：对两个数做除法。返回值会是一个浮点数。如：{{ 1 / 2 }} 等于 {{ 0.5 }} 。

//：对两个数做除法，返回整数商。如：{{ 20 // 7 }} 等于 2 。

%：计算整数除法的余数。如：{{ 11 % 7 }} 等于 4 。

*：用右边的数乘左边的操作数。如：{{ 2 * 2 }} 会返回 4。也可以用于重复一个字符串多次。如：{{ '=' * 80 }} 会打印 80 个等号的横条。

**：取左操作数的右操作数次幂。如：{{ 2 ** 3 }} 会返回 8。

5、逻辑运算

==：比较两个对象是否相等。

!=：比较两个对象是否不等。

>：如果左边大于右边，返回 true。

>=：如果左边大于等于右边，返回 true。

<：如果左边小于右边，返回 true。

<=：如果左边小于等于右边，返回 true。

对于逻辑判断，在 for 过滤或 if 表达式中，它可以用于联合多个表达式：

and：如果左操作数和右操作数同为真，返回 true。

or：如果左操作数或右操作数有一个为真，返回 true。

not：对一个表达式取反（见下）。

(expr)：表达式组。

提示：is 和 in 运算符同样支持使用中缀记法：foo is not bar 和 foo not in bar。所有的其它表达式需要前缀记法：not (foo and bar) 。

in：运行序列/映射包含检查。如果左操作数 包含于 右操作数，返回 true 。比如 {{ 1 in [1,2,3] }} 会返回 true。

is：运行一个 测验。参见上述

|：应用一个 过滤器。参见上述

~：把所有的操作数转换为字符串，并且连接它们。 {{ "Hello " ~ name ~ "!" }} 会返回（假设 name 值为 'John' ） Hello John!。

6、过滤器

官方的解释是这样的：
在这里插入图片描述
我觉得这一部分有点抽象，但看起来似乎又像是提供了一些比较方便的工具类（它叫做过滤器），可以帮助我们快速实现一些功能。就比如Java中的String类的自带方法，trim、toUpperCase、length等
以下是从网络上找到的一个例子，可以参考看看：

{# 变量定义 #}
{% set filter01 = -24.5 %}
{% set filter02 = 'abcDEGg' %}
{% set filter03 = "  abCDef G hkIL   " %}
{% set filter04 = ['physics', 'chemistry', 1997, 2000] %}

# 过滤器 使用
## 取绝对值
{{ filter01|abs() }} 或者 {{ filter01|abs }}
## 首字符大写，其他小写
{{ filter02|capitalize() }} 或者 {{ filter02|capitalize }}
## 去掉两端空格
|{{ filter03|trim() }}| 或者 |{{ filter03|trim }}|
## 返回序列的第一个
{{ filter04|first() }} 或者 {{ filter04|first }}
## 将序列变为字符串，可以指定每个元素间加入什么字符，默认空
默认情况: {{ filter04|join() }} 或者 {{ filter04|join }}
加入字符: {{ filter04|join('|') }}

# Tests 测验 使用
## 变量是否定义
未定义: {{ filter00 is defined }}
已定义: {{ filter01 is defined }}
## 变量是否是数字
{{ filter01 is number }} === {{ filter02 is number }}
## 变量是否是小写
{{ filter02 is lower }}
## 变量是否是字符串
{{ filter02 is string }}

## 变量在 if 中的判断是否已定义
{# ***** 变量已经被定义，直接判断表达式是 True或False ***** #}
{# {% if filter01 %} #}{# 如果变量没有定义，那么执行会报错 #}
{# 由于 filter00 之前未定义，因此这里定义为 false，不然执行会报错【生产中会在 playbook中定义】
{% set filter00 = false %}
{% if filter00 %}
#}
{# ***** 通过判断变量是否被定义，得到到True或False ***** #}
{# {% if filter01 is defined %} #}
{% if filter00 is defined %}
variable is defined
{% else %}
variable is undefined
{% endif %}

# range 使用
{% for i in range(1,20) %}
  server 172.16.1.{{ i }}:80
{% endfor %}

运行的结果

# 过滤器 使用
## 取绝对值
24.5 或者 24.5
## 首字符大写，其他小写
Abcdegg 或者 Abcdegg
## 去掉两端空格
|abCDef G hkIL| 或者 |abCDef G hkIL|
## 返回序列的第一个
physics 或者 physics
## 将序列变为字符串，可以指定每个元素间加入什么字符，默认空
默认情况: physicschemistry19972000 或者 physicschemistry19972000
加入字符: physics|chemistry|1997|2000

# Tests 测验 使用
## 变量是否定义
未定义: False
已定义: True
## 变量是否是数字
True === False
## 变量是否是小写
False
## 变量是否是字符串
True

## 变量在 if 中的判断是否已定义
variable is undefined

# range 使用
  server 172.16.1.1:80
  server 172.16.1.2:80
  server 172.16.1.3:80
  server 172.16.1.4:80
  server 172.16.1.5:80
  server 172.16.1.6:80
  server 172.16.1.7:80
  server 172.16.1.8:80
  server 172.16.1.9:80
  server 172.16.1.10:80
  server 172.16.1.11:80
  server 172.16.1.12:80
  server 172.16.1.13:80
  server 172.16.1.14:80
  server 172.16.1.15:80
  server 172.16.1.16:80
  server 172.16.1.17:80
  server 172.16.1.18:80
  server 172.16.1.19:80

JINJA2模板的引入

需要通过template模块，引入对应的j2模板。
j2模板没有要求必须以 .j2结尾，但为了提升可读性，建议这样做。

---
- name:
  hosts: servera
  tasks:
    - name: jinja2 test
      template:
        src: jinja2.j2
        dest: /home/student/j2_res

本文部分示例引用自：https://blog.youkuaiyun.com/woshizhangliang999/article/details/105849051

JINJA2模板综合实验

实验环境

[student@workstation file-review]$ pwd
/home/student/file-review
[student@workstation file-review]$ cat ansible.cfg 
[defaults]
inventory = inventory
ansible_managed = Ansible managed: modified on %Y-%m-%d %H:%M:%S
[student@workstation file-review]$ cat inventory 
[servers]
serverb.lab.example.com
[student@workstation file-review]$ cat files/issue 
*------------------------------- PRIVATE SYSTEM -----------------------------*
 -   Access to this computer system is restricted to authorised users only.   *
 -                                                                            *
 -      Customer information is confidential and must not be disclosed.       *
*----------------------------------------------------------------------------*

实验要求

  • 识别serverb上的facts变量，显示系统内存总量及处理器数目
  • 创建一个j2模板，当devops用户登录时，显示出内存总量和处理器数目
  • 创建playbook，使用devops用户并提权
  • 使用template配置J2模板，并映射到目标主机的/etc/motd。设置所属组、所有者为root，权限为0644
  • 使用stat和debug验证并显示/etc/motd的文件信息
  • 使用copy将files/issue的文件放到被管理主机的/etc/目录下，并配置与源文件相同的权限
  • 使用file模块保证/etc/issue.net是/etc/issue的链接

示例文件

[student@workstation file-review]$ cat motd.j2 
system total memory: {{ ansible_facts['memtotal_mb'] }} MiB
system processor count: {{ ansible_facts['processor_count'] }}

[student@workstation file-review]$ cat motd.yml 
---
- name:
  hosts: all
  remote_user: devops
  become: true
  tasks:
    - name: 
      template:
        src: motd.j2
        dest: /etc/motd
        owner: root
        group: root
        mode: 0644
    - name:
      stat:
        path: /etc/motd
      register: stat_res
    - name:
      debug:
        msg: "{{ stat_res }}"
    - name:
      copy:
        src: files/issue
        dest: /etc/
        owner: root
        group: root
        mode: 0644
    - name:
      file:
        src: /etc/issue
        dest: /etc/issue.net
        state: link
        owner: root
        group: root
        force: yes

运行结果

[student@workstation file-review]$ ansible-playbook motd.yml 

PLAY [all] ***************************************************************************************************************************

TASK [Gathering Facts] ***************************************************************************************************************
ok: [serverb.lab.example.com]

TASK [template] **********************************************************************************************************************
changed: [serverb.lab.example.com]

TASK [stat] **************************************************************************************************************************
ok: [serverb.lab.example.com]

TASK [debug] *************************************************************************************************************************
ok: [serverb.lab.example.com] => {
    "msg": {
        "changed": false,
        "failed": false,
        "stat": {
            "atime": 1616666801.3760493,
            "attr_flags": "",
            "attributes": [],
            "block_size": 4096,
            "blocks": 8,
            "charset": "us-ascii",
            "checksum": "860519cbc178f27e2a63bcdd38510709cf65710c",
            "ctime": 1616666801.3780494,
            "dev": 64513,
            "device_type": 0,
            "executable": false,
            "exists": true,
            "gid": 0,
            "gr_name": "root",
            "inode": 8758505,
            "isblk": false,
            "ischr": false,
            "isdir": false,
            "isfifo": false,
            "isgid": false,
            "islnk": false,
            "isreg": true,
            "issock": false,
            "isuid": false,
            "mimetype": "text/plain",
            "mode": "0644",
            "mtime": 1616666800.7440493,
            "nlink": 1,
            "path": "/etc/motd",
            "pw_name": "root",
            "readable": true,
            "rgrp": true,
            "roth": true,
            "rusr": true,
            "size": 55,
            "uid": 0,
            "version": "2324674415",
            "wgrp": false,
            "woth": false,
            "writeable": true,
            "wusr": true,
            "xgrp": false,
            "xoth": false,
            "xusr": false
        }
    }
}

TASK [copy] **************************************************************************************************************************
changed: [serverb.lab.example.com]

TASK [file] **************************************************************************************************************************
changed: [serverb.lab.example.com]

PLAY RECAP ***************************************************************************************************************************
serverb.lab.example.com    : ok=6    changed=3    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

验证

注意：默认sshd是无法展示issue中的内容。以下结果是ansible的lab命令在初始化实验环境时，已经配置过sshd服务的。
如果想要展示，需要手动修改serverb中的 /etc/ssh/sshd_config文件，添加下面这一行：

Banner /etc/issue.net

这一行指定了banner的文件路径。默认情况下是：

# no default banner path
#Banner none

以下是ansible的执行结果：

[student@workstation file-review]$ ssh devops@serverb
*------------------------------- PRIVATE SYSTEM -----------------------------*
*   Access to this computer system is restricted to authorised users only.   *
*                                                                            *
*      Customer information is confidential and must not be disclosed.       *
*----------------------------------------------------------------------------*
system total memory: 821 MiB
system processor count: 1
Activate the web console with: systemctl enable --now cockpit.socket

Last login: Thu Mar 25 18:53:58 2021 from 172.25.250.9

大功告成！

03 Flask之Jinja2模版
嘎嘎_哈
08-21 463
1，Jinja2模版介绍和查找路径 模板是一个 web 开发必备的模块。 因为我们在渲染一个网页的时候，并不是只渲染一个纯文本字符串，而是需要渲染一个有富文本标签的页面。 这时候我们就需要使用模板了。在 Flask 中，配套的模板是 Jinja2 查找路径： 1. 在渲染模版的时候，默认会从项目根目录下的`templates`目录下查找模版。 2. 如果不想把模版文件放在`templates...
ansible 自动化运维工具 学习笔记四 （Ansible中的变量及加密 playbook JINJA2模板)
Puuwuuchao的博客
08-24 350
Ansible中的变量及加密playbook变量命名playbook变量级别playbook变量设定和使用方式在playbook中直接定义变量在文件中定义变量使用变量设定主机变量和清单变量目录设定变量用命令覆盖变量使用数组设定变量注册变量事实变量魔法变量Ansible的加密控制创建建立文件加密现有文件查看加密文件编辑加密文件解密文件更改密码如何使用加密后的playbookJINJA2模板介绍j2模板书写规则 playbook变量命名 规则： 只能包含数字，下划线，字母 只能用下划线或字母开头 如果不符合
Jinja2 模板用法
tushanpeipei的博客
05-16 1857
1.语法 在jinja2中，存在三种语法： 控制结构 {% %} 变量取值 {{ }} jinja2模板中使用 {{ }} 语法表示一个变量，它是一种特殊的占位符。当利用jinja2进行渲染的时候，它会把这些特殊的占位符进行填充/替换，jinja2支持python中所有的Python数据类型比如列表、字段、对象等。 注释 {# #} 2.过滤器 变量可以通过“过滤器”进行修改，过滤器可以理解为是jinja2里面的内置函数和字符串处理函数。 常用的过滤器有： safe: 渲染时值不转义 cap
探索 Jinja2：Python 的强大模板引擎
最新发布
qq_22941289的博客
04-01 298
Jinja2是一个Python库，它提供了简洁、灵活和快速的模板引擎。它基于Django模板语言，并在其基础上增加了一些额外的功能，例如更强大的过滤器、全局变量和更简单的模板继承。它的设计理念就是要让大家用起来简单又顺手，同时还能提供足够的灵活性，不管你有什么样的需求，它都能尽量满足。
jinja2模板
qq_42385761的博客
11-27 2002
jinja2模板 ​ 视图函数的主要作用是，处理业务逻辑，返回响应内容 ​ flask是使用jinja2这个模板引擎来渲染模板 使用模板的好处 视图函数只负责业务逻辑和数据处理 模板取到视图函数的数据结果进行展示 代码结构清晰，耦合度低 1、jinja2模板介绍 模板传参 再使用render_template渲染模板的时候，可以传递关键字参数，以后直接在模板中使用即可 如果参数过多，可以将所有的参数放到一个字典或列表中。将字典打散成关键字参数可以在参数前面加** from flask impor
Jinjia2Template
鱼的记忆
10-04 745
{{xx}} {% if xx %} {% endif %} 继承 {% extends “Base.html”%} 过滤器 {{ xxx | default “oof”}} 作用于变量 处理变量后再展示 过滤器有很多种 可以去官网查 {% block main %} {% endblock %} 父模板可以在不同的位置 如titile head body等位置定
Python（Web时代）——jinja2模板
qq_25702235的博客
08-08 4313
Jinja2是Flask框架默认支持的模板引擎，是python的web项目中被广泛应用的一种模板引擎，jinja2的作者与Flask是同一个人。有些时候需要对要在模板中的变量值做一些特殊处理，比如首字母大写，去掉前后空格、字符串拼接等等，这时就可以使用过滤器。当遇到现有的过滤无法满足我们的需求时，这时就需要我们自定义一个过滤器了。通过 | 来使用过滤器，与Linux中的管道类似。非常灵活，提供了控制结构、表达式与继承等。控制结构（逻辑代码） {% %}变量取值 {{ }}
Ansible使用jinja2管理配置文件以及jinja2语法简介
weixin_33984032的博客
06-13 581
一、Jinja2介绍Jinja2是基于python的模板引擎，功能比较类似于PHP的smarty，J2ee的Freemarker和velocity。它能完全支持unicode，并具有集成的沙箱执行环境，应用广泛。jinja2使用BSD授权Jinja2的语法是由variables(变量)和statement(语句)组成，如下；1、variables：可以输出数据` my_var...
自动化运维工具ansible学习笔记
08-29
Ansible基于Pythonparamiko开发，分布式，无需客户端，轻量级，配置语法使用YMAL及Jinja2模板语言，更强的远程命令执行操作。 Ansible的工作机制是将Ansible模块通过SSH协议（或者Kerberos、LDAP）推送到被管理端...
Ansible详细学习笔记和实战案例
weixin_41335923的博客
11-22 1358
Ansible详细学习笔记和实战案例（容易忘记的内容） 一、主机清单 ansible localhost -m command -a "ls" ## 主机列表文件 cat /etc/ansible/hosts 主机描述形式： 主机IP地址和主机名 ## blue.example.com ## 192.168.100.1 散列主机列表和主机组列表 散列主机列表 主机组列表 嵌套主机组列表 ## blue.example
ansible学习笔记 自动化部署k8s集群
mrdjrfy的博客
07-13 565
Ansible介绍 Ansible是一种IT自动化工具。它可以配置系统，部署软件以及协调更高级的IT任务，例如持续部署，滚动更新。Ansible适用于管理企业IT基础设施，从具有少数主机的小规模到数千个实例的企业环境。Ansible也是一种简单的自动化语言，可以完美地描述IT应用程序基础结构。 具备以下三个特点： 简单：减少学习成本 强大：协调应用程序生命周期 无代理：可预测，可靠和安全 使用文档： https://docs.ansible.com/ 安装Ansible.
ansible学习笔记
扑火的小飞蛾
08-18 939
引入变量，可以方便Playbook重用。比如装包的playbook，包名使用变量。多次执行playbook，只要改变变量名即可，不用编写新的playbook。ansible支持10种以上的变量定义方式。常用的变量来源如下：inventory变量。变量来自于主机清单文件facts变量。playbook变量。变量在playbook中定义。变量文件。专门创建用于保存变量的文件。推荐变量写入单独的文件。# 使用inventory变量。
Python Jinja2：强大易用的模板引擎
weixin_68789096的博客
10-20 4561
总之，Jinja2是一个功能强大、易于使用和扩展的Python模板引擎，适用于各种需要模板引擎的应用场景。掌握它的基本功能能够提高我们的开发效率和代码可维护性，使我们能够更专注于实现应用程序的功能和需求。本文转自，如有侵权，请联系删除。
[学习记录]jinja2模板语法
diejingpo2316的博客
06-18 274
先放上官方文档 jinja的模板可以与flask结合，部分模板中的内容交给变量填充，同时让html看上去更加可编程，将这些内容最直接放置在一个正常的html文件即可 以下简单介绍下jinja的模板语法 1.变量 和vue比较像，用{{}}引起来，变量允许通过 . 和下标来访问变量的属性和偏移 2.注释 {# #} 3.空格管理 模板中空格会...
fastAPI教程：jinja2模板
weixin_50556117的博客
09-30 1996
jinja是python知名web框架Flask的作者开发的⼀个开源的模板系统，起初是仿django模板的⼀个模板引擎DjangoTPL，为Flask提供模板支持，由于其灵活，快速和安全等优点被⼴泛使用。jinja2是jinja2这个模块的2.0版本。所谓的模板在Python的web开发中广泛使用，它能够有效的将业务逻辑（负责处理数据的代码）和表现逻辑（负责展示给客户端查看数据的代码，例如：print, html/css/js）分开，使代码可读性增强、并且更加容易理解和维护。
jinja2模板用法详解
HMMHMH的博客
10-12 4756
目录渲染模板语法过滤器代码复用特有变量及函数 渲染模板 用法：render_template(⽂件名,key=value) 模板文件一般默认路径为/templates下的文件，可通过key=value的方式往模板文件中传递参数，模板中使用{{key}}的方式获取参数。 例： @app.route(&quot;/&quot;) def index()： ........ return render_templa...
Python之 jinja2模板浅析
专注自动化、性能测试、测试架构学习交流
06-11 2084
前言 　　要了解jinja2，那么需要先理解模板的概念。模板在Python的web开发中广泛使用，它能够有效的将业务逻辑和页面逻辑分开，使代码可读性增强、并且更加容易理解和维护。 　　模板简单来说就是一个其中包涵占位变量表示动态部分的文件，模板文件在经过动态赋值后，返回给用户。 --> 可以理解为渲染 　　python中自带一个简单的模板，就是string提供的。 1 2 3 4 5 6 7 >>&gt.
Python模块学习 - jinja2
anhuoqiu1787的博客
01-08 2007
模板 　　要了解jinja2，那么需要先理解模板的概念。模板在Python的web开发中广泛使用，它能够有效的将业务逻辑和页面逻辑分开，使代码可读性增强、并且更加容易理解和维护。 　　模板简单来说就是一个其中包涵占位变量表示动态的部分的文件，模板文件在经过动态赋值后，返回给用户。 --> 可以理解为渲染 　　python中自带一个简单的模板，就是string提供的。 ...
jinja Template
Claroja
06-29 440
https://jinja.palletsprojects.com/en/master/api/#jinja2.Template class jinja2.Template Template对象通过Environment对象来创建,具有相同的初始化参数,但是不能设置jloader. 对象方法 方法 描述 globals name filename render([context]) generate([context]) stream([context])
Jinja2模板优化神器：Python脚本jinja2-lint使用教程
- **Ansible**: Ansible是一个自动化运维工具，广泛使用Jinja2作为其配置语言，因此对于管理Ansible任务的配置文件，使用Jinja2-lint进行模板检查尤为关键。 - **AnsiblePython**: 可能指的是专为Ansible任务编写的...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值