条件语句

在 playbook 中，您可能希望根据 fact（有关远程系统的数据）、变量或先前任务的结果的值来执行不同的任务或拥有不同的目标。您可能希望某些变量的值取决于其他变量的值。或者，您可能希望根据主机是否匹配其他条件来创建其他主机组。您可以使用条件语句完成所有这些操作。

Ansible 在条件语句中使用 Jinja2 测试 和 过滤器。Ansible 支持所有标准测试和过滤器，并添加了一些独特的测试和过滤器。

注意

在 Ansible 中有许多选项可以控制执行流程。您可以在 https://jinja.flask.org.cn/en/latest/templates/#comparisons 找到更多受支持条件语句的示例。

使用 when 的基本条件语句

最简单的条件语句适用于单个任务。创建任务，然后添加一个 when 语句来应用测试。when 子句是一个原始的 Jinja2 表达式，没有双花括号（参见 group_by_module）。当您运行任务或 playbook 时，Ansible 会针对所有主机评估测试。在测试通过（返回值为 True）的任何主机上，Ansible 都会运行该任务。例如，如果您在多台机器上安装 mysql，其中一些机器启用了 SELinux，则您可能需要一个任务来配置 SELinux 以允许 mysql 运行。您只需要在启用了 SELinux 的机器上运行该任务。

tasks:
  - name: Configure SELinux to start mysql on any port
    ansible.posix.seboolean:
      name: mysql_connect_any
      state: true
      persistent: true
    when: ansible_selinux.status == "enabled"
    # all variables can be used directly in conditionals without double curly braces

基于 ansible_facts 的条件语句

通常，您希望根据 facts 来执行或跳过任务。facts 是各个主机的属性，包括 IP 地址、操作系统、文件系统的状态等等。使用基于 facts 的条件语句

  • 您只能在操作系统是特定版本时安装某个软件包。

  • 您可以跳过配置具有内部 IP 地址的主机的防火墙。

  • 您只能在文件系统即将满时执行清理任务。

请参阅 常用 facts，了解条件语句中经常出现的 facts 列表。并非所有 facts 都存在于所有主机上。例如，下面示例中使用的“lsb_major_release”fact 仅在目标主机上安装了 lsb_release package 时才存在。要查看您的系统上有哪些可用的 facts，请将调试任务添加到您的 playbook 中。

- name: Show facts available on the system
  ansible.builtin.debug:
    var: ansible_facts

这是一个基于 fact 的条件语句示例。

tasks:
  - name: Shut down Debian flavored systems
    ansible.builtin.command: /sbin/shutdown -t now
    when: ansible_facts['os_family'] == "Debian"

如果您有多个条件，则可以使用括号将它们组合在一起。

tasks:
  - name: Shut down CentOS 6 and Debian 7 systems
    ansible.builtin.command: /sbin/shutdown -t now
    when: (ansible_facts['distribution'] == "CentOS" and ansible_facts['distribution_major_version'] == "6") or
          (ansible_facts['distribution'] == "Debian" and ansible_facts['distribution_major_version'] == "7")

您可以使用 逻辑运算符 来组合条件。当您有多个条件都需要为真（即逻辑 and）时，您可以将它们指定为列表。

tasks:
  - name: Shut down CentOS 6 systems
    ansible.builtin.command: /sbin/shutdown -t now
    when:
      - ansible_facts['distribution'] == "CentOS"
      - ansible_facts['distribution_major_version'] == "6"

如果 fact 或变量是字符串，并且您需要对其运行数学比较，请使用过滤器来确保 Ansible 将该值读取为整数。

tasks:
  - ansible.builtin.shell: echo "only on Red Hat 6, derivatives, and later"
    when: ansible_facts['os_family'] == "RedHat" and ansible_facts['lsb']['major_release'] | int >= 6

您可以将 Ansible facts 存储为变量，以用于条件逻辑，如下例所示。

