community.general.pagerduty_user module – Manage a user account on PagerDuty
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_user
.
New in community.general 1.3.0
Synopsis
This module manages the creation/removal of a user account on PagerDuty.
Aliases: monitoring.pagerduty_user
Requirements
The below requirements are needed on the host that executes this module.
pdpyras python module = 4.1.1
PagerDuty API Access
Parameters
Parameter |
Comments |
---|---|
An API access token to authenticate with the PagerDuty REST API. |
|
The user’s email address.
|
|
The user’s role. Choices:
|
|
The teams to which the user belongs. Required if |
|
Name of the user in PagerDuty. |
|
State of the user. On On Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Create a user account on PagerDuty
community.general.pagerduty_user:
access_token: 'Your_Access_token'
pd_user: user_full_name
pd_email: user_email
pd_role: user_pd_role
pd_teams: user_pd_teams
state: "present"
- name: Remove a user account from PagerDuty
community.general.pagerduty_user:
access_token: 'Your_Access_token'
pd_user: user_full_name
pd_email: user_email
state: "absent"