theforeman.foreman.user 模块 – 管理用户

注意

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

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

要安装它，请使用：ansible-galaxy collection install theforeman.foreman。您需要其他要求才能使用此模块，请参阅 要求了解详细信息。

要在 playbook 中使用它，请指定：theforeman.foreman.user。

theforeman.foreman 1.0.0 中的新功能

概要

  • 创建、更新和删除用户

别名：foreman_user

要求

执行此模块的主机需要满足以下要求。

  • requests

参数

参数

注释

admin

布尔值

用户是否为管理员

选择

  • false

  • true

auth_source

字符串

用户存在的身份验证源

default_location

字符串

用户默认使用的位置

default_organization

字符串

用户默认使用的组织

description

字符串

用户的描述

firstname

字符串

用户的名字

lastname

字符串

用户的姓氏

locale

字符串

用户的语言区域设置

选择

  • "ca"

  • "de"

  • "en"

  • "en_GB"

  • "es"

  • "fr"

  • "gl"

  • "it"

  • "ja"

  • "ko"

  • "nl_NL"

  • "pl"

  • "pt_BR"

  • "ru"

  • "sv_SE"

  • "zh_CN"

  • "zh_TW"

locations

列表 / 元素=字符串

实体应分配到的位置列表

login

别名：name

字符串 / 必需

用户名

mail

字符串

用户的电子邮件地址

创建新用户时必需

organizations

列表 / 元素=字符串

实体应分配到的组织列表

password

字符串 / 必需

用户访问 Foreman 服务器的密码。

如果任务中未指定该值，则将使用环境变量 FOREMAN_PASSWORD 的值。

roles

列表 / 元素=字符串

分配给用户的角色列表

server_url

字符串 / 必需

Foreman 服务器的 URL。

如果任务中未指定该值，则将使用环境变量 FOREMAN_SERVER_URL 的值。

state

字符串

实体的状态

选择

  • "present" ← (默认)

  • "absent"

timezone

字符串

用户的时区

如果为空白，则将使用浏览器时区。

