sensu.sensu_go.auth_provider_info 模块 – 列出 Sensu 身份验证提供程序

注意

此模块是 sensu.sensu_go 集合（版本 1.14.0）的一部分。

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

要安装它，请使用：ansible-galaxy collection install sensu.sensu_go。您需要更多要求才能使用此模块，请参阅 要求 了解详细信息。

要在 playbook 中使用它，请指定：sensu.sensu_go.auth_provider_info。

注意

由于违反了 Ansible 包含要求，sensu.sensu_go 集合将从 Ansible 12 中删除。该集合有 未解决的健全性测试失败。有关更多信息，请参阅讨论线程。

sensu.sensu_go 1.10.0 中的新增功能

概要

要求

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

  • python >= 2.7

参数

参数

注释

auth

字典

身份验证参数。也可以使用 ENV 定义它们中的每一个。

api_key

字符串

在 sensu.sensu_go 1.3.0 中添加

身份验证时应使用的 API 密钥。如果未设置此项，将检查 SENSU_API_KEY 环境变量的值。

这取代了 auth.user 和 auth.password 参数。

有关 API 密钥的更多信息，请参阅官方 Sensu 文档：https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/。

ca_path

路径

在 sensu.sensu_go 1.5.0 中添加

应使用来验证后端证书的 CA 捆绑包的路径。

如果未设置此参数，模块将使用 python 正在使用的 CA 捆绑包。

也可以通过 SENSU_CA_PATH 环境变量设置此参数。

password

字符串

Sensu 用户的密码。如果未设置此项，将检查 SENSU_PASSWORD 环境变量的值。

如果设置了 auth.api_key 参数，则忽略此参数。

默认值: "P@ssw0rd!"

url

字符串

Sensu 后端 API 的位置。如果未设置此项，将检查 SENSU_URL 环境变量的值。

默认值: "https://127.0.0.1:8080"

user

字符串

用于连接到 Sensu API 的用户名。如果未设置此项，将检查 SENSU_USER 环境变量的值。

如果设置了 auth.api_key 参数，则忽略此参数。

默认值: "admin"

verify

布尔值

在 sensu.sensu_go 1.5.0 中添加

控制证书验证的标志。

如果您正在使用自签名证书，可以将此参数设置为 false。

仅在开发场景中使用此参数！如果您在生产中使用自签名证书，请参阅 auth.ca_path 参数。

也可以通过 SENSU_VERIFY 环境变量设置此参数。

选择

  • false

  • true ← (默认)

name

字符串

检索有关此特定对象的信息，而不是列出所有对象。

另请参阅

另请参阅

sensu.sensu_go.ad_auth_provider

管理 Sensu AD 身份验证提供程序。

sensu.sensu_go.ldap_auth_provider

管理 Sensu LDAP 身份验证提供程序。

sensu.sensu_go.oidc_auth_provider

管理 Sensu OIDC 身份验证提供程序。

示例

- name: List all Sensu authentication providers
  sensu.sensu_go.auth_provider_info:
  register: result

- name: List the selected Sensu authentication provider
  sensu.sensu_go.auth_provider_info:
    name: my_auth_provider
  register: result

- name: Do something with result
  ansible.builtin.debug:
    msg: "{{ result.objects.0.metadata.name }}"

返回值

常见的返回值记录在此处，以下是此模块特有的字段

键

描述

对象

列表 / elements=字典

Sensu 身份验证提供程序的列表。

返回: 成功

示例: [{"groups_prefix": "", "metadata": {"name": "openldap"}, "servers": {"binding": {"user_dn": "cn=binder,dc=acme,dc=org"}, "client_cert_file": "", "client_key_file": "", "default_upn_domain": "", "group_search": {"attribute": "member", "base_dn": "dc=acme,dc=org", "name_attribute": "cn", "object_class": "groupOfNames"}, "host": "127.0.0.1", "insecure": false, "port": 636, "security": "tls", "trusted_ca_file": "", "user_search": {"attribute": "uid", "base_dn": "dc=acme,dc=org", "name_attribute": "cn", "object_class": "person"}}, "username_prefix": ""}]

作者

  • Aljaz Kosir (@aljazkosir)

  • Manca Bizjak (@mancabizjak)

  • Miha Dolinar (@mdolin)

  • Tadej Borovsak (@tadeboro)