sensu.sensu_go.namespace_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.namespace_info
。
注意
由于违反了 Ansible 包含要求,sensu.sensu_go 集合将在 Ansible 12 中移除。该集合存在 未解决的健全性测试失败。请参阅 讨论主题 了解更多信息。
sensu.sensu_go 1.0.0 中的新增功能
概要
检索有关 Sensu 命名空间的信息。
有关更多信息,请参阅 Sensu 文档 https://docs.sensu.io/sensu-go/latest/reference/rbac/#namespaces。
要求
执行此模块的主机需要以下要求。
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.namespace
管理 Sensu 命名空间。
示例
- name: List Sensu namespaces
sensu.sensu_go.namespace_info:
register: result
返回值
常用返回值已在 此处 记录,以下是此模块特有的字段
键 |
描述 |
---|---|
Sensu 命名空间列表。 返回: 成功 示例: |