Ansible的when语句做条件判断

已于 2023-12-12 18:12:33 修改
阅读量541 收藏 2
点赞数 3
分类专栏： Ansible 文章标签： ansible
于 2023-11-17 20:43:11 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/duke_ding2/article/details/134388100
版权

环境

  • 控制节点：Ubuntu 22.04
  • Ansible 2.10.8
  • 管理节点：CentOS 8

使用 when 语句做条件判断

创建文件 test1.yml 如下：

---
- hosts: all
  tasks:
    - name: task1
      debug:
        msg: "hello"
      when: 1 > 0

    - name: task2
      debug:
        msg: "OK"
      when: 1 > 2

运行结果如下：

......
TASK [task1] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "hello"
}

TASK [task2] ***************************************************************************************
skipping: [192.168.1.55]
......

可见，task满足条件，所以运行了；task2不满足条件，所以没有运行。

多个条件之间可以做逻辑运算（与或非），比如：

      when: ((1 > 0) and (1 < 2)) or (not (1 == 3))

多个 and 条件，也可以写成list的形式，比如：

      when:
        - 1 < 2
        - 2 < 3
        - 3 < 4

基于 ansible_facts 的条件判断

例如：

    - name: task3
      debug:
        msg: "hello"
      when: ansible_facts['os_family'] == "RedHat" #"Debian"

也可以先把ansible_facts先存为变量，再对变量做条件判断，比如：

    - name: task5
      block:
        - name: part1
          set_fact:
            version: "{{ ansible_facts['distribution_major_version'] }}"
        - name: part2
          debug:
            msg: "Horse"
          when: version | int >= 8

注：先用filter把变量转为int类型，再和整数8比较大小。

基于register变量的条件判断

这是一种常见的用法，上一个task把结果记录在变量里，下一个task根据该变量的值做条件判断。

---
- hosts: all
  tasks:
    - name: task1
      shell: cat /tmp/a.txt | wc -l
      register: result
    - name: task2
      debug:
        msg: "More than 100 lines!"
      when: result.stdout | int > 100
  • 当文件超过100行时，结果如下：
......
TASK [task2] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "More than 100 lines!"
}
......

当文件不超过100行时，结果如下：

......
TASK [task2] ***************************************************************************************
skipping: [192.168.1.55]
......

对register变量，可作如下判断：

  • is failed
  • is succeeded
  • is skipped
  • is changed

例如：

---
- hosts: all
  tasks:
  - name: task1
    ansible.builtin.command: /bin/false
    register: result
    ignore_errors: true

  - name: task2
    debug:
      msg: "Task fails!"
    when: result is failed

  - name: task3
    debug:
      msg: "Task succeeds!"
    when: result is succeeded

  - name: task4
    debug:
      msg: "Task skipped!"
    when: result is skipped

  - name: task5 
    debug:
      msg: "Task changed!"
    when: result is changed

基于变量的条件判断

注意： when 语句里的变量，不需要加 {{ }} 。

变量可转换成bool类型，例如：

---
- hosts: all
  vars:
    - var1: true
    - var2: false
    - var3: "yes"
    - var4: "no"
  tasks:
    - name: task1
      debug:
        msg: "task1"
      when: var1
    - name: task2
      debug:
        msg: "task2"
      when: not var2
    - name: task3
      debug:
        msg: "task3"
      when: var3 | bool
    - name: task4
      debug:
        msg: "task4"
      when: not (var4 | bool)

使用没有定义的变量会报错，所以，在使用变量前，可以先判断其是否定义：

  • is defined
  • is undifined

例如：

---
- hosts: all
  tasks:
    - name: task1
      debug:
        msg: "OK"
      when: var1 is defined and var1

这是一种非常常见的用法。

在循环里使用条件判断

loop 和 when 可以一起用，对每次循环做条件判断。例如，遍历文件每一行，若内容超过2个字符，则打印其内容：