tasks:
    - name: Get the CPU temperature
      set_fact:
        temperature: "{{ ansible_facts['cpu_temperature'] }}"

    - name: Restart the system if the temperature is too high
      when: temperature | float > 90
      shell: "reboot"

基于已注册变量的条件语句

通常在 playbook 中，您希望根据先前任务的结果来执行或跳过任务。例如，您可能希望在某个服务被先前任务升级后对其进行配置。要创建基于已注册变量的条件语句

  1. 将先前任务的结果注册为变量。

  2. 创建基于已注册变量的条件测试。

您可以使用 register 关键字创建已注册变量的名称。已注册变量始终包含创建它的任务的状态以及该任务生成的任何输出。您可以在模板和操作行以及条件 when 语句中使用已注册变量。您可以使用 variable.stdout 访问已注册变量的字符串内容。例如

- name: Test play
  hosts: all

  tasks:

      - name: Register a variable
        ansible.builtin.shell: cat /etc/motd
        register: motd_contents

      - name: Use the variable in conditional statement
        ansible.builtin.shell: echo "motd contains the word hi"
        when: motd_contents.stdout.find('hi') != -1

如果变量是列表，则可以在任务的循环中使用已注册的结果。如果变量不是列表，则可以使用 stdout_lines 或 variable.stdout.split() 将其转换为列表。您还可以按其他字段拆分行。

- name: Registered variable usage as a loop list
  hosts: all
  tasks:

    - name: Retrieve the list of home directories
      ansible.builtin.command: ls /home
      register: home_dirs

    - name: Add home dirs to the backup spooler
      ansible.builtin.file:
        path: /mnt/bkspool/{{ item }}
        src: /home/{{ item }}
        state: link
      loop: "{{ home_dirs.stdout_lines }}"
      # same as loop: "{{ home_dirs.stdout.split() }}"

已注册变量的字符串内容可能为空。如果您只想在已注册变量的 stdout 为空的主机上运行另一个任务，请检查已注册变量的字符串内容是否为空。

- name: check registered variable for emptiness
  hosts: all

  tasks:

      - name: List contents of directory
        ansible.builtin.command: ls mydir
        register: contents

      - name: Check contents for emptiness
        ansible.builtin.debug:
          msg: "Directory is empty"
        when: contents.stdout == ""

Ansible 始终在已注册变量中为每个主机注册某些内容，即使在任务失败或 Ansible 由于不满足条件而跳过任务的主机上也是如此。要在这些主机上运行后续任务，请查询已注册变量的 is skipped（而不是“undefined”或“default”）。有关更多信息，请参阅 注册变量。以下是在任务成功或失败时基于条件语句的示例。请记住，如果您希望 Ansible 在发生错误时继续在主机上执行，则需要忽略错误。

tasks:
  - name: Register a variable, ignore errors and continue
    ansible.builtin.command: /bin/false
    register: result
    ignore_errors: true

  - name: Run only if the task that registered the "result" variable fails
    ansible.builtin.command: /bin/something
    when: result is failed

  - name: Run only if the task that registered the "result" variable succeeds
    ansible.builtin.command: /bin/something_else
    when: result is succeeded

  - name: Run only if the task that registered the "result" variable is skipped
    ansible.builtin.command: /bin/still/something_else
    when: result is skipped

  - name: Run only if the task that registered the "result" variable changed something.
    ansible.builtin.command: /bin/still/something_else
    when: result is changed

注意

较旧版本的 Ansible 使用 success 和 fail，但 succeeded 和 failed 使用了正确的时态。所有这些选项现在均有效。

基于变量的条件语句

您还可以根据在 playbook 或清单中定义的变量创建条件语句。由于条件语句需要布尔输入（测试必须评估为 True 才能触发条件），因此您必须将 | bool 过滤器应用于非布尔变量，例如包含“yes”、“on”、“1”或“true”等内容的字符串变量。您可以像这样定义变量。

vars:
  epic: true
  monumental: "yes"

使用上面的变量，Ansible 将运行其中一项任务并跳过另一项任务。

