Skip to content

import_playbook

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin
Added in version 2.4.

Synopsis

  • Includes a file with a list of plays to be executed.
  • Files with a list of plays can only be included at the top level.
  • You cannot use this action inside a play.

Parameters

Parameter Defaults / Choices Comments
free-form The name of the imported playbook is specified directly without any other option.

Notes

Note

  • This is a core feature of Ansible, rather than a module, and cannot be overridden like a module.

Examples

- hosts: localhost
  tasks:
    - ansible.builtin.debug:
        msg: play1

- name: Include a play after another play
  ansible.builtin.import_playbook: otherplays.yaml

- name: Set variables on an imported playbook
  ansible.builtin.import_playbook: otherplays.yml
  vars:
    service: httpd

- name: Include a playbook from a collection
  ansible.builtin.import_playbook: my_namespace.my_collection.my_playbook

- name: This DOES NOT WORK
  hosts: all
  tasks:
    - ansible.builtin.debug:
        msg: task1

    - name: This fails because I'm inside a play already
      ansible.builtin.import_playbook: stuff.yaml

Authors

  • Ansible Core Team (@ansible)