sensu.sensu_go.asset_info 模块 – 列出 Sensu 资产
注意
此模块是 sensu.sensu_go 集合(版本 1.14.0)的一部分。
如果您正在使用 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install sensu.sensu_go
。您需要其他要求才能使用此模块,有关详细信息,请参阅要求。
要在剧本中使用它,请指定:sensu.sensu_go.asset_info
。
注意
由于违反了 Ansible 包含要求,sensu.sensu_go 集合将从 Ansible 12 中删除。该集合有未解决的健全性测试失败。有关详细信息,请参阅讨论线程。
sensu.sensu_go 1.0.0 中的新增功能
概要
检索有关 Sensu Go 资产的信息。
有关更多信息,请参阅 Sensu 文档:https://docs.sensu.io/sensu-go/latest/reference/assets/。
要求
执行此模块的主机上需要满足以下要求。
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 环境变量设置此参数。 选择
|
|
检索有关此特定对象的信息,而不是列出所有对象。 |
|
要操作的 RBAC 命名空间。如果未设置此项,将使用 SENSU_NAMESPACE 环境变量的值。 默认值: |
另请参阅
另请参阅
- sensu.sensu_go.asset
管理 Sensu 资产。
- sensu.sensu_go.bonsai_asset
从 Bonsai 添加 Sensu 资产。
示例
- name: List all Sensu assets
sensu.sensu_go.asset_info:
register: result
- name: List the selected Sensu asset
sensu.sensu_go.asset_info:
name: my_asset
register: result
- name: Do something with result
ansible.builtin.debug:
msg: "{{ result.objects.0.metadata.name }}"
返回值
通用返回值在此处记录,以下是此模块特有的字段
键 |
描述 |
---|---|
Sensu 资产列表。 已返回: 成功 示例: |