tasks:
    - name: Run the command if "epic" or "monumental" is true
      ansible.builtin.shell: echo "This certainly is epic!"
      when: epic or monumental | bool

    - name: Run the command if "epic" is false
      ansible.builtin.shell: echo "This certainly isn't epic!"
      when: not epic

如果未设置所需的变量，则可以使用 Jinja2 的 defined 测试来跳过或失败。例如

tasks:
    - name: Run the command if "foo" is defined
      ansible.builtin.shell: echo "I've got '{{ foo }}' and am not afraid to use it!"
      when: foo is defined

    - name: Fail if "bar" is undefined
      ansible.builtin.fail: msg="Bailing out. This play requires 'bar'"
      when: bar is undefined

这在结合使用 vars 文件的条件导入（见下文）时尤其有用。如示例所示，您无需使用 {{ }} 来在条件语句中使用变量，因为这些变量已隐含。

在循环中使用条件语句

如果您将 when 语句与 循环 组合使用，则 Ansible 会针对每个项目分别处理条件。这是设计使然，因此您可以在循环中的某些项目上执行任务，并在其他项目上跳过它。例如

tasks:
    - name: Run with items greater than 5
      ansible.builtin.command: echo {{ item }}
      loop: [ 0, 2, 4, 6, 8, 10 ]
      when: item > 5

如果您需要在循环变量未定义时跳过整个任务，请使用 |default 过滤器提供一个空迭代器。例如，当循环遍历列表时

- name: Skip the whole task when a loop variable is undefined
  ansible.builtin.command: echo {{ item }}
  loop: "{{ mylist|default([]) }}"
  when: item > 5

当循环遍历字典时，您可以执行相同的操作。

- name: The same as above using a dict
  ansible.builtin.command: echo {{ item.key }}
  loop: "{{ query('dict', mydict|default({})) }}"
  when: item.value > 5

加载自定义 facts

您可以提供您自己的 facts，如 您应该开发模块吗？ 中所述。要运行它们，只需在任务列表的顶部调用您自己的自定义 fact 收集模块，然后在以后的任务中就可以访问此处返回的变量。

tasks:
    - name: Gather site specific fact data
      action: site_facts

    - name: Use a custom fact
      ansible.builtin.command: /usr/bin/thingy
      when: my_custom_fact_just_retrieved_from_the_remote_system == '1234'

带复用的条件语句

您可以在可重用任务文件、剧本或角色中使用条件语句。Ansible 对动态复用（includes）和静态复用（imports）执行这些条件语句的方式不同。有关 Ansible 中复用的更多信息，请参阅重用 Ansible 工件。

导入时的条件语句

当您向 import 语句添加条件时，Ansible 会将该条件应用于导入文件中所有任务。此行为等效于标签继承：向多个任务添加标签。Ansible 将条件应用于每个任务并分别评估每个任务。例如，如果您想定义并显示一个之前未定义的变量，您可以有一个名为 main.yml 的剧本和一个名为 other_tasks.yml 的任务文件。

# all tasks within an imported file inherit the condition from the import statement
# main.yml
- hosts: all
  tasks:
  - import_tasks: other_tasks.yml # note "import"
    when: x is not defined

# other_tasks.yml
- name: Set a variable
  ansible.builtin.set_fact:
    x: foo

- name: Print a variable
  ansible.builtin.debug:
    var: x

Ansible 在执行时将其扩展为等效于以下内容：

- name: Set a variable if not defined
  ansible.builtin.set_fact:
    x: foo
  when: x is not defined
  # this task sets a value for x

- name: Do the task if "x" is not defined
  ansible.builtin.debug:
    var: x
  when: x is not defined
  # Ansible skips this task, because x is now defined

如果 x 最初已定义，则两个任务都按预期跳过。但如果 x 最初未定义，则调试任务将被跳过，因为条件是针对每个导入的任务进行评估的。条件将对 set_fact 任务评估为 true，这将定义变量并导致 debug 条件评估为 false。

