name - play やタスクに名前を付ける

 説明

•  play やタスクに名前を付ける

 名前の既定値

•  play 名
•  targets セクションの hosts: に指定した host-pattern
• タスク名
• タスクを構成するモジュールの名前

 構文

• name: comment

 例

■ inventory ファイル : hosts.yml

centos:
  hosts:
    node1: 

■ name: なし

centos:
---
- hosts: all
  gather_facts: no

  tasks:   
    - debug:
        var: inventory_hostname

実行結果　→　play 名、タスク名ともに既定値を表示

[ansibleman@ansiblesv ansible]$ ansible-playbook -i hosts.yml site.yml
 
PLAY [all] *****************************************************************************************
 
TASK [debug] ***************************************************************************************
ok: [node1] => {
    "inventory_hostname": "node1"
}
 
PLAY RECAP *****************************************************************************************
node1                      : ok=1    changed=0    unreachable=0    failed=0   
 
[ansibleman@ansiblesv ansible]$ 

■ name: を使用して play 名とタスク名を設定

centos:
---
- name: inventory ファイルの対象ホスト名を表示する play
  hosts: all
  gather_facts: no

  tasks:
    - name: 対象ホスト名を表示
      debug:
        var: inventory_hostname

実行結果　→　設定した名前を表示

[ansibleman@ansiblesv ansible]$ ansible-playbook -i hosts.yml site.yml
 
PLAY [inventory ファイルの対象ホスト名を表示する play] *************************************************************
 
TASK [対象ホスト名を表示] ***********************************************************************************
ok: [node1] => {
    "inventory_hostname": "node1"
}
 
PLAY RECAP *****************************************************************************************
node1                      : ok=1    changed=0    unreachable=0    failed=0   
 
[ansibleman@ansiblesv ansible]$

 まとめ

•  name: で指定する名前には日本語が使用できるため、日本語で記述したほうがわかりやすい
• 実行時に name: で指定した名前（コメント）が表示されるため、どの play / タスクまで実行されたのか識別しやすい