詳解Ansible Debug模塊

一、Debug模塊介紹

Ansible的Debug模塊是用於調試Ansible Playbook和任務錯誤的一個非常實用的模塊。它可以輸出變量的值、任務執行結果等信息，可以方便地定位問題。

Debug模塊可以輸出文本信息和變量的值，同時還可以通過指定verbosity參數輸出不同級別的調試信息。

下面是Debug模塊最基本的使用方法：

- name: 輸出變量的值
  debug:
    var: foo

其中，var參數指定要輸出的變量的名稱。

二、輸出文本信息

Debug模塊不僅可以輸出變量的值，還可以輸出文本信息。這對於調試Playbook和任務錯誤非常有用。

下面是一個例子，演示了如何輸出一段文本：

- name: 輸出一段文本
  debug:
    msg: "Hello, world"

可以看到，msg參數指定了要輸出的文本。

三、輸出調試信息

Debug模塊還可以輸出各種級別的調試信息。這對於調試複雜的Playbook和任務非常有用。

下面是Debug模塊支持的不同調試級別：

• 0：輸出所有調試信息（默認）
• 1：不輸出變量值等詳細信息
• 2：只輸出關鍵信息
• 3：只輸出指定的信息

下面是演示如何使用verbosity參數輸出不同級別的調試信息：

- name: 輸出各種級別的調試信息
  debug:
    msg: "debug message"
  verbosity: 2

可以看到，使用verbosity參數可以指定輸出的調試級別。

四、Debug模塊的使用技巧

1、使用變量名輸出變量的值

Debug模塊可以通過變量名輸出變量的值。這樣可以方便地在調試信息中查看變量的實際值，便於定位問題。

例如：

- name: 輸出變量的值
  debug:
    var: foo

可以看到，var參數指定了要輸出的變量的名稱。

2、使用{{ }}輸出變量的值

在Playbook或任務中，可以使用{{ }}語法輸出變量的值。這種語法也可以在Debug模塊中使用。

例如：

- name: 輸出變量的值
  debug:
    msg: "foo 的值是 {{ foo }}"

可以看到，{{ }}語法可以直接嵌入到輸出文本中。

3、使用when參數輸出特定條件下的值

當Playbook或任務只在滿足特定條件時才會被執行時，可以使用when參數控制Debug模塊輸出的值。

例如：

- name: 輸出變量的值
  debug:
    var: foo
  when: foo is defined

可以看到，when參數指定了條件，只有在foo已定義時才會輸出變量的值。

五、Debug模塊的高級用法

1、使用register參數註冊變量

Debug模塊可以通過register參數將變量的值註冊為新的變量。這對於在後續任務中使用變量非常有用。

例如：

- name: 註冊變量
  shell: "grep pattern file.txt | head -1"
  register: result

- name: 輸出註冊的變量
  debug:
    var: result.stdout

可以看到，在第一個任務中，使用shell模塊執行命令，並將命令的輸出註冊為一個新的變量result。然後在第二個任務中，使用Debug模塊輸出result.stdout變量的值。

2、使用multiline參數輸出多行文本

Debug模塊的multiline參數可以輸出多行文本。這在調試多行文本變量時非常有用。

例如：

- name: 輸出多行文本
  debug:
    msg: "{{ '\n'.join(multiline_text.splitlines()) }}"
  vars:
    multiline_text: |
      This is a
      multiline
      text

可以看到，在vars中定義了一個多行文本變量multiline_text，然後使用join和splitlines函數將它轉換為單行文本並輸出。

3、使用fail參數拋出錯誤

Debug模塊可以使用fail參數拋出一個錯誤。這在當某些條件不符合時需要終止Playbook或任務時非常有用。

例如：

- name: 檢查變量的值
  fail:
    msg: "變量值不符合要求"
  when: foo < 0

可以看到，當foo小於0時，使用fail參數拋出一個錯誤。這會終止當前的Playbook或任務。