telekom_mms.icinga_director.icinga_user_template_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_template_info

telekom_mms.icinga_director 1.13.0 中的新增功能

概要

  • 通过 Director API 从 Icinga2 获取用户模板对象列表。

参数

参数

注释

client_cert

路径

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

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

client_key

路径

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

如果 client_cert 同时包含证书和密钥,则此选项不是必需的。

force

boolean

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

选择

  • false ← (默认)

  • true

force_basic_auth

boolean

使用 url_usernameurl_password 指定的凭据应在 HTTP 标头中传递。

选择

  • false ← (默认)

  • true

http_agent

string

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

默认: "ansible-httpget"

query

string

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

该文本在 object_name 上匹配。

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

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

默认: ""

resolved

boolean

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

选择

  • false ← (默认)

  • true

url

string / 必需

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

url_password

string

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

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

url_username

string

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

此参数可以在不使用 url_password 的情况下使用,用于允许空密码的站点

use_gssapi

boolean

在 ansible-core 2.11 中添加

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

需要安装 Python 库 gssapi

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

即使已安装 NTLM 的 GSSAPI mech,也支持 NTLM 身份验证。

选择

  • false ← (默认)

  • true

use_proxy

boolean

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

选择

  • false

  • true ← (默认)

validate_certs

boolean

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

仅应在个人控制的、使用自签名证书的站点上使用此选项。

选择

  • false

  • true ← (默认)

注释

注意

  • 此模块支持检查模式。

示例

- name: Query a user template in icinga
  telekom_mms.icinga_director.icinga_user_template_info:
    url: "{{ icinga_url }}"
    url_username: "{{ icinga_user }}"
    url_password: "{{ icinga_pass }}"
    query: "foousertemplate"

返回值

常用返回值记录在此处这里,以下是此模块特有的字段

描述

objects

列表 / 元素=字符串

返回的 Director 对象列表。

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

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

返回: 始终

作者

  • Martin Schurz (@schurzi)