sensu.sensu_go.role 模块 – 管理 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.role。
注意
由于违反了 Ansible 包含要求，sensu.sensu_go 集合将从 Ansible 12 中删除。该集合存在未解决的健全性测试失败。有关更多信息，请参阅讨论主题。
sensu.sensu_go 1.0.0 中的新功能
概要
创建、更新或删除 Sensu 角色。
有关更多信息，请参阅 Sensu 文档，网址为 https://docs.sensu.io/sensu-go/latest/reference/rbac/#roles-and-cluster-roles。
要求
在执行此模块的主机上需要以下要求。
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 元数据属性规范，以了解有关有效名称和其他限制的更多详细信息。 |
|
要操作的 RBAC 命名空间。如果未设置，将使用 SENSU_NAMESPACE 环境变量的值。 默认： |
|
角色应用的规则。 如果 state 为 |
|
规则有权访问的特定资源的名称。 请注意，对于 |
|
规则有权访问的资源类型。 |
|
要由规则应用的权限。 选择
|
|
Sensu 对象的目标状态。 选择
|
另请参阅
另请参阅
- sensu.sensu_go.role_info
列出 Sensu 角色。
- sensu.sensu_go.cluster_role
管理 Sensu 集群角色。
- sensu.sensu_go.role_binding
管理 Sensu 角色绑定。
示例
- name: Create a role
sensu.sensu_go.role:
name: readonly
rules:
- verbs:
- get
- list
resources:
- checks
- entities
- name: Delete a role
sensu.sensu_go.role:
name: readonly
state: absent
返回值
常见的返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
表示 Sensu 角色的对象。 已返回： 成功 示例： |