telekom_mms.icinga_director.icinga_user 模块 – 在 Icinga2 中管理用户

注意

此模块是 telekom_mms.icinga_director 集合 (版本 2.2.1) 的一部分。

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

要安装它,请使用:ansible-galaxy collection install telekom_mms.icinga_director

要在剧本中使用它,请指定:telekom_mms.icinga_director.icinga_user

telekom_mms.icinga_director 1.0.0 中的新增功能

概要

  • 通过 director API 添加或删除 Icinga2 用户。

参数

参数

注释

append

布尔值

在 telekom_mms.icinga_director 1.25.0 中添加

不要覆盖整个对象,而是追加定义的属性。

注意 - 无法追加到现有的变量、导入或任何其他列表/字典。您必须覆盖完整的列表/字典。

注意 - 默认设置的变量也将应用,即使未设置。

选项

  • false

  • true

client_cert

路径

用于 SSL 客户端身份验证的 PEM 格式证书链文件。

此文件也可以包含密钥,如果包含密钥,则不需要 client_key

client_key

路径

包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。

如果 client_cert 包含证书和密钥,则不需要此选项。

disabled

布尔值

禁用的对象将不会部署。

选项

  • false ← (默认)

  • true

display_name

字符串

此用户的替代名称。

如果您的对象名称是用户名,这可能是相应人员的全名。

email

字符串

用户的电子邮件地址。

force

布尔值

如果为 yes,则不获取缓存的副本。

选项

  • false ← (默认)

  • true

force_basic_auth

布尔值

使用 url_usernameurl_password 指定的凭据应通过 HTTP 标头传递。

选项

  • false ← (默认)

  • true

groups

列表 / 元素=字符串

应直接分配给此用户的用户组。

组由于各种原因可能很有用。您可能更倾向于向组而不是单个用户发送通知。

http_agent

字符串

用于标识的标头,通常出现在 Web 服务器日志中。

默认值: "ansible-httpget"

imports

列表 / 元素=字符串

可导入的模板,您可以添加任意多个。

请注意,从多个模板导入属性时,顺序很重要 - 最后一个优先。

object_name

别名:name

字符串 / 必需

用户的名称。

pager

字符串

用户的寻呼机地址。

period

字符串

确定何时应触发对此用户的通知的时间段的名称。默认情况下未设置。

state

字符串

应用功能状态。

选项

  • "present" ← (默认)

  • "absent"

url

字符串 / 必需

形式为 (http|https|ftp)://[user[:pass]]@host.domain[:port]/path 的 HTTP、HTTPS 或 FTP URL

url_password

字符串

用于 HTTP 基本身份验证的密码。

如果没有指定 url_username 参数,则不会使用 url_password 参数。

url_username

字符串

用于 HTTP 基本身份验证的用户名。

此参数可以不用 url_password,适用于允许空密码的站点

use_gssapi

布尔值

在 ansible-core 2.11 中添加

使用 GSSAPI 执行身份验证,通常用于 Kerberos 或通过协商身份验证的 Kerberos。

需要安装 Python 库 gssapi

可以使用 url_username/url_password 或使用指定自定义 Kerberos 凭据缓存的 GSSAPI 环境变量 KRB5CCNAME 来指定 GSSAPI 的凭据。

即使已安装用于 NTLM 的 GSSAPI 机制,也不支持 NTLM 身份验证。

选项

  • false ← (默认)

  • true

use_proxy

布尔值

如果为no,则即使目标主机上的环境变量中定义了代理,也不会使用代理。

选项

  • false

  • true ← (默认)

validate_certs

布尔值

如果为no,则不会验证SSL证书。

这仅应在使用自签名证书的个人控制站点上使用。

选项

  • false

  • true ← (默认)

vars

字典

用户的自定义属性。

默认: {}

备注

注意

  • 此模块支持检查模式。

示例

- name: Create user
  telekom_mms.icinga_director.icinga_user:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "rb"
    pager: 'SIP/emergency'
    period: '24/7'
    email: "[email protected]"
    imports:
      - foousertemplate
    groups:
      - onCall
    vars:
      department: IT
      role: CTO

- name: Update user
  telekom_mms.icinga_director.icinga_user:
    state: present
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    object_name: "rb"
    display_name: "Rufbereitschaft"
    append: true

作者

  • Sebastian Gumprich (@rndmh3ro)