如果这不是您想要的行为，请使用 include_* 语句仅将条件应用于该语句本身。

# using a conditional on include_* only applies to the include task itself
# main.yml
- hosts: all
  tasks:
  - include_tasks: other_tasks.yml # note "include"
    when: x is not defined

现在，如果 x 最初未定义，则调试任务不会被跳过，因为条件是在 include 时进行评估的，并且不适用于各个任务。

您也可以将条件应用于 import_playbook 以及其他 import_* 语句。当您使用此方法时，Ansible 会为每个不满足条件的主机上的每个任务返回“skipped”消息，从而产生重复的输出。在许多情况下，group_by 模块 可以以更简化的方式实现相同的目标；请参阅处理操作系统和发行版差异。

包含时的条件语句

当您在 include_* 语句上使用条件时，该条件仅应用于 include 任务本身，而不应用于包含文件中的任何其他任务。为了与上面导入条件语句的示例进行对比，请查看相同的剧本和任务文件，但使用 include 而不是 import。

# Includes let you reuse a file to define a variable when it is not already defined

# main.yml
- include_tasks: other_tasks.yml
  when: x is not defined

# other_tasks.yml
- name: Set a variable
  ansible.builtin.set_fact:
    x: foo

- name: Print a variable
  ansible.builtin.debug:
    var: x

Ansible 在执行时将其扩展为等效于以下内容：

# main.yml
- include_tasks: other_tasks.yml
  when: x is not defined
  # if condition is met, Ansible includes other_tasks.yml

# other_tasks.yml
- name: Set a variable
  ansible.builtin.set_fact:
    x: foo
  # no condition applied to this task, Ansible sets the value of x to foo

- name: Print a variable
  ansible.builtin.debug:
    var: x
  # no condition applied to this task, Ansible prints the debug statement

通过使用 include_tasks 而不是 import_tasks，将按预期执行 other_tasks.yml 中的两个任务。有关 include 与 import 之间差异的更多信息，请参阅重用 Ansible 工件。

角色中的条件语句

有三种方法可以将条件应用于角色

  • 通过将 when 语句放在 roles 关键字下，将相同条件应用于角色中的所有任务。请参阅本节中的示例。

  • 通过将 when 语句放在剧本中的静态 import_role 上，将相同条件应用于角色中的所有任务。

  • 向角色本身内的各个任务或块添加条件。这是唯一允许您根据 when 语句选择或跳过角色中某些任务的方法。要选择或跳过角色中的任务，您必须在各个任务或块上设置条件，在剧本中使用动态 include_role，并将条件添加到 include 中。当您使用此方法时，Ansible 会将条件应用于 include 本身以及角色中也具有该 when 语句的任何任务。

当您使用 roles 关键字在剧本中静态地包含角色时，Ansible 会将您定义的条件添加到角色中的所有任务。例如

- hosts: webservers
  roles:
     - role: debian_stock_config
       when: ansible_facts['os_family'] == 'Debian'

根据事实选择变量、文件或模板

有时，主机的事实决定了您想要对某些变量使用的值，甚至决定了您想要为该主机选择的文件或模板。例如，CentOS 和 Debian 上的软件包名称不同。常见服务的配置文件在不同的操作系统版本和类型上也不同。要根据主机的事实加载不同的变量文件、模板或其他文件

  1. 将您的变量文件、模板或文件命名为与区分它们的 Ansible 事实相匹配

  2. 使用基于该 Ansible 事实的变量为每个主机选择正确的变量文件、模板或文件

Ansible 将变量与任务分开，使您的剧本不会变成包含嵌套条件的任意代码。这种方法可以产生更简洁且可审计的配置规则，因为需要跟踪的决策点更少。

根据事实选择变量文件

您可以创建一个在多个平台和操作系统版本上运行的剧本，并通过将变量值放在变量文件中并有条件地导入它们来实现最少的语法。如果您想在一些 CentOS 和一些 Debian 服务器上安装 Apache，请创建具有 YAML 键和值的变量文件。例如

