From 89e6e6c6260590a1662abb13c4023a33865149bf Mon Sep 17 00:00:00 2001 From: "patchback[bot]" <45432694+patchback[bot]@users.noreply.github.com> Date: Sat, 23 Aug 2025 19:44:09 +0200 Subject: [PATCH] [PR #10696/db7757ed backport][stable-11] Update documentation (#10714) Update documentation (#10696) * Update documentation Added to the description explaining the mode of operation and the protocol being used. This would add to the user experience and saves time for the user. * use single quotes around colon contained list element to satisfy linter * Apply suggestions from code review * documentation of nagios module - included all nagios configuration paths in plugins/modules/nagios.py * used italic code I(...) for paths * added trailing comma to nagios.cfg path listing * added trailing period after icinga path listing. --------- (cherry picked from commit db7757ed4b9a232776f5afd0e38c9d0cc73970e9) Co-authored-by: bofo540 Co-authored-by: bjt-user Co-authored-by: Felix Fontein --- plugins/modules/nagios.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/plugins/modules/nagios.py b/plugins/modules/nagios.py index 6426975546..5a9c36bc1e 100644 --- a/plugins/modules/nagios.py +++ b/plugins/modules/nagios.py @@ -22,6 +22,13 @@ description: - The C(nagios) module is not idempotent. - All actions require the O(host) parameter to be given explicitly. In playbooks you can use the C({{inventory_hostname}}) variable to refer to the host the playbook is currently running on. + - The module executes commands and needs to be run directly on the Nagios server + with a user that has appropriate access rights. It does not use Nagios' HTTP API. + - Searches for a I(nagios.cfg) in I(/etc/nagios), I(/etc/nagios2), I(/etc/nagios3), I(/usr/local/etc/nagios), + I(/usr/local/groundwork/nagios/etc), I(/omd/sites/oppy/tmp/nagios), I(/usr/local/nagios/etc), + I(/usr/local/nagios), I(/opt/nagios/etc), and I(/opt/nagios), + or a I(icinga.cfg) in I(/etc/icinga) and I(/usr/local/icinga/etc). + (The Nagios configuration file should be readable by the Ansible user.) extends_documentation_fragment: - community.general.attributes attributes: