telekom_mms.icinga_director.icinga_user_group_info 模块 – 查询 Icinga2 中的用户组

注意

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

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

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

要在 playbook 中使用它,请指定:telekom_mms.icinga_director.icinga_user_group_info

telekom_mms.icinga_director 1.16.0 中的新增功能

概要

  • 通过 director API 从 Icinga2 获取用户组对象的列表。

参数

参数

注释

client_cert

path

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

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

client_key

path

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

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

force

布尔值

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

选项

  • false ← (默认)

  • true

force_basic_auth

布尔值

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

选项

  • false ← (默认)

  • true

http_agent

字符串

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

默认值: "ansible-httpget"

query

字符串

用于筛选搜索结果的文本。

该文本与 object_name 匹配。

结果集中只返回包含此文本的对象。

需要 Icinga Director 1.8.0+,在早期版本中,此参数被忽略,并返回所有对象。

默认值: ""

resolved

布尔值

解析所有继承的对象属性并在输出中省略模板。

选项

  • false ← (默认)

  • true

url

字符串 / 必需

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

url_password

字符串

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

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

url_username

字符串

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

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

use_gssapi

布尔值

ansible-core 2.11 中新增

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

需要安装 Python 库 gssapi

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

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

选项

  • false ← (默认)

  • true

use_proxy

布尔值

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

选项

  • false

  • true ← (默认)

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

备注

注意

  • 此模块支持检查模式。

示例

- name: Query a user group in icinga
  telekom_mms.icinga_director.icinga_user_group_info:
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    query: "onCall"

返回值

常见的返回值已在此处记录,以下是此模块独有的字段

描述

对象

列表 / 元素=字符串

返回的Director对象列表。

该列表包含与查询过滤器匹配的所有对象。

如果过滤器与任何对象都不匹配,则列表将为空。

返回值:始终返回

作者

  • Sebastian Gumprich (@rndmh3ro)