VhddlmZdZdZddlZddlmZddlmZddl m Z ddl m Z dd lmZ dd lmZd ZGd deZGdde Z y#e$rd ZY wxYw)) annotationsuL name: diy type: stdout short_description: Customize the output version_added: 0.2.0 description: - Callback plugin that allows you to supply your own custom callback templates to be output. author: Trevor Highfill (@theque5t) extends_documentation_fragment: - default_callback notes: - Uses the P(ansible.builtin.default#callback) callback plugin output when a custom callback V(message(msg\)) is not provided. - Makes the callback event data available using the C(ansible_callback_diy) dictionary, which can be used in the templating context for the options. The dictionary is only available in the templating context for the options. It is not a variable that is available using the other various execution contexts, such as playbook, play, task, and so on so forth. - Options being set by their respective variable input can only be set using the variable if the variable was set in a context that is available to the respective callback. Use the C(ansible_callback_diy) dictionary to see what is available to a callback. Additionally, C(ansible_callback_diy.top_level_var_names) will output the top level variable names available to the callback. - Each option value is rendered as a template before being evaluated. This allows for the dynamic usage of an option. For example, C("{{ 'yellow' if ansible_callback_diy.result.is_changed else 'bright green' }}"). - 'B(Condition) for all C(msg) options: if value C(is None or omit), then the option is not being used. B(Effect): use of the C(default) callback plugin for output.' - 'B(Condition) for all C(msg) options: if value C(is not None and not omit and length is not greater than 0), then the option is being used without output. B(Effect): suppress output.' - 'B(Condition) for all C(msg) options: if value C(is not None and not omit and length is greater than 0), then the option is being used with output. B(Effect): render value as template and output.' - 'Valid color values: V(black), V(bright gray), V(blue), V(white), V(green), V(bright blue), V(cyan), V(bright green), V(red), V(bright cyan), V(purple), V(bright red), V(yellow), V(bright purple), V(dark gray), V(bright yellow), V(magenta), V(bright magenta), V(normal).' seealso: - name: default – default Ansible screen output description: The official documentation on the B(default) callback plugin. link: https://docs.ansible.com/ansible/latest/plugins/callback/default.html requirements: - set as stdout_callback in configuration options: on_any_msg: description: Output to be used for callback on_any. ini: - section: callback_diy key: on_any_msg env: - name: ANSIBLE_CALLBACK_DIY_ON_ANY_MSG vars: - name: ansible_callback_diy_on_any_msg type: str on_any_msg_color: description: - Output color to be used for O(on_any_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: on_any_msg_color env: - name: ANSIBLE_CALLBACK_DIY_ON_ANY_MSG_COLOR vars: - name: ansible_callback_diy_on_any_msg_color type: str runner_on_failed_msg: description: Output to be used for callback runner_on_failed. ini: - section: callback_diy key: runner_on_failed_msg env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_FAILED_MSG vars: - name: ansible_callback_diy_runner_on_failed_msg type: str runner_on_failed_msg_color: description: - Output color to be used for O(runner_on_failed_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: runner_on_failed_msg_color env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_FAILED_MSG_COLOR vars: - name: ansible_callback_diy_runner_on_failed_msg_color type: str runner_on_ok_msg: description: Output to be used for callback runner_on_ok. ini: - section: callback_diy key: runner_on_ok_msg env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_OK_MSG vars: - name: ansible_callback_diy_runner_on_ok_msg type: str runner_on_ok_msg_color: description: - Output color to be used for O(runner_on_ok_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: runner_on_ok_msg_color env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_OK_MSG_COLOR vars: - name: ansible_callback_diy_runner_on_ok_msg_color type: str runner_on_skipped_msg: description: Output to be used for callback runner_on_skipped. ini: - section: callback_diy key: runner_on_skipped_msg env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_SKIPPED_MSG vars: - name: ansible_callback_diy_runner_on_skipped_msg type: str runner_on_skipped_msg_color: description: - Output color to be used for O(runner_on_skipped_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: runner_on_skipped_msg_color env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_SKIPPED_MSG_COLOR vars: - name: ansible_callback_diy_runner_on_skipped_msg_color type: str runner_on_unreachable_msg: description: Output to be used for callback runner_on_unreachable. ini: - section: callback_diy key: runner_on_unreachable_msg env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_UNREACHABLE_MSG vars: - name: ansible_callback_diy_runner_on_unreachable_msg type: str runner_on_unreachable_msg_color: description: - Output color to be used for O(runner_on_unreachable_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: runner_on_unreachable_msg_color env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_UNREACHABLE_MSG_COLOR vars: - name: ansible_callback_diy_runner_on_unreachable_msg_color type: str playbook_on_start_msg: description: Output to be used for callback playbook_on_start. ini: - section: callback_diy key: playbook_on_start_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_START_MSG vars: - name: ansible_callback_diy_playbook_on_start_msg type: str playbook_on_start_msg_color: description: - Output color to be used for O(playbook_on_start_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_start_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_START_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_start_msg_color type: str playbook_on_notify_msg: description: Output to be used for callback playbook_on_notify. ini: - section: callback_diy key: playbook_on_notify_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NOTIFY_MSG vars: - name: ansible_callback_diy_playbook_on_notify_msg type: str playbook_on_notify_msg_color: description: - Output color to be used for O(playbook_on_notify_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_notify_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NOTIFY_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_notify_msg_color type: str playbook_on_no_hosts_matched_msg: description: Output to be used for callback playbook_on_no_hosts_matched. ini: - section: callback_diy key: playbook_on_no_hosts_matched_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_MATCHED_MSG vars: - name: ansible_callback_diy_playbook_on_no_hosts_matched_msg type: str playbook_on_no_hosts_matched_msg_color: description: - Output color to be used for O(playbook_on_no_hosts_matched_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_no_hosts_matched_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_MATCHED_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_no_hosts_matched_msg_color type: str playbook_on_no_hosts_remaining_msg: description: Output to be used for callback playbook_on_no_hosts_remaining. ini: - section: callback_diy key: playbook_on_no_hosts_remaining_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_REMAINING_MSG vars: - name: ansible_callback_diy_playbook_on_no_hosts_remaining_msg type: str playbook_on_no_hosts_remaining_msg_color: description: - Output color to be used for O(playbook_on_no_hosts_remaining_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_no_hosts_remaining_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_REMAINING_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_no_hosts_remaining_msg_color type: str playbook_on_task_start_msg: description: Output to be used for callback playbook_on_task_start. ini: - section: callback_diy key: playbook_on_task_start_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_TASK_START_MSG vars: - name: ansible_callback_diy_playbook_on_task_start_msg type: str playbook_on_task_start_msg_color: description: - Output color to be used for O(playbook_on_task_start_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_task_start_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_TASK_START_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_task_start_msg_color type: str playbook_on_handler_task_start_msg: description: Output to be used for callback playbook_on_handler_task_start. ini: - section: callback_diy key: playbook_on_handler_task_start_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_HANDLER_TASK_START_MSG vars: - name: ansible_callback_diy_playbook_on_handler_task_start_msg type: str playbook_on_handler_task_start_msg_color: description: - Output color to be used for O(playbook_on_handler_task_start_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_handler_task_start_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_HANDLER_TASK_START_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_handler_task_start_msg_color type: str playbook_on_vars_prompt_msg: description: Output to be used for callback playbook_on_vars_prompt. ini: - section: callback_diy key: playbook_on_vars_prompt_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_VARS_PROMPT_MSG vars: - name: ansible_callback_diy_playbook_on_vars_prompt_msg type: str playbook_on_vars_prompt_msg_color: description: - Output color to be used for O(playbook_on_vars_prompt_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_vars_prompt_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_VARS_PROMPT_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_vars_prompt_msg_color type: str playbook_on_play_start_msg: description: Output to be used for callback playbook_on_play_start. ini: - section: callback_diy key: playbook_on_play_start_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_PLAY_START_MSG vars: - name: ansible_callback_diy_playbook_on_play_start_msg type: str playbook_on_play_start_msg_color: description: - Output color to be used for O(playbook_on_play_start_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_play_start_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_PLAY_START_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_play_start_msg_color type: str playbook_on_stats_msg: description: Output to be used for callback playbook_on_stats. ini: - section: callback_diy key: playbook_on_stats_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_STATS_MSG vars: - name: ansible_callback_diy_playbook_on_stats_msg type: str playbook_on_stats_msg_color: description: - Output color to be used for O(playbook_on_stats_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_stats_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_STATS_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_stats_msg_color type: str on_file_diff_msg: description: Output to be used for callback on_file_diff. ini: - section: callback_diy key: on_file_diff_msg env: - name: ANSIBLE_CALLBACK_DIY_ON_FILE_DIFF_MSG vars: - name: ansible_callback_diy_on_file_diff_msg type: str on_file_diff_msg_color: description: - Output color to be used for O(on_file_diff_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: on_file_diff_msg_color env: - name: ANSIBLE_CALLBACK_DIY_ON_FILE_DIFF_MSG_COLOR vars: - name: ansible_callback_diy_on_file_diff_msg_color type: str playbook_on_include_msg: description: Output to be used for callback playbook_on_include. ini: - section: callback_diy key: playbook_on_include_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_INCLUDE_MSG vars: - name: ansible_callback_diy_playbook_on_include_msg type: str playbook_on_include_msg_color: description: - Output color to be used for O(playbook_on_include_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_include_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_INCLUDE_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_include_msg_color type: str runner_item_on_ok_msg: description: Output to be used for callback runner_item_on_ok. ini: - section: callback_diy key: runner_item_on_ok_msg env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_OK_MSG vars: - name: ansible_callback_diy_runner_item_on_ok_msg type: str runner_item_on_ok_msg_color: description: - Output color to be used for O(runner_item_on_ok_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: runner_item_on_ok_msg_color env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_OK_MSG_COLOR vars: - name: ansible_callback_diy_runner_item_on_ok_msg_color type: str runner_item_on_failed_msg: description: Output to be used for callback runner_item_on_failed. ini: - section: callback_diy key: runner_item_on_failed_msg env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_FAILED_MSG vars: - name: ansible_callback_diy_runner_item_on_failed_msg type: str runner_item_on_failed_msg_color: description: - Output color to be used for O(runner_item_on_failed_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: runner_item_on_failed_msg_color env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_FAILED_MSG_COLOR vars: - name: ansible_callback_diy_runner_item_on_failed_msg_color type: str runner_item_on_skipped_msg: description: Output to be used for callback runner_item_on_skipped. ini: - section: callback_diy key: runner_item_on_skipped_msg env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_SKIPPED_MSG vars: - name: ansible_callback_diy_runner_item_on_skipped_msg type: str runner_item_on_skipped_msg_color: description: - Output color to be used for O(runner_item_on_skipped_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: runner_item_on_skipped_msg_color env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_SKIPPED_MSG_COLOR vars: - name: ansible_callback_diy_runner_item_on_skipped_msg_color type: str runner_retry_msg: description: Output to be used for callback runner_retry. ini: - section: callback_diy key: runner_retry_msg env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_RETRY_MSG vars: - name: ansible_callback_diy_runner_retry_msg type: str runner_retry_msg_color: description: - Output color to be used for O(runner_retry_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: runner_retry_msg_color env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_RETRY_MSG_COLOR vars: - name: ansible_callback_diy_runner_retry_msg_color type: str runner_on_start_msg: description: Output to be used for callback runner_on_start. ini: - section: callback_diy key: runner_on_start_msg env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_START_MSG vars: - name: ansible_callback_diy_runner_on_start_msg type: str runner_on_start_msg_color: description: - Output color to be used for O(runner_on_start_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: runner_on_start_msg_color env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_START_MSG_COLOR vars: - name: ansible_callback_diy_runner_on_start_msg_color type: str runner_on_no_hosts_msg: description: Output to be used for callback runner_on_no_hosts. ini: - section: callback_diy key: runner_on_no_hosts_msg env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_NO_HOSTS_MSG vars: - name: ansible_callback_diy_runner_on_no_hosts_msg type: str runner_on_no_hosts_msg_color: description: - Output color to be used for O(runner_on_no_hosts_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: runner_on_no_hosts_msg_color env: - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_NO_HOSTS_MSG_COLOR vars: - name: ansible_callback_diy_runner_on_no_hosts_msg_color type: str playbook_on_setup_msg: description: Output to be used for callback playbook_on_setup. ini: - section: callback_diy key: playbook_on_setup_msg env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_SETUP_MSG vars: - name: ansible_callback_diy_playbook_on_setup_msg type: str playbook_on_setup_msg_color: description: - Output color to be used for O(playbook_on_setup_msg). - Template should render a L(valid color value,#notes). ini: - section: callback_diy key: playbook_on_setup_msg_color env: - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_SETUP_MSG_COLOR vars: - name: ansible_callback_diy_playbook_on_setup_msg_color type: str a ansible.cfg: > # Enable plugin [defaults] stdout_callback=community.general.diy [callback_diy] # Output when playbook starts playbook_on_start_msg="DIY output(via ansible.cfg): playbook example: {{ ansible_callback_diy.playbook.file_name }}" playbook_on_start_msg_color=yellow # Comment out to allow default plugin output # playbook_on_play_start_msg="PLAY: starting play {{ ansible_callback_diy.play.name }}" # Accept on_skipped_msg or ansible_callback_diy_runner_on_skipped_msg as input vars # If neither are supplied, omit the option runner_on_skipped_msg="{{ on_skipped_msg | default(ansible_callback_diy_runner_on_skipped_msg) | default(omit) }}" # Newline after every callback # on_any_msg='{{ " " | join("\n") }}' playbook.yml: >- --- - name: "Default plugin output: play example" hosts: localhost gather_facts: false tasks: - name: Default plugin output ansible.builtin.debug: msg: default plugin output - name: Override from play vars hosts: localhost gather_facts: false vars: ansible_connection: local green: "\e[0m\e[38;5;82m" yellow: "\e[0m\e[38;5;11m" bright_purple: "\e[0m\e[38;5;105m" cyan: "\e[0m\e[38;5;51m" green_bg_black_fg: "\e[0m\e[48;5;40m\e[38;5;232m" yellow_bg_black_fg: "\e[0m\e[48;5;226m\e[38;5;232m" purple_bg_white_fg: "\e[0m\e[48;5;57m\e[38;5;255m" cyan_bg_black_fg: "\e[0m\e[48;5;87m\e[38;5;232m" magenta: "\e[38;5;198m" white: "\e[0m\e[38;5;255m" ansible_callback_diy_playbook_on_play_start_msg: "\n{{green}}DIY output(via play vars): play example: {{magenta}}{{ansible_callback_diy.play.name}}\n\n" ansible_callback_diy_playbook_on_task_start_msg: "DIY output(via play vars): task example: {{ ansible_callback_diy.task.name }}" ansible_callback_diy_playbook_on_task_start_msg_color: cyan ansible_callback_diy_playbook_on_stats_msg: |+2 CUSTOM STATS ============================== {% for key in ansible_callback_diy.stats | sort %} {% if ansible_callback_diy.stats[key] %} {% if key == 'ok' %} {% set color_one = lookup('vars','green_bg_black_fg') %} {% set prefix = ' ' %} {% set suffix = ' ' %} {% set color_two = lookup('vars','green') %} {% elif key == 'changed' %} {% set color_one = lookup('vars','yellow_bg_black_fg') %} {% set prefix = ' ' %} {% set suffix = ' ' %} {% set color_two = lookup('vars','yellow') %} {% elif key == 'processed' %} {% set color_one = lookup('vars','purple_bg_white_fg') %} {% set prefix = ' ' %} {% set suffix = ' ' %} {% set color_two = lookup('vars','bright_purple') %} {% elif key == 'skipped' %} {% set color_one = lookup('vars','cyan_bg_black_fg') %} {% set prefix = ' ' %} {% set suffix = ' ' %} {% set color_two = lookup('vars','cyan') %} {% else %} {% set color_one = "" %} {% set prefix = "" %} {% set suffix = "" %} {% set color_two = "" %} {% endif %} {{ color_one }}{{ "%s%s%s" | format(prefix,key,suffix) }}{{ color_two }}: {{ ansible_callback_diy.stats[key] | to_nice_yaml }} {% endif %} {% endfor %} tasks: - name: Custom banner with default plugin result output ansible.builtin.debug: msg: "default plugin output: result example" - name: Override from task vars ansible.builtin.debug: msg: "example {{ two }}" changed_when: true vars: white_fg_red_bg: "\e[0m\e[48;5;1m" two: "{{ white_fg_red_bg }} 2 " ansible_callback_diy_playbook_on_task_start_msg: "\nDIY output(via task vars): task example: {{ ansible_callback_diy.task.name }}" ansible_callback_diy_playbook_on_task_start_msg_color: bright magenta ansible_callback_diy_runner_on_ok_msg: "DIY output(via task vars): result example: \n{{ ansible_callback_diy.result.output.msg }}\n" ansible_callback_diy_runner_on_ok_msg_color: "{{ 'yellow' if ansible_callback_diy.result.is_changed else 'bright green' }}" - name: Suppress output ansible.builtin.debug: msg: i should not be displayed vars: ansible_callback_diy_playbook_on_task_start_msg: "" ansible_callback_diy_runner_on_ok_msg: "" - name: Using alias vars (see ansible.cfg) ansible.builtin.debug: msg: when: false vars: ansible_callback_diy_playbook_on_task_start_msg: "" on_skipped_msg: "DIY output(via task vars): skipped example:\n\e[0m\e[38;5;4m\u25b6\u25b6 {{ ansible_callback_diy.result.task.name }}\n" on_skipped_msg_color: white - name: Just stdout ansible.builtin.command: echo some stdout vars: ansible_callback_diy_playbook_on_task_start_msg: "\n" ansible_callback_diy_runner_on_ok_msg: "{{ ansible_callback_diy.result.output.stdout }}\n" - name: Multiline output ansible.builtin.debug: msg: "{{ multiline }}" vars: ansible_callback_diy_playbook_on_task_start_msg: "\nDIY output(via task vars): task example: {{ ansible_callback_diy.task.name }}" multiline: "line\nline\nline" ansible_callback_diy_runner_on_ok_msg: |+2 some {{ ansible_callback_diy.result.output.msg }} output ansible_callback_diy_playbook_on_task_start_msg_color: bright blue - name: Indentation ansible.builtin.debug: msg: "{{ item.msg }}" with_items: - { indent: 1, msg: one., color: red } - { indent: 2, msg: two.., color: yellow } - { indent: 3, msg: three..., color: bright yellow } vars: ansible_callback_diy_runner_item_on_ok_msg: "{{ ansible_callback_diy.result.output.msg | indent(item.indent, True) }}" ansible_callback_diy_runner_item_on_ok_msg_color: "{{ item.color }}" ansible_callback_diy_runner_on_ok_msg: "GO!!!" ansible_callback_diy_runner_on_ok_msg_color: bright green - name: Using lookup and template as file ansible.builtin.shell: "echo {% raw %}'output from {{ file_name }}'{% endraw %} > {{ file_name }}" vars: ansible_callback_diy_playbook_on_task_start_msg: "\nDIY output(via task vars): task example: {{ ansible_callback_diy.task.name }}" file_name: diy_file_template_example ansible_callback_diy_runner_on_ok_msg: "{{ lookup('template', file_name) }}" - name: 'Look at top level vars available to the "runner_on_ok" callback' ansible.builtin.debug: msg: '' vars: ansible_callback_diy_playbook_on_task_start_msg: "\nDIY output(via task vars): task example: {{ ansible_callback_diy.task.name }}" ansible_callback_diy_runner_on_ok_msg: |+2 {% for var in (ansible_callback_diy.top_level_var_names|reject('match','vars|ansible_callback_diy.*')) | sort %} {{ green }}{{ var }}: {{ white }}{{ lookup('vars', var) }} {% endfor %} ansible_callback_diy_runner_on_ok_msg_color: white - name: 'Look at event data available to the "runner_on_ok" callback' ansible.builtin.debug: msg: '' vars: ansible_callback_diy_playbook_on_task_start_msg: "\nDIY output(via task vars): task example: {{ ansible_callback_diy.task.name }}" ansible_callback_diy_runner_on_ok_msg: |+2 {% for key in ansible_callback_diy | sort %} {{ green }}{{ key }}: {{ white }}{{ ansible_callback_diy[key] }} {% endfor %} N)contextmanager)Templar)VariableManager)CallbackModule)to_text)trust_as_templateTFceZdZdZdZdZy) DummyStdoutcyN)selfs j/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/callback/diy.pyflushzDummyStdout.flush cyr r)rbs rwritezDummyStdout.writerrcyr r)rls r writelineszDummyStdout.writelines"rrN)__name__ __module__ __qualname__rrrrrrr r s   rr cheZdZdZdZdZdZdZedZ dZ dZ fd Z d Z d(d Z d)d Zfd Zd(fd ZfdZfdZfdZdZdZdZfdZfdZfdZfdZfdZfdZfdZfdZfdZ fdZ!dZ"fd Z# d*fd! Z$d"Z%d#Z&fd$Z'fd%Z(fd&Z)fd'Z*xZ+S)+rzd Callback plugin that allows you to supply your own custom callback templates to be output. g@stdoutzcommunity.general.diyansible_callback_diyc#tKtj}|rtt_d|t_ywr )sysrr )renabled saved_stdouts r_suppress_stdoutzCallbackModule._suppress_stdout0s%zz $CJ ! s68c ni}tjdjj}|dddk(r|ddn|}ddg}|D]^}|d|}|j |j d||j |} |j||j|| |i`|jd|i|S) Nv2_msg msg_color_)loadertemplate variablesvars) r! _getframef_codeco_namegetDIY_NS get_optionupdate _template) rr,r._ret_calling_method_callback_type_callback_optionsoption _option_name_option_templates r_get_output_specificationz(CallbackModule._get_output_specification8s--*11991@!1D1M/!"-Sb"K0' F,-Qvh7L(}};;-q/ -   KK)#"0"   VY'( rcnt}|djd|}|dduxr|d|k7xs||uS)Nr/omitr))objectr3)rspecsentinelrAs r _using_diyzCallbackModule._using_diyNsF8F|1U 4'Vd5kT.A.UTXEUVrcttt|tjdj j S)Nr&)hasattrsuperrr!r0r1r2r __class__s r_parent_has_callbackz#CallbackModule._parent_has_callbackTs,u^T2CMM!4D4K4K4S4STTrcFt||}|j|dddS)Nr,r.TF)preserve_trailing_newlines convert_dataescape_backslashes)rr-)rr,r-r._templars rr7zCallbackModule._templateWs2&I>  '+# !  rct|d}t|dkDr"|jj||d|yy)Nr)rr*)r)colorstderr)rlen_displaydisplay)rrCrT_msgs r_outputzCallbackModule._output`s>tE{# t9q= MM ! !d${2CF ! S rc T d dfd} Gddt} i} t|j} | j}|r5|j j||r|n t |dd|r|n|}| j || j | j|j|jtrin| i| |jj diigd }|D]-}| |jdj ||| i/|rV| |jj d iigd }|D]-}| |jd j ||| i/|rV| |jj d iigd}|D]-}| |jd j ||| i/|rn| |jj diigd}|jr | r | ||}|D]-}| |jdj ||| i/|rV| |jj diigd}|D]-}| |jdj ||| i/|r| |jj diigd}|jr | r | ||}|D]-}| |jdj ||| i/| |jdj d|j|i|r| |jj diigd}|D]-}| |jdj ||| i/gd}|D]-}| |jdj |||i/| |jdj dt |ddi| j |j|rV| |jj diigd}|D]-}| |jdj ||| i/| |jj dt| ji| S)!Nc h|rt||t|d|dS|rt||}|Sy)Nr+)getattr)objattrmethod_methods r _get_valuez,CallbackModule._get_vars.._get_valuegs?sD'#4&z4*HII!#v.y rct|dd}|xsd}|D]2}t|t||vs"|j|4|S)N loop_controlitemr]r^)r\strremove)r] attributes _loop_varr^ras r_remove_attr_ref_loopz7CallbackModule._get_vars.._remove_attr_ref_looposX^T:I",fI" ,y>S$)G%HH%%d+ , rceZdZdZy)1CallbackModule._get_vars..CallbackDIYDictc|Sr r)rmemos r __deepcopy__z>CallbackModule._get_vars..CallbackDIYDict.__deepcopy__zs rN)rrrrorrrCallbackDIYDictrlys rrp)r,_host)playhosttaskplaybook)entries file_namebasedirrerr).any_errors_fatalbecome become_flags become_method become_user check_mode collections connectiondebuggerdiff environment fact_path finalizedforce_handlers gather_facts gather_subsetgather_timeouthandlershosts ignore_errorsignore_unreachableincluded_conditional included_pathmax_fail_percentagemodule_defaultsnameno_log only_tagsorderport post_tasks pre_tasks remote_user removed_hostsrolesrun_onceserial skip_tagssquashedstrategytagstasksuuid validated vars_files vars_promptrs)rraddressimplicitrt)-actionryargsasync async_valrzr{r|r} changed_whenr~rrrdelaydelegate_facts delegate_torr failed_whenrrrlooprc loop_withrrrnotifyparentpollrregisterrretriesrolerrruntaggeduntilrrwhen)r]rh included_file)rfilenameris_rolerthandler)/rryrrrrzr{r|r}rr~rrrrrrrrrrrrlistenrrcrrrrnotified_hostsrrrrrrrrrrrrrrrris_host_notifiedresult)rsrt task_name) is_changed is_failed is_skippedis_unreachable)r]r_output_resultstats) changedcustomdarkfailuresignoredok processedrescuedskippedtop_level_var_names)NN)dictr get_loaderget_varsget_variable_managerr\r6r3r4SUPPORTS_DATA_TAGGINGrrrlistkeys)rrurrrsrtrrrrremove_attr_ref_looprjrpr8_variable_manager_all_playbook_attributesr^_play_attributes_host_attributes_task_attributes_included_file_attributes_handler_attributes_result_attributes_result_methodsr__stats_attributesras @r _get_varszCallbackModule._get_varses !  d +83F3F3HI ))+ ,,.77"d(F!(gd8D D DHHT[[4;;>SYhYj*klm T[[  *b!12B( ^D  j ) 0 0$ xVZ8[1\ ] ^    $ $fb\ 2 J ) ZT[[!&)00$ tRV8W1XY Z    $ $fb\ 2F ( ZT[[!&)00$ tRV8W1XY Z    $ $fb\ 2 ( yy1#8TN^#_ ( ZT[[!&)00$ tRV8W1XY Z    $ $or%: ;(X %1 T[[!/2994%B;     $ $i_ 5 #+ || 4&;GZ'\#, `T[[!),33T:'X\;]4^_ `  i ( / /1CWE]E]^bEc0d e    $ $h^ 4!> * ^T[[!(+22D*VZ:[3\] ^ZO) dT[[!(+22FJ6Z`tTJ K K ' K K !DD c||_|jj|_|j|j|j |j|_|j |j r|j|j |jrI|j|j |j 5tt|3|dddyy#1swYyxYw)N)rurMrr) rrrr?rrrErYrKr$rHrv2_playbook_on_start)rrurJs rrz#CallbackModule.v2_playbook_on_starts%--88:77##nn++%8  ??? / LLdnnL -  $ $ &&&tDNN/S&T Knd@J K K ' K Ks C66C?c ||_||_|j|j|j |j |j |j|j|_|j|jr|j|j|jrJ|j|j|j5tt|;||dddyy#1swYyxYw)N)rurrrsrrMrr) _diy_handlerrr?rrrrrrErYrKr$rHrv2_playbook_on_notify)rrrsrJs rrz$CallbackModule.v2_playbook_on_notifys#77##nn++^^^^)) %8  ??? / LLdnnL -  $ $ &&&tDNN/S&T QndA'4P Q Q ' Q Qrc|j|j|jd|_|j|jr|j |j|j rH|j |j|j5tt|'dddyy#1swYyxYwr) r?rrrErYrKr$rHrv2_playbook_on_no_hosts_matchedrIs rrz.CallbackModule.v2_playbook_on_no_hosts_matcheds77##nnV,8  ??? / LLdnnL -  $ $ &&&tDNN/S&T NndKM N N ' N N %CC c|j|j|jd|_|j|jr|j |j|j rH|j |j|j5tt|'dddyy#1swYyxYwr) r?rrrErYrKr$rHr!v2_playbook_on_no_hosts_remainingrIs rr!z0CallbackModule.v2_playbook_on_no_hosts_remainings77##nnV,8  ??? / LLdnnL -  $ $ &&&tDNN/S&T PndMO P P ' P Prc||_|j|j|j|j|j |j|_|j|j r|j|j |jrJ|j|j|j 5tt|7||dddyy#1swYyxYwN)rurrrtrMrr)rr?rrrrrrErYrKr$rHrv2_playbook_on_task_start)rrtis_conditionalrJs rr$z(CallbackModule.v2_playbook_on_task_starts77##nn++^^^^%8  ??? / LLdnnL -  $ $ &&&tDNN/S&T \ndEdN[ \ \ ' \ \s C..C7cyr r)rrts r!v2_playbook_on_cleanup_task_startz0CallbackModule.v2_playbook_on_cleanup_task_startrrc||_|j|j|j|j|j |j|_|j|j r|j|j |jrI|j|j|j 5tt|7|dddyy#1swYyxYwr#)rr?rrrrrrErYrKr$rHr!v2_playbook_on_handler_task_start)rrtrJs rr)z0CallbackModule.v2_playbook_on_handler_task_starts77##nn++^^^^%8  ??? / LLdnnL -  $ $ &&&tDNN/S&T TndMdS T T ' T T C--C6c |j|j|jd|_|j|jr|j |j|j rQ|j |j|j5tt|'||||||||| dddyy#1swYyxYwr) r?rrrErYrKr$rHrv2_playbook_on_vars_prompt) rvarnameprivatepromptencryptconfirm salt_sizesaltdefaultunsaferJs rr,z)CallbackModule.v2_playbook_on_vars_prompt(s77##nnV,8  ??? / LLdnnL -  $ $ &&&tDNN/S&T ndFWfgYg   '  s %C  Ccyr r)rr imported_files rv2_playbook_on_import_for_hostz-CallbackModule.v2_playbook_on_import_for_host<rrcyr r)rr missing_files r"v2_playbook_on_not_import_for_hostz1CallbackModule.v2_playbook_on_not_import_for_host@rrc||_|j|j|j|j|j|_|j |j r|j|j |jrI|j|j |j 5tt|3|dddyy#1swYyxYw)N)rurrrMrr) rr?rrrrrErYrKr$rHrv2_playbook_on_play_start)rrrrJs rr=z(CallbackModule.v2_playbook_on_play_startCs77##nn++^^%8  ??? / LLdnnL -  $ $ &&&tDNN/S&T LndEdK L L ' L Ls C""C+c||_|j|j|j|j|j |j|_|j|j r|j|j |jrI|j|j|j 5tt|7|dddyy#1swYyxYw)N)rurrrrMrr) _diy_statsr?rrrrrrErYrKr$rHrv2_playbook_on_stats)rrrJs rr@z#CallbackModule.v2_playbook_on_statsUs77##nn++^^oo%8  ??? / LLdnnL -  $ $ &&&tDNN/S&T Hnd@G H H ' H Hr*c ||_|j|j|j|j|j |jj |j|_|j|jr|j|j|jrI|j|j|j5tt|;|dddyy#1swYyxYw)N)rurrrtrrMrr)_diy_included_filer?rrrr_taskrrErYrKr$rHrv2_playbook_on_include)rrrJs rrDz%CallbackModule.v2_playbook_on_includehs"/77##nn++^^,,22"55 %8  ??? / LLdnnL -  $ $ &&&tDNN/S&T RndB=Q R R ' R Rs $DD c |j|j|j|j|j|j ||_|j|j r|j|j |jrI|j|j|j 5tt|7|dddyy#1swYyxYwr)r?rrrrrrrErYrKr$rHrv2_on_file_diffrs rrFzCallbackModule.v2_on_file_diff|rr)F)NNNNNNNT)TNNFNNNN),rrr__doc__CALLBACK_VERSION CALLBACK_TYPE CALLBACK_NAMEr4rr$r?rErKr7rYrrrrrrrrr r rrrrrrrr!r$r'r)r,r8r;r=r@rDrF __classcell__)rJs@rrr&s M+M #F"",W U T RVNRUn GW$D$I$M&   I&M&N&D$K*K$Q* N P\( T&VZUY*.(  L$H&R(DDrr) __future__r DOCUMENTATIONEXAMPLESr! contextlibransible.templateransible.vars.managerr ansible.plugins.callback.defaultrDefault+ansible.module_utils.common.text.convertersrr r ImportErrorrBr rrrrVsq#L  \t l %$0F?"2   & f DWf D"!"sA AA