sensu.sensu_go.pipeline_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.pipeline_info。

注意

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

sensu.sensu_go 1.14.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

字符串

特定管道的名称。

namespace

字符串

要在其中操作的 RBAC 命名空间。如果未设置此项，将使用 SENSU_NAMESPACE 环境变量的值。

默认： "default"

另请参阅

另请参阅

sensu.sensu_go.socket_handler

管理 Sensu TCP/UDP 处理程序。

sensu.sensu_go.handler_info

列出 Sensu 处理程序。

sensu.sensu_go.pipe_handler

管理 Sensu 管道处理程序。

sensu.sensu_go.filter

管理 Sensu 过滤器。

sensu.sensu_go.filter_info

列出 Sensu 信息。

sensu.sensu_go.mutator

管理 Sensu 变异器。

sensu.sensu_go.mutator_info

列出 Sensu 变异器。

示例

- name: List all Sensu pipelines
  sensu.sensu_go.pipeline_info:
  register: result

- name: List the selected Sensu pipeline
  sensu.sensu_go.pipeline_info:
    name: my_pipeline
  register: result

返回值

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

键

描述

objects

列表 / elements=字典

Sensu 管道的列表。

返回：成功

示例： [{"metadata": {"created_by": "admin", "name": "this_pipeline", "namespace": "default"}, "workflows": null}, {"metadata": {"created_by": "admin", "name": "this_pipeline_1", "namespace": "default"}, "workflows": [{"handler": {"api_version": "core/v2", "name": "best_handler_1", "type": "Handler"}, "name": "best_workflow_1"}]}, {"metadata": {"created_by": "admin", "name": "this_pipeline_2", "namespace": "default"}, "workflows": [{"handler": {"api_version": "core/v2", "name": "best_handler_2", "type": "Handler"}, "name": "best_workflow_1"}]}]

作者

  • Domen Dobnikar (@domen_dobnikar)