ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-08 01:14:03 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

doc style adjustments: modules p* (#10463)

Browse source 
* doc style adjustments: modules p*

* Update plugins/modules/pacemaker_resource.py

* Update plugins/modules/pagerduty_alert.py

* Update plugins/modules/pear.py

* Update plugins/modules/portage.py

* reformat

* adjustment from review

* Update plugins/modules/pkg5_publisher.py

Co-authored-by: Peter Oliver <github.com@mavit.org.uk>

---------

Co-authored-by: Peter Oliver <github.com@mavit.org.uk>
This commit is contained in:
Alexei Znamensky 2025-07-27 21:48:50 +12:00 • committed by GitHub
commit d288555fd9
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
30 changed files with 161 additions and 155 deletions
Download patch file Download diff file Expand all files Collapse all files

20
plugins/modules/pagerduty_alert.py
View file

@ -12,7 +12,7 @@ DOCUMENTATION = r"""
module: pagerduty_alert
short_description: Trigger, acknowledge or resolve PagerDuty incidents
description:
- This module will let you trigger, acknowledge or resolve a PagerDuty incident by sending events.
- This module lets you trigger, acknowledge or resolve a PagerDuty incident by sending events.
author:
- "Amanpreet Singh (@ApsOps)"
- "Xiao Shen (@xshen1)"
@ -43,7 +43,7 @@ options:
service_id:
type: str
description:
- ID of PagerDuty service when incidents will be triggered, acknowledged or resolved.
- ID of PagerDuty service when incidents are triggered, acknowledged or resolved.
- Required if O(api_version=v1).
service_key:
type: str
@ -92,10 +92,9 @@ options:
type: str
description:
- For O(state=triggered) - Required. Short description of the problem that led to this trigger. This field (or a truncated
version) will be used when generating phone calls, SMS messages and alert emails. It will also appear on the incidents
tables in the PagerDuty UI. The maximum length is 1024 characters.
- For O(state=acknowledged) or O(state=resolved) - Text that will appear in the incident's log associated with this
event.
version) is used when generating phone calls, SMS messages and alert emails. It also appears on the incidents tables
in the PagerDuty UI. The maximum length is 1024 characters.
- For O(state=acknowledged) or O(state=resolved) - Text that appears in the incident's log associated with this event.
default: Created via Ansible
incident_class:
type: str
@ -106,12 +105,11 @@ options:
type: str
description:
- Identifies the incident to which this O(state) should be applied.
- For O(state=triggered) - If there is no open (in other words unresolved) incident with this key, a new one will be
created. If there is already an open incident with a matching key, this event will be appended to that incident's
log. The event key provides an easy way to 'de-dup' problem reports. If no O(incident_key) is provided, then it will
be generated by PagerDuty.
- For O(state=triggered) - If there is no open (in other words unresolved) incident with this key, a new one is created.
If there is already an open incident with a matching key, this event is appended to that incident's log. The event
key provides an easy way to 'de-dup' problem reports. If no O(incident_key) is provided, then it is generated by PagerDuty.
- For O(state=acknowledged) or O(state=resolved) - This should be the incident_key you received back when the incident
was first opened by a trigger event. Acknowledge events referencing resolved or nonexistent incidents will be discarded.
was first opened by a trigger event. Acknowledge events referencing resolved or nonexistent incidents is discarded.
link_url:
type: str
description: