community.general.pagerduty_change (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

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.

Requirements

• PagerDuty integration key

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Track the deployment as a PagerDuty change event
  community.general.pagerduty_change:
    integration_key: abc123abc123abc123abc123abc123ab
    summary: The application was deployed

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
url:
    default: https://events.pagerduty.com/v2/change/enqueue
    description:
    - URL to submit the change event to.
    required: false
    type: str

repo:
    description:
    - The URL of the project repository.
    required: false
    type: str

user:
    description:
    - The name of the user or process that triggered this deployment.
    type: str

source:
    default: Ansible
    description:
    - The source of the change event.
    type: str

summary:
    description:
    - A short description of the change that occurred.
    required: true
    type: str

link_url:
    description:
    - A URL where more information about the deployment can be obtained.
    required: false
    type: str

revision:
    description:
    - An identifier of the revision being deployed, typically a number or SHA from a version
      control system.
    required: false
    type: str

link_text:
    description:
    - Descriptive text for a URL where more information about the deployment can be obtained.
    required: false
    type: str

environment:
    description:
    - The environment name, typically V(production), V(staging), and so on.
    required: false
    type: str

validate_certs:
    default: true
    description:
    - If V(false), SSL certificates for the target URL will not be validated. This should
      only be used on personally controlled sites using self-signed certificates.
    required: false
    type: bool

integration_key:
    description:
    - 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.
    required: true
    type: str