---
- hosts: all
  tasks:
    - name: task1
      shell: cat /tmp/a.txt
      register: result
    - name: task2
      debug:
        msg: "{{ item }}"
      loop: "{{ result.stdout_lines }}"
      when: item | length > 2

假设 a.txt 内容如下：

aaaaa
b
ccccc

则运行结果如下：

TASK [task2] ***************************************************************************************
ok: [192.168.1.55] => (item=aaaaa) => {
    "msg": "aaaaa"
}
skipping: [192.168.1.55] => (item=b) 
ok: [192.168.1.55] => (item=ccccc) => {
    "msg": "ccccc"
}

也可以遍历/判断自定义的list或者dict，例如：

---
- hosts: all
  vars:
    - mylist1: [ 1, 2, 3 ]
    - mydict1: {"a": 10, "b": 20, "c": 30}
  tasks:
    - name: task1
      debug:
        msg: "{{ item }}"
      loop: "{{ mylist1 }}"
      when: item > 1
    - name: task2
      debug:
        msg: "{{ item }}"
      loop: "{{ query('dict', mydict1) }}"
      when: item.value > 10

运行结果如下：

......
TASK [task1] ***************************************************************************************
skipping: [192.168.1.55] => (item=1) 
ok: [192.168.1.55] => (item=2) => {
    "msg": 2
}
ok: [192.168.1.55] => (item=3) => {
    "msg": 3
}

TASK [task2] ***************************************************************************************
skipping: [192.168.1.55] => (item={'key': 'a', 'value': 10}) 
ok: [192.168.1.55] => (item={'key': 'b', 'value': 20}) => {
    "msg": {
        "key": "b",
        "value": 20
    }
}
ok: [192.168.1.55] => (item={'key': 'c', 'value': 30}) => {
    "msg": {
        "key": "c",
        "value": 30
    }
}
......

注意，最好也判断一下变量是否定义，比如：

    - name: task3
      debug:
        msg: "{{ item }}"
      loop: "{{ mylist2 }}"
      when: mylist2 is defined and item > 1

    - name: task4
      debug:
        msg: "{{ item }}"
      loop: "{{ query('dict', mydict2) }}"
      when: mydict2 is defined and item.value > 10

或者提供一个缺省的空list/dict，例如：

    - name: task5
      debug:
        msg: "{{ item }}"
      loop: "{{ mylist2 | default([]) }}"
      when: item > 1

    - name: task6
      debug:
        msg: "{{ item }}"
      loop: "{{ query('dict', mydict2 | default({})) }}"
      when: item.value > 10

注意：task3和task4会skip，而task5和task6会运行。

import和include的条件判断

先看include。例如， main.yml 内容如下：

---
- hosts: all
  tasks:
    - name: task1
      include_tasks: test11.yml
      #import_tasks: test11.yml
      when: var1 is not defined
      #vars:
      #  - var1: 111

test11.yml 内容如下：

---
- name: task1
  debug:
    msg: "var1 = {{ var1 }}"
  when: var1 is defined

- name: task2
  debug:
    msg: "I am  task2"

- name: task3
  set_fact:
    var1: 123
  when: var1 is not defined

- name: task4
  debug:
    msg: "var1 = {{ var1 }}"
  when: var1 is defined

- name: task5
  debug:
    msg: "I am task5"

若 main.yml 中没有定义 var1 ，则运行结果如下：

TASK [main_task1] **********************************************************************************
included: /root/temp/temp1113_2/test11.yml for 192.168.1.55

TASK [task1] ***************************************************************************************
skipping: [192.168.1.55]

TASK [task2] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "I am  task2"
}

TASK [task3] ***************************************************************************************
ok: [192.168.1.55]

TASK [task4] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "var1 = 123"
}

TASK [task5] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "I am task5"
}

若 main.yml 中定义了 var1 ，则运行结果如下：

TASK [main_task1] **********************************************************************************
skipping: [192.168.1.55]