选择

  • "国际日期变更线西"

  • "美属萨摩亚"

  • "中途岛"

  • "夏威夷"

  • "阿拉斯加"

  • "太平洋时间（美国和加拿大）"

  • "蒂华纳"

  • "亚利桑那"

  • "奇瓦瓦"

  • "马萨特兰"

  • "山区时间（美国和加拿大）"

  • "中美洲"

  • "中部时间（美国和加拿大）"

  • "瓜达拉哈拉"

  • "墨西哥城"

  • "蒙特雷"

  • "萨斯喀彻温"

  • "波哥大"

  • "东部时间（美国和加拿大）"

  • "印第安纳州（东部）"

  • "利马"

  • "基多"

  • "大西洋时间（加拿大）"

  • "加拉加斯"

  • "乔治敦"

  • "拉巴斯"

  • "波多黎各"

  • "圣地亚哥"

  • "纽芬兰"

  • "巴西利亚"

  • "布宜诺斯艾利斯"

  • "格陵兰"

  • "蒙得维的亚"

  • "中大西洋"

  • "亚速尔群岛"

  • "佛得角群岛"

  • "都柏林"

  • "爱丁堡"

  • "里斯本"

  • "伦敦"

  • "蒙罗维亚"

  • "UTC"

  • "阿姆斯特丹"

  • "贝尔格莱德"

  • "柏林"

  • "伯尔尼"

  • "布拉迪斯拉发"

  • "布鲁塞尔"

  • "布达佩斯"

  • "卡萨布兰卡"

  • "哥本哈根"

  • "卢布尔雅那"

  • "马德里"

  • "巴黎"

  • "布拉格"

  • "罗马"

  • "萨拉热窝"

  • "斯科普里"

  • "斯德哥尔摩"

  • "维也纳"

  • "华沙"

  • "西非中部"

  • "萨格勒布"

  • "苏黎世"

  • "雅典"

  • "布加勒斯特"

  • "开罗"

  • "哈拉雷"

  • "赫尔辛基"

  • "耶路撒冷"

  • "加里宁格勒"

  • "基辅"

  • "比勒陀利亚"

  • "里加"

  • "索非亚"

  • "塔林"

  • "维尔纽斯"

  • "巴格达"

  • "伊斯坦布尔"

  • "科威特"

  • "明斯克"

  • "莫斯科"

  • "内罗毕"

  • "利雅得"

  • "圣彼得堡"

  • "德黑兰"

  • "阿布扎比"

  • "巴库"

  • "马斯喀特"

  • "萨马拉"

  • "第比利斯"

  • "伏尔加格勒"

  • "埃里温"

  • "喀布尔"

  • "叶卡捷琳堡"

  • "伊斯兰堡"

  • "卡拉奇"

  • "塔什干"

  • "金奈"

  • "加尔各答"

  • "孟买"

  • "新德里"

  • "斯里贾亚瓦德纳普拉"

  • "加德满都"

  • "阿拉木图"

  • "阿斯塔纳"

  • "达卡"

  • "乌鲁木齐"

  • "仰光"

  • "曼谷"

  • "河内"

  • "雅加达"

  • "克拉斯诺亚尔斯克"

  • "新西伯利亚"

  • "北京"

  • "重庆"

  • "香港"

  • "伊尔库茨克"

  • "吉隆坡"

  • "珀斯"

  • "新加坡"

  • "台北"

  • "乌兰巴托"

  • "大阪"

  • "札幌"

  • "首尔"

  • "东京"

  • "雅库茨克"

  • "阿德莱德"

  • "达尔文"

  • "布里斯班"

  • "堪培拉"

  • "关岛"

  • "霍巴特"

  • "墨尔本"

  • "莫尔兹比 港"

  • "悉尼"

  • "符拉迪沃斯托克"

  • "马加丹"

  • "新 喀里多尼亚"

  • "所罗门 群岛"

  • "中科雷姆斯克"

  • "奥克兰"

  • "斐济"

  • "堪察加"

  • "马绍尔 群岛"

  • "惠灵顿"

  • "查塔姆 群岛"

  • "努库阿洛法"

  • "萨摩亚"

  • "托克劳 群岛"

user_password

字符串

用户的密码。

当设置此参数时，该模块将不具有幂等性。

username

字符串 / 必需

访问 Foreman 服务器的用户名。

如果任务中未指定该值，则将使用环境变量 FOREMAN_USERNAME 的值。

validate_certs

布尔值

是否验证 Foreman 服务器的 TLS 证书。

如果任务中未指定该值，则将使用环境变量 FOREMAN_VALIDATE_CERTS 的值。

选择

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持: 完全

可以在 check_mode 下运行，并返回更改状态预测，而无需修改实体

diff_mode

支持: 完全

当处于 diff 模式时，将返回已更改的内容的详细信息（或可能需要在 check_mode 下更改的内容）

示例

- name: Create a user
  theforeman.foreman.user:
    name: test
    firstname: Test
    lastname: Userson
    mail: [email protected]
    description: Dr. Test Userson
    admin: false
    user_password: s3cret
    default_location: Test Location
    default_organization: Test Organization
    auth_source: Internal
    timezone: Stockholm
    locale: sv_SE
    roles:
      - Manager
    locations:
      - Test Location
    organizations:
      - Test Organization
    state: present

- name: Update a user
  theforeman.foreman.user:
    name: test
    firstname: Tester
    state: present

- name: Change password
  theforeman.foreman.user:
    name: test
    user_password: newp@ss

返回值

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

键

描述

实体

字典

受影响的实体按其类型分组的最终状态。

返回: 成功

用户

列表 / 元素=字典

用户列表。

返回: 成功

作者

  • Christoffer Reijer (@ephracis) Basalt AB