[PR #10443/6d675469 backport][stable-11] doc style adjustments: modules [no]* (#10454)
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.16) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.11) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.16+py3.6) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+fedora38+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.16+opensuse15+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run

doc style adjustments: modules [no]* (#10443)

* doc style adjustments: modules n*

* doc style adjustments: modules o*

* Apply suggestions from code review

* Apply suggestions from code review



---------


(cherry picked from commit 6d67546902)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
Co-authored-by: Felix Fontein <felix@fontein.de>
This commit is contained in:
patchback[bot] 2025-07-25 09:45:53 +02:00 committed by GitHub
commit ab7b199af9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
36 changed files with 252 additions and 229 deletions

View file

@ -22,11 +22,6 @@ 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.
- You can specify multiple services at once by separating them with commas, for example O(services=httpd,nfs,puppet).
- When specifying what service to handle there is a special service value, O(host), which will handle alerts/downtime/acknowledge
for the I(host itself), for example O(services=host). This keyword may not be given with other services at the same time.
B(Setting alerts/downtime/acknowledge for a host does not affect alerts/downtime/acknowledge for any of the services running
on it.) To schedule downtime for all services on particular host use keyword "all", for example O(services=all).
extends_documentation_fragment:
- community.general.attributes
attributes:
@ -88,6 +83,12 @@ options:
description:
- What to manage downtime/alerts for. Separate multiple services with commas.
- 'B(Required) option when O(action) is one of: V(downtime), V(acknowledge), V(forced_check), V(enable_alerts), V(disable_alerts).'
- You can specify multiple services at once by separating them with commas, for example O(services=httpd,nfs,puppet).
- When specifying what O(services) to handle there is a special service value, V(host), which handles alerts/downtime/acknowledge
for the I(host itself), for example O(services=host). This keyword may not be given with other services at the same
time. B(Setting alerts/downtime/acknowledge for a host does not affect alerts/downtime/acknowledge for any of the
services running on it.) To schedule downtime for all O(services) on particular host use keyword V(all), for example
O(services=all).
aliases: ["service"]
type: str
servicegroup:
@ -97,8 +98,8 @@ options:
type: str
command:
description:
- The raw command to send to nagios, which should not include the submitted time header or the line-feed.
- B(Required) option when using the V(command) O(action).
- The raw command to send to Nagios, which should not include the submitted time header or the line-feed.
- B(Required) option when O(action=command).
type: str
author: "Tim Bielawa (@tbielawa)"