如何在Ansible中显示当前正在运行的included_tasks playbook文件的名称

57次阅读

没有评论

问题描述

在使用Ansible编写角色时，想要在运行包含的任务（import_tasks）时，将当前正在运行的任务文件的名称显示出来，以便进行调试。用户已经查阅了Ansible的特殊变量列表，但并没有找到满足需求的变量。

解决方案

请注意以下操作可能受到Ansible版本的影响。
在Ansible中，没有直接提供获取当前正在运行的import_tasks文件名称的特殊变量。然而，你可以通过一些方式来实现这个目标。

方案1：通过任务名称修改标题

你可以在每个导入的任务（import_tasks）文件中，手动将任务名称添加到任务标题中。这样在任务执行时，标题中会包含导入的任务文件名称。

打开需要修改的任务文件，比如base_packages.yml。
在任务的名称（name）属性中添加任务文件的名称，以便在执行时显示在标题中。例如：
“`yaml

name: “base_packages: Install basic packages”
# 任务的其它配置
“`
这样，在执行这个任务时，标题会显示为”base_packages: Install basic packages”。

这个方法虽然需要手动修改每个任务文件，但可以有效地实现在执行过程中显示任务文件名称的目标。

方案2：使用Play名称代替

你提到了特殊变量{{ ansible_play_name }}，它返回的是Play的名称。虽然这个变量在你的场景中不太适用，但你可以使用Play的名称来代表当前正在执行的任务文件。

在你的Playbook中，为每个导入的任务文件添加一个Play，并将导入的任务作为Play的任务。
使用Play的名称来代表正在执行的任务文件名称。

以下是一个示例Playbook，演示如何使用Play的名称来代表导入的任务文件名称：

---
- name: Run common tasks
  hosts: localhost
  tasks:
    - import_tasks: base_packages.yml
      name: "{{ playbook_file | basename }}: Install basic packages"
    # 其他导入的任务

在上面的示例中，playbook_file 是一个特殊变量，它表示当前Playbook的文件路径。使用basename过滤器可以提取文件的名称部分。这样，在执行任务时，任务的标题会显示为”base_packages.yml: Install basic packages”。

请注意，这种方法需要在Playbook中为每个导入的任务文件添加一个Play，并且每个任务都需要手动设置名称。但它可以实现在执行过程中动态地显示任务文件名称。

方案3：使用包装脚本

另一种方法是使用一个包装脚本，在脚本中执行Ansible任务，并在执行每个任务时输出任务文件名称。

以下是一个简单的示例包装脚本，演示如何实现这个目标：

#!/bin/bash
# 包装脚本示例：run_ansible.sh

# 定义要运行的任务文件列表
TASK_FILES=("base_packages.yml" "iptables.yml" "other_task.yml")

for TASK_FILE in "${TASK_FILES[@]}"; do
    echo "Running task: $TASK_FILE"
    ansible-playbook -i inventory.ini -e "task_file=$TASK_FILE" your_playbook.yml
done

在这个示例脚本中，我们定义了要运行的任务文件列表，并在循环中使用ansible-playbook命令执行每个任务文件。在执行任务时，输出任务文件名称。你可以根据自己的实际情况进行调整。