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 中的新功能
概要
检索有关 Sensu Go 集群的信息。
有关更多信息，请参阅 Sensu 文档，网址为 https://docs.sensu.io/sensu-go/latest/operations/deploy-sensu/cluster-sensu/。
要求
执行此模块的主机需要以下要求。
python >= 2.7
参数
参数 |
注释 |
|---|---|
身份验证参数。 也可以使用 ENV 定义它们中的每一个。 |
|
身份验证时应使用的 API 密钥。 如果未设置，将检查 SENSU_API_KEY 环境变量的值。 这取代了 *auth.user* 和 *auth.password* 参数。 有关 API 密钥的更多信息，请参阅 Sensu 官方文档，网址为https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/。 |
|
用于验证后端证书的 CA 捆绑包的路径。 如果未设置此参数，则模块将使用 python 正在使用的 CA 捆绑包。 也可以通过 *SENSU_CA_PATH* 环境变量设置此参数。 |
|
Sensu 用户的密码。 如果未设置，将检查 SENSU_PASSWORD 环境变量的值。 如果设置了 *auth.api_key* 参数，则忽略此参数。 默认： |
|
Sensu 后端 API 的位置。 如果未设置，将检查 SENSU_URL 环境变量的值。 默认： |
|
用于连接到 Sensu API 的用户名。 如果未设置，将检查 SENSU_USER 环境变量的值。 如果设置了 *auth.api_key* 参数，则忽略此参数。 默认： |
|
控制证书验证的标志。 如果您正在使用自签名证书，则可以将此参数设置为 仅在开发场景中使用此参数！ 如果您在生产中使用自签名证书，请参阅 *auth.ca_path* 参数。 也可以通过 *SENSU_VERIFY* 环境变量设置此参数。 选择
|
|
检索有关此特定对象的信息，而不是列出所有对象。 |
另请参阅
另请参阅
- 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 }}"
返回值
常见返回值在 此处记录，以下是此模块独有的字段
键 |
描述 |
|---|---|
Sensu Go etcd 集群的列表。 返回：成功 示例： |