sensu.sensu_go.cluster_info 模块 – 列出可用的 Sensu Go 集群

注意

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

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

要安装它,请使用:ansible-galaxy collection install sensu.sensu_go。您需要其他要求才能使用此模块,请参阅 要求 以了解详细信息。

要在 playbook 中使用它,请指定:sensu.sensu_go.cluster_info

注意

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

sensu.sensu_go 1.9.0 中的新功能

概要

要求

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

  • python >= 2.7

参数

参数

注释

auth

字典

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

api_key

字符串

在 sensu.sensu_go 1.3.0 中添加

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

这取代了auth.userauth.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.cluster

管理 Sensu Go 集群。

示例

- name: List all Sensu Go clusters
  sensu.sensu_go.etcd_replicator_info:
  register: result

- name: Retrieve the selected Sensu Go cluster
  sensu.sensu_go.etcd_replicator_info:
    name: my-cluster
  register: result

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

返回值

通用返回值记录在 此处,以下是此模块独有的字段

描述

objects

列表 / 元素=字典

Sensu Go etcd 集群的列表。

返回:成功

示例: [{"api_urls": ["http://10.10.0.1:8080"], "metadata": {"name": "alpha-cluster"}}, {"api_urls": ["https://10.20.0.1:8080", "https://10.20.0.2:8080"], "metadata": {"name": "beta-cluster"}}]

作者

  • Tadej Borovsak (@tadeboro)