1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
# -*- coding: utf-8 -*-
# Copyright: Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import annotations
DOCUMENTATION = r"""
---
author: Ansible Core Team (@ansible)
module: import_playbook
short_description: Import a playbook
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.
version_added: "2.4"
options:
free-form:
description:
- The name of the imported playbook is specified directly without any other option.
extends_documentation_fragment:
- action_common_attributes
- action_common_attributes.conn
- action_common_attributes.flow
- action_core
- action_core.import
attributes:
check_mode:
support: full
diff_mode:
support: none
platform:
platforms: all
notes:
- This is a core feature of Ansible, rather than a module, and cannot be overridden like a module.
seealso:
- module: ansible.builtin.import_role
- module: ansible.builtin.import_tasks
- module: ansible.builtin.include_role
- module: ansible.builtin.include_tasks
- ref: playbooks_reuse
description: More information related to including and importing playbooks, roles and tasks.
"""
EXAMPLES = r"""
- 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
"""
RETURN = r"""
# This module does not return anything except plays to execute.
"""
|