include_tasks 的逻辑比较直观：

  • 如果 main.yml 没有定义 var1 ，则满足条件，运行 test11.yml 。
  • 如果 main.yml 定义了 var1 ，则不满足条件，不运行 test11.yml 。

现在，把 include_tasks 换成 import_tasks ， test11.yml 内容不变。

若 main.yml 中没有定义 var1 ，则运行结果如下：

TASK [task1] ***************************************************************************************
skipping: [192.168.1.55]

TASK [task2] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "I am  task2"
}

TASK [task3] ***************************************************************************************
ok: [192.168.1.55]

TASK [task4] ***************************************************************************************
skipping: [192.168.1.55]

TASK [task5] ***************************************************************************************
skipping: [192.168.1.55]

若 main.yml 中定义了 var1 ，则运行结果如下：

TASK [task1] ***************************************************************************************
skipping: [192.168.1.55]

TASK [task2] ***************************************************************************************
skipping: [192.168.1.55]

TASK [task3] ***************************************************************************************
skipping: [192.168.1.55]

TASK [task4] ***************************************************************************************
skipping: [192.168.1.55]

TASK [task5] ***************************************************************************************
skipping: [192.168.1.55]

import_tasks 的运行结果和 include_tasks 大不相同。这是因为， import_tasks 是在预编译期，就把引用的task替换过来了（注意在运行结果里并没有出现 main_task1 的字眼），所以就相当于把 when 的条件判断放到 test11.yml 的每个task里了：

---
- name: task1
  debug:
    msg: "var1 = {{ var1 }}"
  when: var1 is defined and var1 is not defined

- name: task2
  debug:
    msg: "I am  task2"
  when: var1 is not defined

- name: task3
  set_fact:
    var1: 123
  when: var1 is not defined and var1 is not defined

- name: task4
  debug:
    msg: "var1 = {{ var1 }}"
  when: var1 is defined and var1 is not defined

- name: task5
  debug:
    msg: "I am task5"
  when: var1 is not defined

这样就能理解运行结果了。

注意： main_task1 里的变量定义，并没有放到 test11.yml 的每个task里。

创建文件 main.yml 如下：

---
- hosts: all
  tasks:
    - name: main_task1
      import_tasks: test13.yml
      vars:
        - var1: 111

创建文件 test13.yml 如下：

---
- name: task1
  debug:
    msg: "var1 = {{ var1 }}"
  when: var1 is defined

- name: task2
  set_fact:
    var1: 123

- name: task3
  debug:
    msg: "var1 = {{ var1 }}"
  when: var1 is defined

运行结果如下：

TASK [task1] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "var1 = 111"
}

TASK [task2] ***************************************************************************************
ok: [192.168.1.55]

TASK [task3] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "var1 = 123"
}

可见，task1和task3打印的 var1 变量值并不相同。前者是从 main.yml 而来，后者是从task2而来。

注：关于 import_xxx 和 include_xxx ，参见我另一篇文档。

调试

最简单的方法就是打印出来看一下。比如：

---
- hosts: all
  tasks:
    - name: task1
      set_fact:
        var1: '123'

    - name: task2
      debug:
        msg: "var1 = {{ var1 }}"
      when: var1 == 123

运行结果如下：

TASK [task1] ***************************************************************************************
ok: [192.168.1.55]

TASK [task2] ***************************************************************************************
skipping: [192.168.1.55]

可以看到，task2被skip了，这是因为 when 语句没有满足条件。

要确认的话，可以把条件判断的结果打印出来：

......
    - name: task3
      debug:
        var: var1 == 123
......

运行结果如下：

......
TASK [task3] ***************************************************************************************
ok: [192.168.1.55] => {
    "var1 == 123": false
}
......

可见条件判断的结果确实是false。

注意：用的是 debug 和 var 打印条件判断的结果。

接下来，可以打印出来变量看一下其值：

......
    - name: task4
      debug:
        var: var1
......

运行结果如下：

