基础设施即代码 / 系统课时

注册任务结果并复用

注册任务结果并复用

任务执行后产生的返回值经常决定下一步动作。使用 register 可以把模块返回结构保存为变量,随后读取退出码、标准输出、变更状态等字段,用于条件判断、调试输出或其他任务参数。

学习目标

  • 使用 register 保存任务返回值
  • 读取 stdout、rc、changed 等常用字段
  • 在 when 和后续任务参数中复用注册结果

Register 保存的是什么

register 保存的不是屏幕上显示的一行文本,而是模块返回的完整数据结构。不同模块提供的字段并不完全相同,例如 ansible.builtin.command 常见字段包括 stdout、stderr、rc 和 changed。

下面的 Playbook 执行一个确定性的命令,并把结果保存到 command_result:

yaml
---
- name: Demonstrate registered results
  hosts: localhost
  gather_facts: false
  tasks:
    - name: Produce a value
      ansible.builtin.command:
        cmd: /bin/echo ready
      register: command_result
      changed_when: false

    - name: Show selected return fields
      ansible.builtin.debug:
        msg: "stdout={{ command_result.stdout }} rc={{ command_result.rc }} changed={{ command_result.changed }}"

运行命令:

bash
ansible-playbook -i localhost, -c local register-demo.yml

预期输出中的任务统计格式可能因 Ansible 版本不同而略有变化,但调试信息应为:

text
ok: [localhost] => {
    "msg": "stdout=ready rc=0 changed=False"
}

这里使用 changed_when: false 是因为读取并输出字符串不会改变受管节点状态,从而让 changed 的语义与实际行为保持一致。

查看完整返回结构

不知道模块返回哪些字段时,不要凭经验猜字段名,可以直接用 debug 输出注册变量。下面是片段示例,依赖前面的 command_result:

yaml
- name: Inspect complete result
  ansible.builtin.debug:
    var: command_result

验证时会看到一个字典,其中包含 stdout、stdout_lines、stderr、rc、changed 等由 command 模块返回的字段。实际字段集合可能随模块和 Ansible 版本变化,因此编写逻辑前应以真实返回值为准。

用结果控制后续任务

注册结果最常见的用途是驱动 when。条件表达式直接引用变量,不要再包一层 Jinja2 的 {{ }}。例如只有前一个命令成功并返回预期文本时才继续:

yaml
- name: Confirm service readiness
  ansible.builtin.debug:
    msg: "The dependency is ready"
  when:
    - command_result.rc == 0
    - command_result.stdout == 'ready'

这是片段示例,依赖已经注册的 command_result。在前面的 Playbook 中两个条件都成立,因此预期结果为:

text
ok: [localhost] => {
    "msg": "The dependency is ready"
}

注册变量也可以直接进入后续模块参数,例如把探测得到的路径、版本号或资源 ID 传给下一项操作。需要注意的是,register 保存的是当前 Playbook 执行期间的内存变量,并不会自动持久化到下一次 ansible-playbook 运行。

循环任务的注册结果

如果带 loop 的任务使用 register,顶层变量不会只保存最后一次迭代,而是通过 results 列表保存每个循环项的结果。因此处理循环结果时通常需要访问 registered_variable.results,其中每个元素对应一次迭代,并带有该次执行的模块返回字段以及循环项信息。

判断注册结果时,应先确认产生它的模块以及返回结构,再选择字段。把 register 理解为“保存模块返回对象”而不是“保存输出文本”,就能自然地把任务执行结果连接到后续判断和参数中。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

注册任务结果并复用

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通