theforeman.foreman.role 模块 – 管理角色

注意

此模块是 theforeman.foreman 集合（版本 4.2.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install theforeman.foreman。您需要进一步的要求才能使用此模块，请参阅要求获取详细信息。

要在剧本中使用它，请指定：theforeman.foreman.role。

theforeman.foreman 1.0.0 中的新增功能

概要 

创建、更新和删除角色

别名：foreman_role

要求 

在执行此模块的主机上需要以下要求。

requests

参数 

参数	注释
描述字符串	角色的描述
过滤器列表 / 元素=字典	此角色的权限过滤器
权限列表 / 元素=字符串 / 必需	权限列表
搜索字符串	资源的筛选条件
位置列表 / 元素=字符串	应将实体分配到的位置列表
名称字符串 / 必需	角色的名称
组织列表 / 元素=字符串	应将实体分配到的组织列表
密码字符串 / 必需	访问 Foreman 服务器的用户的密码。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_PASSWORD` 的值。
server_url 字符串 / 必需	Foreman 服务器的 URL。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_SERVER_URL` 的值。
状态字符串	实体的状态选项 `"present"` ←（默认） `"absent"`
用户名字符串 / 必需	访问 Foreman 服务器的用户名。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_USERNAME` 的值。
validate_certs 布尔值	是否验证 Foreman 服务器的 TLS 证书。如果未在任务中指定该值，则将使用环境变量 `FOREMAN_VALIDATE_CERTS` 的值。选项 `false` `true` ←（默认）

属性 

属性	支持	描述
check_mode	支持：完整	可以在 check_mode 下运行，并返回已更改的状态预测，而无需修改实体
diff_mode	支持：完整	当处于 diff 模式时，将返回有关已更改内容（或在 check_mode 下可能需要更改的内容）的详细信息

示例 

- name: role
  theforeman.foreman.role:
    name: "Provisioner"
    description: "Only provision on libvirt"
    locations:
      - "Uppsala"
    organizations:
      - "ACME"
    filters:
      - permissions:
          - view_hosts
        search: "owner_type = Usergroup and owner_id = 4"
    server_url: "https://foreman.example.com"
    username: "admin"
    password: "changeme"
    state: present

返回值 

常见的返回值记录在这里，以下是此模块特有的字段

键	描述
实体字典	受影响的实体按其类型分组的最终状态。返回：成功
角色列表 / 元素=字典	角色列表。返回：成功

作者

Christoffer Reijer (@ephracis) Basalt AB