New variable containing the name of the running playbook

[utoddl]

Proposal: create ansible_playbook_name variable

Author: Todd Lewis <@utoddl>

Date: 2019-08-07

• Status: New
• Proposal type: core
• Estimated time to implement: 5 minutes for the right person

Motivation

Trying to create messages pinpointing the relevant playbook is currently not possible. This should be simple, and useful for messages in shared roles, or templates for files containing comments about provenance, etc.

Problem

• In conjunction with playbook_dir, it would be possible to include the relevant playbook name in messages, template output, etc.

Solution proposal

• Create ansible_playbook_name at the same time as playbook_dir.

Dependencies (optional)

This would only be relevant when running playbooks. Not for ad hoc commands.

Documentation (optional)

Adding an entry to https://docs.ansible.com/ansible/latest/reference_appendices/special_variables.html

[sivel]

fwiw, a playbook doesn't have a name, but it does have a filename. I'd either be explicit and use filename in the variable, or just call it ansible_playbook.