---
# for vars/RedHat.yml
apache: httpd
somethingelse: 42

然后根据您在剧本中收集的主机的事实导入这些变量文件

---
- hosts: webservers
  remote_user: root
  vars_files:
    - "vars/common.yml"
    - [ "vars/{{ ansible_facts['os_family'] }}.yml", "vars/os_defaults.yml" ]
  tasks:
  - name: Make sure apache is started
    ansible.builtin.service:
      name: '{{ apache }}'
      state: started

Ansible 收集 webservers 组中主机的 facts，然后将变量“ansible_facts['os_family']”插入文件名列表中。如果您有运行 Red Hat 操作系统（例如 CentOS）的主机，Ansible 将查找 'vars/RedHat.yml'。如果该文件不存在，Ansible 将尝试加载 'vars/os_defaults.yml'。对于 Debian 主机，Ansible 首先查找 'vars/Debian.yml'，然后回退到 'vars/os_defaults.yml'。如果未找到列表中的任何文件，Ansible 将引发错误。

根据事实选择文件和模板

当不同的操作系统版本或类型需要不同的配置文件或模板时，您可以使用相同的方法。根据分配给每个主机的变量选择合适的文件或模板。与在单个模板中放置大量条件来涵盖多个操作系统或软件包版本相比，这种方法通常更简洁。

例如，您可以为 CentOS 和 Debian 之间差异很大的配置文件创建模板

- name: Template a file
  ansible.builtin.template:
    src: "{{ item }}"
    dest: /etc/myapp/foo.conf
  loop: "{{ query('first_found', { 'files': myfiles, 'paths': mypaths}) }}"
  vars:
    myfiles:
      - "{{ ansible_facts['distribution'] }}.conf"
      -  default.conf
    mypaths: ['search_location_one/somedir/', '/opt/other_location/somedir/']

调试条件语句

如果您的条件语句 when 的行为与预期不符，您可以添加 debug 语句以确定条件是否评估为 true 或 false。条件语句中意外行为的一个常见原因是将整数作为字符串测试或将字符串作为整数测试。要调试条件语句，请将整个语句作为 debug 任务中的 var: 值添加。然后 Ansible 将显示测试以及语句的评估方式。例如，以下是一组任务和示例输出

- name: check value of return code
  ansible.builtin.debug:
    var: bar_status.rc

- name: check test for rc value as string
  ansible.builtin.debug:
    var: bar_status.rc == "127"

- name: check test for rc value as integer
  ansible.builtin.debug:
    var: bar_status.rc == 127

TASK [check value of return code] *********************************************************************************
ok: [foo-1] => {
    "bar_status.rc": "127"
}

TASK [check test for rc value as string] **************************************************************************
ok: [foo-1] => {
    "bar_status.rc == \"127\"": false
}

TASK [check test for rc value as integer] *************************************************************************
ok: [foo-1] => {
    "bar_status.rc == 127": true
}

常用事实

以下 Ansible 事实经常用于条件语句中。

ansible_facts['distribution']

可能的值（示例，不完整列表）

Alpine
Altlinux
Amazon
Archlinux
ClearLinux
Coreos
CentOS
Debian
Fedora
Gentoo
Mandriva
NA
OpenWrt
OracleLinux
RedHat
Slackware
SLES
SMGL
SUSE
Ubuntu
VMwareESX

ansible_facts['distribution_major_version']

操作系统的 major 版本。例如，Ubuntu 16.04 的值为 16。

ansible_facts['os_family']

可能的值（示例，不完整列表）

AIX
Alpine
Altlinux
Archlinux
Darwin
Debian
FreeBSD
Gentoo
HP-UX
Mandrake
RedHat
SMGL
Slackware
Solaris
Suse
Windows

另请参阅

使用 playbook

剧本简介

角色

按角色组织剧本

一般提示

剧本提示和技巧

使用变量

关于变量的所有内容

沟通

有问题？需要帮助？想分享您的想法？请访问 Ansible 沟通指南