Documentation

import_playbook - import a playbook.

New 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.

Options

parameter required default choices comments
free-form
no
This action allows you to specify the name of the file directly w/o any other options.

Examples

- name: include a play after another play
  hosts: localhost
  tasks:
    - debug:
        msg: "play1"

- import_playbook: otherplays.yml


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

    - name: This failes because I'm inside a play already
      import_playbook: stuff.yml

Notes

Note

  • This is really not a module, this is a feature of the Ansible Engine, as such it cannot be overridden the same way a module can.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance Info

For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.