ansible.builtin.import_playbook (v2.16.5) — module

Import a playbook

| "added in version" 2.4 of ansible.builtin"

Authors: Ansible Core Team (@ansible)

Install Ansible via pip

Install with pip install ansible-core==2.16.5

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- hosts: localhost
  tasks:
    - ansible.builtin.debug:
        msg: play1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Include a play after another play
  ansible.builtin.import_playbook: otherplays.yaml
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Set variables on an imported playbook
  ansible.builtin.import_playbook: otherplays.yml
  vars:
    service: httpd
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Include a playbook from a collection
  ansible.builtin.import_playbook: my_namespace.my_collection.my_playbook
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
free-form:
    description:
    - The name of the imported playbook is specified directly without any other option.

See also