community.general.pagerduty_change module – Track a code or infrastructure change as a PagerDuty change event
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.pagerduty_change
.
New in community.general 1.3.0
Synopsis
This module will let you create a PagerDuty change event each time the module is run.
This is not an idempotent action and a new change event will be created each time it is run.
Aliases: monitoring.pagerduty_change
Requirements
The below requirements are needed on the host that executes this module.
PagerDuty integration key
Parameters
Parameter |
Comments |
---|---|
The environment name, typically |
|
The integration key that identifies the service the change was made to. This can be found by adding an integration to a service in PagerDuty. |
|
Descriptive text for a URL where more information about the deployment can be obtained. |
|
A URL where more information about the deployment can be obtained. |
|
The URL of the project repository. |
|
An identifier of the revision being deployed, typically a number or SHA from a version control system. |
|
The source of the change event. Default: |
|
A short description of the change that occurred. |
|
URL to submit the change event to. Default: |
|
The name of the user or process that triggered this deployment. |
|
If Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full Check mode simply does nothing except returning |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Track the deployment as a PagerDuty change event
community.general.pagerduty_change:
integration_key: abc123abc123abc123abc123abc123ab
summary: The application was deployed
- name: Track the deployment as a PagerDuty change event with more details
community.general.pagerduty_change:
integration_key: abc123abc123abc123abc123abc123ab
summary: The application was deployed
source: Ansible Deploy
user: ansible
repo: github.com/ansible/ansible
revision: '4.2'
environment: production
link_url: https://github.com/ansible-collections/community.general/pull/1269
link_text: View changes on GitHub