Sys-ctl-hlth-msmtp Role¶
Description: No description available
Variables¶
author: Kevin Veen-Birkenbach
description: Periodic MTA health-check: sends test mail via msmtp and alerts on failure.
company: Kevin Veen-Birkenbach
Consulting & Coaching Solutions https://www.veen.world
license: Infinito.Nexus NonCommercial License
license_url: https://s.infinito.nexus/license
min_ansible_version: 2.9
platforms: [{‘name’: ‘Archlinux’, ‘versions’: [‘rolling’]}]
galaxy_tags: [‘monitor’, ‘msmtp’, ‘email’, ‘health’, ‘systemd’]
repository: https://s.infinito.nexus/code
documentation: https://docs.infinito.nexus
README¶
sys-ctl-hlth-msmtp¶
Description¶
This Ansible role sends periodic health check emails using msmtp to verify that your mail transport agent is operational. It deploys a simple script and hooks it into a systemd service and timer, with failure notifications sent via Telegram.
Overview¶
Optimized for Archlinux, this role creates the required directory
structure, installs and configures the sys-ctl-hlth-check script, and
integrates with the sys-ctl-alm-telegram role. It uses the
sys-timer role to schedule regular checks based on your customizable
OnCalendar setting.
Purpose¶
The sys-ctl-hlth-msmtp role ensures that your mail transport system stays available by sending a test email at defined intervals. If the email fails, a Telegram alert is triggered, allowing you to detect and address issues before they impact users.
Features¶
Directory & Script Deployment: Sets up
sys-ctl-hlth-msmtp/and deploys a templated Bash script to send test emails via msmtp.Systemd Service & Timer: Provides
.serviceand.timerunits to run the check and schedule it automatically.Failure Notifications: Leverages sys-ctl-alm-telegram to push alerts when the script exits with an error.
Configurable Schedule: Define your desired check frequency using the
on_calendar_health_msmtpvariable.Email Destination: Specify the recipient via the
users.administrator.emailvariable.