ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-21 20:30:21 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

Use semantic markup (modules o-p) (#6681)

Browse source 
* Use semantic markup.

* Use real option, not alias.

* E() now works better.
This commit is contained in:
Felix Fontein 2023-06-15 15:48:17 +02:00 • committed by GitHub
commit 45eb1e3915
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
42 changed files with 420 additions and 419 deletions
Download patch file Download diff file Expand all files Collapse all files

12
plugins/modules/pagerduty_alert.py
View file

@ -38,7 +38,7 @@ options:
service_key:
type: str
description:
- The GUID of one of your "Generic API" services. Obsolete. Please use I(integration_key).
- The GUID of one of your "Generic API" services. Obsolete. Please use O(integration_key).
integration_key:
type: str
description:
@ -61,20 +61,20 @@ options:
desc:
type: str
description:
- For C(triggered) I(state) - Required. Short description of the problem that led to this trigger. This field (or a truncated version)
- 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 C(acknowledged) or C(resolved) I(state) - Text that will appear in the incident's log associated with this event.
- For O(state=acknowledged) or O(state=resolved) - Text that will appear in the incident's log associated with this event.
required: false
default: Created via Ansible
incident_key:
type: str
description:
- Identifies the incident to which this I(state) should be applied.
- For C(triggered) I(state) - If there's no open (i.e. unresolved) incident with this key, a new one will be created. If there's already an
- Identifies the incident to which this O(state) should be applied.
- For O(state=triggered) - If there's no open (i.e. unresolved) incident with this key, a new one will be created. If there's 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.
- For C(acknowledged) or C(resolved) I(state) - This should be the incident_key you received back when the incident was first opened by a
- 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.
required: false
client: