sensu.sensu_go.namespace 模块 – 管理 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
。
注意
由于违反了 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 资源的名称。此名称(在适用情况下与命名空间组合)唯一标识 Ansible 操作的资源。 如果已存在具有所选名称的资源,则 Ansible 模块将更新它以匹配任务中的规范。 有关有效名称和其他限制的更多详细信息,请参阅上游文档中关于 https://docs.sensu.io/sensu-go/latest/reference/ 的 name 元数据属性规范。 |
|
Sensu 对象的目标状态。 选项
|
另请参阅
另请参阅
- sensu.sensu_go.namespace_info
列出 Sensu 命名空间。
示例
- name: Create a new namespace
sensu.sensu_go.namespace:
name: production
state: present
- name: Delete a namespace
sensu.sensu_go.namespace:
name: staging
state: absent
返回值
常用返回值记录在 此处,以下是此模块特有的字段
键 |
描述 |
---|---|
表示 Sensu 命名空间的对象。 已返回:成功 示例: |