......
TASK [task4] ***************************************************************************************
ok: [192.168.1.55] => {
    "var1": "123"
}
......

可见 var1 的值是 "123" ，是一个字符串（如果是数值则是 123 ）。

当然，更直接的办法是查看一下 var1 的类型：

......
    - name: task5
      debug:
        msg: "{{ var1 | type_debug }}"
......

运行结果如下：

......
TASK [task5] ***************************************************************************************
ok: [192.168.1.55] => {
    "msg": "AnsibleUnicode"
}
......

如果是数值，则类型是 int 。

因为 var1 是字符串，而 123 是整数，所以task2的判断条件不满足。

修改方法为：

原先为： var1 == 123
应改为： var1 == '123' ，或者 var1 | int == 123

参考

  • https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_conditionals.html
蓝黑2020
关注
  • 3
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
ansible的when条件判断
识途老码
10-18 5152
when条件判断
《Ansible语法篇：剧本对象关键字之when》
东城绝神
03-09 1303
《Ansible语法篇：循环和条件判断》
ansible之when条件语法、处理任务失败、jinja2模板和项目管理
Fran_klin__的博客
08-08 2191
实施任务控制item--loop、when条件任务语法、handles和notify、ignore_errors、force_handles、failed_when、changed_when、block、rescue、always、jinja2模板、forks和seria、playbook的文件导入
Ansible任务控制loop循环、when和block条件判断介绍演示
树下一少年的博客
10-25 1602
--tasks:debug:loop:- 'a'- 'b'- 'c'"msg": "a""msg": "b""msg": "c"---tasks:debug:循环输出hello和nihao---tasks:debug:loop:"msg": {"msg": {循环创建user1和user2---tasks:user:loop:uid: 1011uid: 1012---tasks:debug:​---tasks:debug:​---
Ansible使用基础之when条件判断
Jxc的个人博客
11-11 2374
when意为当····什么时候，在playbook中，用作条件判断。
运维自动化之ANSIBLE.pdf
09-24
条件判断（when）语句使得我们可以根据特定条件执行或跳过任务，而 with_items 结构则用于遍历列表，批量处理多个对象。Ansible Roles 是一种组织 Playbook 结构的方式，它便于重用和共享配置。 在企业实际应用场景...
ansible-play:Ansible playbook 中的组语句
06-28
具有共同项目/条件的组语句 该模块像顶级游戏一样执行所有模块，但允许所有正常任务属性（例如 with_items）。 当它很笨拙时（例如，创建一行/两行包含文件），它可以用作替换包含，包括不支持的 include/with_items...
ansible 示例代码
11-27
在playbooks中，我们可以使用条件语句（如`when`）来决定何时执行任务，以及使用循环（如`with_items`）来遍历列表并执行相同任务。这使得Ansible具有极高的灵活性。 ### 7. Facts和变量 Facts是Ansible自动收集的...
详解ansible批量管理服务
10-16
- **信息判断**：利用条件语句（如 `when`）决定是否执行特定任务，实现流程控制。 - **信息循环**：通过 `with_items` 或其他循环结构遍历列表，执行相同任务于多个元素上。 - **忽略错误**：使用 `ignore_...
Ansible-ansible-deployment-facts.zip
09-18
8. **Error Handling and Conditional Statements**: Ansible 提供了丰富的错误处理和条件语句（如 `when`），允许你在 playbook 中基于部署事实做出决策，避免不必要的操作或处理异常情况。 9. **Migrations and ...
六、ansible的条件判断
最新发布
爱吃西红柿的博客
12-28 1103
"错误处理"功能就是当某任务出错时，执行指定的其他任务，打个比方，我们想要在A任务执行失败时执行B任务，如果A任务执行成功，则无需执行B任务，实现这个功能，就能够使用block，当然，我们还有一些别的方法，也可以实现类似的功能，比如前文中提到的jinja2的tests，有个一名为failed的test，借助failed也可以实现类似的功能，在when关键字中引用变量时，变量名不需要加"{{ }}"，我们可以使用when关键字为任务指定条件，条件成立，则执行任务，条件不成立，则不执行任务。
ansible（十四）判断
AaNiceMan的博客
03-31 2457
绝大多数语言中，都使用"if"作为条件判断的关键字，而在ansible中，条件判断的关键字是"when" 我们可以使用when关键字为任务指定条件，条件成立,则执行任务，条件不成立，则不执行任务 在ansible中，我们可以使用如下比较运算符 == :比较两个对象是否相等,相等为真 != :比较两个对象是否不等，不等为真 :比较两个值的大小，如果左边的值大于右边的值，则为 真 < :比较两...
ansible之when简单调用
a13568hki的博客
01-07 8902
When语句 有时候用户有可能需要某一个主机越过某一个特定的步骤.这个过程就可以简单的像在某一个特定版本的系统上少装了一个包一样或者像在一个满了的文件系统上执行清理操作一样. 这些操作在Ansible上,若使用when语句都异常简单，能在when中使用jinja2的语法 1、自己定义的参数 vim /etc/ansible/hosts --- - hosts: tomcat vars: ...
这样动手玩Ansible多条件判断真爽
IT民工金鱼哥，专注运维技术。
12-15 1293
第五章 实施任务控制---多条件判断
Ansible14：Playbook条件语句
weixin_33877092的博客
06-10 726
目录 简介 when关键字 1. when基本使用 2. 比较运算符 3. 逻辑运算符 条件判断与tests 判断变量 判断执行结果 判断路径 判断字符串 判断整除 ...
Ansible中的条件判断、handlers
HyyyyYUe的博客
09-06 592
1.有条件地运行任务 Ansible可使用conditionals在符合特定条件时执行任务或play。 所以我们可以利用条件来区分不同的受管主机，并根据它们所符合的条件来分配功能角色。Playbook变量、注册的变量和Ansible事实都可通过条件来进行测试。可以使用比较字符串、数字数据和布尔值的运算符。 以下场景说明了在Ansible中使用条件的几种情况： 1.可以在变量中定义硬限制（如min_memory）并将它与受管主机上的可用内存进行比较。 2.Ansible可以捕获并评估命令的输出，以确定某一任务
ansible自动化运维工具----ansible中的roles详解和when的使用(7)
Chen的博客
11-26 2061
一、引入roles Roles 基于一个已知的文件结构，去自动的加载某些 vars_files，tasks 以及 handlers。基于 roles 对内容进行分组，使得我们可以容易地与其他用户分享 roles 。 角色（roles）是ansible自1.2版本开始引入的新特性，用于层次性，结构化地组织playbook。roles能够根据层次型结构自动装载变量文件、tasks以及handlers等...
ansible之条件语句
Jason的博客
08-30 4641
有时候我们希望在某些情况对特定主机执行、不执行一些操作。例如给某主机安装特定的软件，或者在磁盘快满时执行清理工作。whenwhen语句就是用来实现这个功能的，它是一个jinja2的语法，但是不需要双大括号
Linux Ansible任务控制（循环判断、处理程序、失败任务）
m0_49864110的博客
04-28 1735
等待tasks中任务执行的结果为changed（黄色）时触发notify，然后调用handlers下的此notify所对应的任务。block：定义要运行的主要任务（block中的任何一个task出错，会顺序执行rescue中的task）并不是所有的错误都可以忽略，只有当任务的执行成功或失败对后面的任务没有关联的时候才可以忽略。block任务执行成功 → 直接走always中的任务（不执行rescue对应的任务）handler里面的任务只会执行依次，即使handler中的一个任务被通知了多次。
ansible中 when语句如何使用
04-10
Ansible中的when语句可以用于指定一个条件，只有当条件成立时才执行任务。例如： - name: Install nginx apt: name: nginx state: present when: "'web' in group_names" 这个任务的含义是只有当主机属于名为...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值