pagerduty_alert: remove redundant required=false (#9618)

pull/9623/head
Alexei Znamensky 2025-01-25 09:42:01 +13:00 committed by GitHub
parent f5cbf5acc7
commit 6294f0b747
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 15 additions and 25 deletions

View File

@ -73,24 +73,20 @@ options:
type: str type: str
description: description:
- The name of the monitoring client that is triggering this event. - The name of the monitoring client that is triggering this event.
required: false
client_url: client_url:
type: str type: str
description: description:
- The URL of the monitoring client that is triggering this event. - The URL of the monitoring client that is triggering this event.
required: false
component: component:
type: str type: str
description: description:
- Component of the source machine that is responsible for the event, for example C(mysql) or C(eth0). - Component of the source machine that is responsible for the event, for example C(mysql) or C(eth0).
required: false
version_added: 7.4.0 version_added: 7.4.0
custom_details: custom_details:
type: dict type: dict
description: description:
- Additional details about the event and affected system. - Additional details about the event and affected system.
- A dictionary with custom keys and values. - A dictionary with custom keys and values.
required: false
version_added: 7.4.0 version_added: 7.4.0
desc: desc:
type: str type: str
@ -100,13 +96,11 @@ options:
tables in the PagerDuty UI. The maximum length is 1024 characters. 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 - For O(state=acknowledged) or O(state=resolved) - Text that will appear in the incident's log associated with this
event. event.
required: false
default: Created via Ansible default: Created via Ansible
incident_class: incident_class:
type: str type: str
description: description:
- The class/type of the event, for example C(ping failure) or C(cpu load). - The class/type of the event, for example C(ping failure) or C(cpu load).
required: false
version_added: 7.4.0 version_added: 7.4.0
incident_key: incident_key:
type: str type: str
@ -118,25 +112,21 @@ options:
be generated by PagerDuty. be generated by PagerDuty.
- For O(state=acknowledged) or O(state=resolved) - This should be the incident_key you received back when the incident - 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 will be discarded.
required: false
link_url: link_url:
type: str type: str
description: description:
- Relevant link URL to the alert. For example, the website or the job link. - Relevant link URL to the alert. For example, the website or the job link.
required: false
version_added: 7.4.0 version_added: 7.4.0
link_text: link_text:
type: str type: str
description: description:
- A short description of the O(link_url). - A short description of the O(link_url).
required: false
version_added: 7.4.0 version_added: 7.4.0
source: source:
type: str type: str
description: description:
- The unique location of the affected system, preferably a hostname or FQDN. - The unique location of the affected system, preferably a hostname or FQDN.
- Required in case of O(state=trigger) and O(api_version=v2). - Required in case of O(state=trigger) and O(api_version=v2).
required: false
version_added: 7.4.0 version_added: 7.4.0
severity: severity:
type: str type: str
@ -332,25 +322,25 @@ def send_event_v2(module, service_key, event_type, payload, link,
def main(): def main():
module = AnsibleModule( module = AnsibleModule(
argument_spec=dict( argument_spec=dict(
name=dict(required=False), name=dict(),
api_key=dict(required=False, no_log=True), api_key=dict(no_log=True),
integration_key=dict(required=False, no_log=True), integration_key=dict(no_log=True),
service_id=dict(required=False), service_id=dict(),
service_key=dict(required=False, no_log=True), service_key=dict(no_log=True),
state=dict( state=dict(
required=True, choices=['triggered', 'acknowledged', 'resolved'] required=True, choices=['triggered', 'acknowledged', 'resolved']
), ),
api_version=dict(type='str', default='v1', choices=['v1', 'v2']), api_version=dict(type='str', default='v1', choices=['v1', 'v2']),
client=dict(required=False), client=dict(),
client_url=dict(required=False), client_url=dict(),
component=dict(required=False), component=dict(),
custom_details=dict(required=False, type='dict'), custom_details=dict(type='dict'),
desc=dict(required=False, default='Created via Ansible'), desc=dict(default='Created via Ansible'),
incident_class=dict(required=False), incident_class=dict(),
incident_key=dict(required=False, no_log=False), incident_key=dict(no_log=False),
link_url=dict(required=False), link_url=dict(),
link_text=dict(required=False), link_text=dict(),
source=dict(required=False), source=dict(),
severity=dict( severity=dict(
default='critical', choices=['critical', 'warning', 'error', 'info'] default='critical', choices=['critical', 'warning', 'error', 'info']
), ),