pagerduty
¶
Runner Module for Firing Events via PagerDuty
Added in version 2014.1.0.
- configuration:
This module can be used by specifying the name of a configuration profile in the master config.
For example:
my-pagerduty-account: pagerduty.api_key: F3Rbyjbve43rfFWf2214 pagerduty.subdomain: mysubdomain
- saltext.pagerduty.runners.pagerduty.__virtual__()[source]¶
No dependencies outside of what Salt itself requires
- saltext.pagerduty.runners.pagerduty.list_services(profile=None, api_key=None)[source]¶
List services belonging to this account
CLI Example:
salt-run pagerduty.list_services my-pagerduty-account
- saltext.pagerduty.runners.pagerduty.list_incidents(profile=None, api_key=None)[source]¶
List incidents belonging to this account
CLI Example:
salt-run pagerduty.list_incidents my-pagerduty-account
- saltext.pagerduty.runners.pagerduty.list_users(profile=None, api_key=None)[source]¶
List users belonging to this account
CLI Example:
salt-run pagerduty.list_users my-pagerduty-account
- saltext.pagerduty.runners.pagerduty.list_schedules(profile=None, api_key=None)[source]¶
List schedules belonging to this account
CLI Example:
salt-run pagerduty.list_schedules my-pagerduty-account
- saltext.pagerduty.runners.pagerduty.list_windows(profile=None, api_key=None)[source]¶
List maintenance windows belonging to this account
CLI Example:
salt-run pagerduty.list_windows my-pagerduty-account salt-run pagerduty.list_maintenance_windows my-pagerduty-account
- saltext.pagerduty.runners.pagerduty.list_maintenance_windows(profile=None, api_key=None)¶
This function is an alias of
list_windows
.List maintenance windows belonging to this account
CLI Example:
salt-run pagerduty.list_windows my-pagerduty-account salt-run pagerduty.list_maintenance_windows my-pagerduty-account
- saltext.pagerduty.runners.pagerduty.list_policies(profile=None, api_key=None)[source]¶
List escalation policies belonging to this account
CLI Example:
salt-run pagerduty.list_policies my-pagerduty-account salt-run pagerduty.list_escalation_policies my-pagerduty-account
- saltext.pagerduty.runners.pagerduty.list_escalation_policies(profile=None, api_key=None)¶
This function is an alias of
list_policies
.List escalation policies belonging to this account
CLI Example:
salt-run pagerduty.list_policies my-pagerduty-account salt-run pagerduty.list_escalation_policies my-pagerduty-account
- saltext.pagerduty.runners.pagerduty.create_event(service_key=None, description=None, details=None, incident_key=None, profile=None)[source]¶
Create an event in PagerDuty. Designed for use in states.
CLI Example:
salt-run pagerduty.create_event <service_key> <description> <details> profile=my-pagerduty-account
The following parameters are required:
- service_key
This key can be found by using pagerduty.list_services.
- description
This is a short description of the event.
- details
This can be a more detailed description of the event.
- profile
This refers to the configuration profile to use to connect to the PagerDuty service.