community.general.pagerduty_user 模块 – 管理 PagerDuty 上的用户帐户

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：community.general.pagerduty_user。

community.general 1.3.0 中的新增功能

概要

  • 此模块管理在 PagerDuty 上创建/删除用户帐户。

要求

以下要求在执行此模块的主机上是必需的。

  • pdpyras python 模块 = 4.1.1

  • PagerDuty API 访问权限

参数

参数

注释

access_token

字符串 / 必需

用于对 PagerDuty REST API 进行身份验证的 API 访问令牌。

pd_email

字符串 / 必需

用户的电子邮件地址。

pd_email 是使用的唯一标识符，不能使用此模块进行更新。

pd_role

字符串

用户的角色。

选项

  • "global_admin"

  • "manager"

  • "responder" ← (默认)

  • "observer"

  • "stakeholder"

  • "limited_stakeholder"

  • "restricted_access"

pd_teams

列表 / 元素=字符串

用户所属的团队。

如果 state=present，则为必需。

pd_user

字符串 / 必需

PagerDuty 中用户的名称。

state

字符串

用户的状态。

在 present 时，如果用户不存在，则创建用户。

在 absent 时，如果帐户存在，则删除用户。

选项

  • "present" ← (默认)

  • "absent"

属性

属性

支持

描述

check_mode

支持：完全支持

可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持：不支持

在差异模式下，将返回有关已更改内容（或可能需要在 check_mode 中更改的内容）的详细信息。

示例

- 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"

作者

  • Zainab Alsaffar (@zanssa)