awx.awx.user 模块 – 创建、更新或销毁 Automation Platform Controller 用户。

注意

此模块是 awx.awx 集合(版本 24.6.1)的一部分。

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

要安装它,请使用:ansible-galaxy collection install awx.awx

要在 playbook 中使用它,请指定:awx.awx.user

概要

别名:tower_user

参数

参数

注释

controller_config_file

别名:tower_config_file

路径

控制器配置文件的路径。

如果提供,则不会考虑配置文件的其他位置。

controller_host

别名:tower_host

字符串

指向 Automation Platform Controller 实例的 URL。

如果未设置值,将尝试环境变量 CONTROLLER_HOST,然后尝试配置文件

如果未通过任何方式指定值,将使用值 127.0.0.1

controller_oauthtoken

别名:tower_oauthtoken

任意

在 awx.awx 3.7.0 中添加

要使用的 OAuth 令牌。

此值可以是以下两种格式之一。

一个字符串,即令牌本身。(即 bqV5txm97wqJqtkxlMkhQz0pKhRMMX)

一个字典结构,由令牌模块返回。

如果未设置值,将尝试环境变量 CONTROLLER_OAUTH_TOKEN,然后尝试配置文件

controller_password

别名:tower_password

字符串

控制器实例的密码。

如果未设置值,将尝试环境变量 CONTROLLER_PASSWORD,然后尝试配置文件

controller_username

别名:tower_username

字符串

控制器实例的用户名。

如果未设置值,将尝试环境变量 CONTROLLER_USERNAME,然后尝试配置文件

email

字符串

用户的电子邮件地址。

first_name

字符串

用户的名字。

is_superuser

别名:superuser

布尔值

表示此用户拥有所有权限,而无需显式分配它们。

选择

  • false

  • true

is_system_auditor

别名:auditor

布尔值

用户是系统范围的审计员。

选择

  • false

  • true

last_name

字符串

用户的姓氏。

new_username

字符串

设置此选项将更改现有用户名(通过 name 字段查找)。

organization

字符串

该用户将创建为该组织名称、ID 或已命名 URL 的成员(组织管理员创建新组织用户所必需的)。

password

字符串

用于更改密码的只写字段。

request_timeout

浮点数

指定 Ansible 在对控制器主机的请求中应使用的超时。

默认为 10 秒,但这由共享的 module_utils 代码处理

state

字符串

资源的所需状态。

选择

  • "present" ←(默认)

  • "absent"

  • "exists"

update_secrets

布尔值

true 如果用户指定密码,则始终更改密码,即使 API 为密码提供 $encrypted$。

false 仅当其他值也发生更改时才设置密码。

选择

  • false

  • true ←(默认)

username

字符串 / 必需

必需。150 个字符或更少。仅限字母、数字和 @/./+/-/_。

validate_certs

别名:tower_verify_ssl

布尔值

是否允许与 AWX 建立不安全连接。

如果为 no,则不会验证 SSL 证书。

这仅应用于使用自签名证书的个人控制站点。

如果未设置值,将尝试环境变量 CONTROLLER_VERIFY_SSL,然后尝试配置文件

选择

  • false

  • true

说明

注意

  • 如果没有提供config_file,我们将尝试使用 tower-cli 库的默认设置来查找您的主机信息。

  • config_file 的格式应如下所示:host=hostname username=username password=password

示例

- name: Add user
  user:
    username: jdoe
    password: foobarbaz
    email: [email protected]
    first_name: John
    last_name: Doe
    state: present
    controller_config_file: "~/tower_cli.cfg"

- name: Add user as a system administrator
  user:
    username: jdoe
    password: foobarbaz
    email: [email protected]
    superuser: yes
    state: present
    controller_config_file: "~/tower_cli.cfg"

- name: Add user as a system auditor
  user:
    username: jdoe
    password: foobarbaz
    email: [email protected]
    auditor: yes
    state: present
    controller_config_file: "~/tower_cli.cfg"

- name: Add user as a member of an organization (permissions on the organization are required)
  user:
    username: jdoe
    password: foobarbaz
    email: [email protected]
    organization: devopsorg
    state: present

- name: Delete user
  user:
    username: jdoe
    email: [email protected]
    state: absent
    controller_config_file: "~/tower_cli.cfg"

作者

  • John Westcott IV (@john-westcott-iv)