community.general.diy (8.5.0) — callback

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Callback plugin that allows you to supply your own custom callback templates to be output.

Requirements

• set as stdout_callback in configuration

Inputs

    
on_any_msg:
    description: Output to be used for callback on_any.
    env:
    - name: ANSIBLE_CALLBACK_DIY_ON_ANY_MSG
    ini:
    - key: on_any_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_on_any_msg

display_ok_hosts:
    default: true
    description: Toggle to control displaying 'ok' task/host results in a task
    env:
    - name: ANSIBLE_DISPLAY_OK_HOSTS
    ini:
    - key: display_ok_hosts
      section: defaults
    name: Show 'ok' hosts
    type: bool
    version_added: '2.7'
    version_added_collection: ansible.builtin

on_any_msg_color:
    description:
    - Output color to be used for O(on_any_msg).
    - Template should render a L(valid color value,#notes).
    env:
    - name: ANSIBLE_CALLBACK_DIY_ON_ANY_MSG_COLOR
    ini:
    - key: on_any_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_on_any_msg_color

on_file_diff_msg:
    description: Output to be used for callback on_file_diff.
    env:
    - name: ANSIBLE_CALLBACK_DIY_ON_FILE_DIFF_MSG
    ini:
    - key: on_file_diff_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_on_file_diff_msg

runner_on_ok_msg:
    description: Output to be used for callback runner_on_ok.
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_OK_MSG
    ini:
    - key: runner_on_ok_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_ok_msg

runner_retry_msg:
    description: Output to be used for callback runner_retry.
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_RETRY_MSG
    ini:
    - key: runner_retry_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_retry_msg

show_custom_stats:
    default: false
    description: This adds the custom stats set via the set_stats plugin to the play recap
    env:
    - name: ANSIBLE_SHOW_CUSTOM_STATS
    ini:
    - key: show_custom_stats
      section: defaults
    name: Show custom stats
    type: bool

check_mode_markers:
    default: false
    description:
    - Toggle to control displaying markers when running in check mode.
    - The markers are C(DRY RUN) at the beginning and ending of playbook execution (when
      calling C(ansible-playbook --check)) and C(CHECK MODE) as a suffix at every play
      and task that is run in check mode.
    env:
    - name: ANSIBLE_CHECK_MODE_MARKERS
    ini:
    - key: check_mode_markers
      section: defaults
    name: Show markers when running in check mode
    type: bool
    version_added: '2.9'
    version_added_collection: ansible.builtin

runner_on_start_msg:
    description: Output to be used for callback runner_on_start.
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_START_MSG
    ini:
    - key: runner_on_start_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_start_msg

show_per_host_start:
    default: false
    description: This adds output that shows when a task is started to execute for each
      host
    env:
    - name: ANSIBLE_SHOW_PER_HOST_START
    ini:
    - key: show_per_host_start
      section: defaults
    name: Show per host task start
    type: bool
    version_added: '2.9'
    version_added_collection: ansible.builtin

runner_on_failed_msg:
    description: Output to be used for callback runner_on_failed.
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_FAILED_MSG
    ini:
    - key: runner_on_failed_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_failed_msg

display_failed_stderr:
    default: false
    description: Toggle to control whether failed and unreachable tasks are displayed
      to STDERR (vs. STDOUT)
    env:
    - name: ANSIBLE_DISPLAY_FAILED_STDERR
    ini:
    - key: display_failed_stderr
      section: defaults
    name: Use STDERR for failed and unreachable tasks
    type: bool
    version_added: '2.7'
    version_added_collection: ansible.builtin

display_skipped_hosts:
    default: true
    description: Toggle to control displaying skipped task/host results in a task
    env:
    - name: ANSIBLE_DISPLAY_SKIPPED_HOSTS
    ini:
    - key: display_skipped_hosts
      section: defaults
    name: Show skipped hosts
    type: bool

playbook_on_setup_msg:
    description: Output to be used for callback playbook_on_setup.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_SETUP_MSG
    ini:
    - key: playbook_on_setup_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_setup_msg

playbook_on_start_msg:
    description: Output to be used for callback playbook_on_start.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_START_MSG
    ini:
    - key: playbook_on_start_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_start_msg

playbook_on_stats_msg:
    description: Output to be used for callback playbook_on_stats.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_STATS_MSG
    ini:
    - key: playbook_on_stats_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_stats_msg

runner_item_on_ok_msg:
    description: Output to be used for callback runner_item_on_ok.
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_OK_MSG
    ini:
    - key: runner_item_on_ok_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_item_on_ok_msg

runner_on_skipped_msg:
    description: Output to be used for callback runner_on_skipped.
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_SKIPPED_MSG
    ini:
    - key: runner_on_skipped_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_skipped_msg

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_ON_FILE_DIFF_MSG_COLOR
    ini:
    - key: on_file_diff_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_on_file_diff_msg_color

playbook_on_notify_msg:
    description: Output to be used for callback playbook_on_notify.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NOTIFY_MSG
    ini:
    - key: playbook_on_notify_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_notify_msg

runner_on_no_hosts_msg:
    description: Output to be used for callback runner_on_no_hosts.
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_NO_HOSTS_MSG
    ini:
    - key: runner_on_no_hosts_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_no_hosts_msg

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_OK_MSG_COLOR
    ini:
    - key: runner_on_ok_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_ok_msg_color

runner_retry_msg_color:
    description:
    - Output color to be used for O(runner_retry_msg).
    - Template should render a L(valid color value,#notes).
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_RETRY_MSG_COLOR
    ini:
    - key: runner_retry_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_retry_msg_color

playbook_on_include_msg:
    description: Output to be used for callback playbook_on_include.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_INCLUDE_MSG
    ini:
    - key: playbook_on_include_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_include_msg

runner_item_on_failed_msg:
    description: Output to be used for callback runner_item_on_failed.
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_FAILED_MSG
    ini:
    - key: runner_item_on_failed_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_item_on_failed_msg

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_START_MSG_COLOR
    ini:
    - key: runner_on_start_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_start_msg_color

runner_on_unreachable_msg:
    description: Output to be used for callback runner_on_unreachable.
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_UNREACHABLE_MSG
    ini:
    - key: runner_on_unreachable_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_unreachable_msg

show_task_path_on_failure:
    default: false
    description: When a task fails, display the path to the file containing the failed
      task and the line number. This information is displayed automatically for every
      task when running with C(-vv) or greater verbosity.
    env:
    - name: ANSIBLE_SHOW_TASK_PATH_ON_FAILURE
    ini:
    - key: show_task_path_on_failure
      section: defaults
    name: Show file path on failed tasks
    type: bool
    version_added: '2.11'
    version_added_collection: ansible.builtin

playbook_on_play_start_msg:
    description: Output to be used for callback playbook_on_play_start.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_PLAY_START_MSG
    ini:
    - key: playbook_on_play_start_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_play_start_msg

playbook_on_task_start_msg:
    description: Output to be used for callback playbook_on_task_start.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_TASK_START_MSG
    ini:
    - key: playbook_on_task_start_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_task_start_msg

runner_item_on_skipped_msg:
    description: Output to be used for callback runner_item_on_skipped.
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_SKIPPED_MSG
    ini:
    - key: runner_item_on_skipped_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_item_on_skipped_msg

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_FAILED_MSG_COLOR
    ini:
    - key: runner_on_failed_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_failed_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_SETUP_MSG_COLOR
    ini:
    - key: playbook_on_setup_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_setup_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_START_MSG_COLOR
    ini:
    - key: playbook_on_start_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_start_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_STATS_MSG_COLOR
    ini:
    - key: playbook_on_stats_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_stats_msg_color

playbook_on_vars_prompt_msg:
    description: Output to be used for callback playbook_on_vars_prompt.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_VARS_PROMPT_MSG
    ini:
    - key: playbook_on_vars_prompt_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_vars_prompt_msg

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_OK_MSG_COLOR
    ini:
    - key: runner_item_on_ok_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_item_on_ok_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_SKIPPED_MSG_COLOR
    ini:
    - key: runner_on_skipped_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_skipped_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NOTIFY_MSG_COLOR
    ini:
    - key: playbook_on_notify_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_notify_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_NO_HOSTS_MSG_COLOR
    ini:
    - key: runner_on_no_hosts_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_no_hosts_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_INCLUDE_MSG_COLOR
    ini:
    - key: playbook_on_include_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_include_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_FAILED_MSG_COLOR
    ini:
    - key: runner_item_on_failed_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_item_on_failed_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ON_UNREACHABLE_MSG_COLOR
    ini:
    - key: runner_on_unreachable_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_on_unreachable_msg_color

playbook_on_no_hosts_matched_msg:
    description: Output to be used for callback playbook_on_no_hosts_matched.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_MATCHED_MSG
    ini:
    - key: playbook_on_no_hosts_matched_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_no_hosts_matched_msg

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_PLAY_START_MSG_COLOR
    ini:
    - key: playbook_on_play_start_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_play_start_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_TASK_START_MSG_COLOR
    ini:
    - key: playbook_on_task_start_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_task_start_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_RUNNER_ITEM_ON_SKIPPED_MSG_COLOR
    ini:
    - key: runner_item_on_skipped_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_runner_item_on_skipped_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_VARS_PROMPT_MSG_COLOR
    ini:
    - key: playbook_on_vars_prompt_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_vars_prompt_msg_color

playbook_on_handler_task_start_msg:
    description: Output to be used for callback playbook_on_handler_task_start.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_HANDLER_TASK_START_MSG
    ini:
    - key: playbook_on_handler_task_start_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_handler_task_start_msg

playbook_on_no_hosts_remaining_msg:
    description: Output to be used for callback playbook_on_no_hosts_remaining.
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_REMAINING_MSG
    ini:
    - key: playbook_on_no_hosts_remaining_msg
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_no_hosts_remaining_msg

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_MATCHED_MSG_COLOR
    ini:
    - key: playbook_on_no_hosts_matched_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_no_hosts_matched_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_HANDLER_TASK_START_MSG_COLOR
    ini:
    - key: playbook_on_handler_task_start_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_handler_task_start_msg_color

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).
    env:
    - name: ANSIBLE_CALLBACK_DIY_PLAYBOOK_ON_NO_HOSTS_REMAINING_MSG_COLOR
    ini:
    - key: playbook_on_no_hosts_remaining_msg_color
      section: callback_diy
    type: str
    vars:
    - name: ansible_callback_diy_playbook_on_no_hosts_remaining_msg_color

See also

• default – default Ansible screen output: The official documentation on the B(default) callback plugin. link