Ansibleのdebugモジュールにおいて\nを改行した状態で表示する

備忘

課題: debugモジュールにおいて文字列中の改行コード\nをログにおいて実際に改行して表示したい。

debugモジュールにて、改行コードの入った文字列を表示すると、改行コードは\nとして表示され、改行は行われない。

playbook例

site.yml、

- hosts: localhost
  tasks:

  - debug:
      var: text
    vars:
      test: |
        foo
        bar
        baz

  - debug:
      msg: "{{ text }}"
    vars:
      text: |
        foo
        bar
        baz

出力例

$ ansible-playbook site.yml
...

TASK [debug] *********************************************************************************************************************************************************************************
ok: [localhost] => {
    "text": "foo\nbar\nbaz"
}

TASK [debug] *********************************************************************************************************************************************************************************
ok: [localhost] => {
    "msg": "foo\nbar\nbaz\n"
}

...

改行コードがそのまま\nとして表示されている。
ここで、改行コードを\nでなく実際に改行して表示したい。

ソリューション1: stdout_callback = community.general.yamlの利用

community.generalコレクションの導入

$ ansible-galaxy collection install community.general
...

~/.ansible/collections/ansible_collections/community/general/に導入される

ansible.cfgに、stdout_callbackとしてcommunity.general.yamlを使用する設定

ansible.cfg

[defaults]
#verbosity = 1
stdout_callback = community.general.yaml

実行結果

...

TASK [debug] *********************************************************************************************************************************************************************************
ok: [localhost] => 
  text: |-
    foo
    bar
    baz

TASK [debug] *********************************************************************************************************************************************************************************
ok: [localhost] => 
  msg: |-
    foo
    bar
    baz

...

改行されて出力された。
YAML表示の中のため、インデントされている。
|-の為、最後に改行コードが1つ以上存在してもそれらは出力されない。

ソリューション2: stdout_callback = ansible.posix.debugの利用

個人的にはこちらをよく使っている。

$ ansible-galaxy collection install ansible.posix
...

ansible.cfg

[defaults]
#verbosity = 1
stdout_callback = ansible.posix.debug

出力例

TASK [debug] *********************************************************************************************************************************************************************************
ok: [localhost] => {
    "text": "foo\nbar\nbaz\n"
}

TASK [debug] *********************************************************************************************************************************************************************************
ok: [localhost] => {}

MSG:

foo
bar
baz


...

var=の場合、改行コードは\nとして表示
msg=の場合、改行コードは改行され、インデントなし、最後の改行コードも省略されない。