You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

import_playbook - Import a playbook¶

New in version 2.4.

Synopsis
Options
Examples
Notes
- Status
- Maintenance Info

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			The name of the imported playbook is specified directly without any other option.

Examples ¶

- hosts: localhost
  tasks:
    - debug:
        msg: play1

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


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

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

Notes ¶

Note

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

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.