awx.awx.role 模块 – 授予或撤销自动化平台控制器的角色。

注意

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

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

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

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

概要

  • 角色用于访问控制,此模块用于管理用户对服务器资源的访问。

  • 授予或撤销用户在自动化平台控制器的角色。有关概述,请参见 https://ansible.org.cn/tower

别名:tower_role

参数

参数

注释

controller_config_file

别名: tower_config_file

路径

控制器配置文件的路径。

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

controller_host

别名: tower_host

字符串

指向您的自动化平台控制器实例的 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,然后尝试配置文件

credential

字符串

角色作用的凭据名称、ID 或命名 URL。

已弃用,请使用“credentials”。

credentials

列表 / 元素=字符串

角色作用的凭据名称、ID 或命名 URL。

instance_groups

列表 / 元素=字符串

角色作用的实例组名称、ID 或命名 URL。

inventories

列表 / 元素=字符串

角色作用的清单名称、ID 或命名 URL。

inventory

字符串

角色作用的清单名称、ID 或命名 URL。

已弃用,请使用“inventories”。

job_template

字符串

角色作用的作业模板名称、ID 或命名 URL。

已弃用,请使用“job_templates”。

job_templates

列表 / 元素=字符串

角色作用的作业模板名称、ID 或命名 URL。

lookup_organization

字符串

清单、作业模板、项目或工作流所在的组织名称、ID 或命名 URL。

用于帮助查找对象,对于组织角色,请参见 organization。

如果未提供,将仅按名称查找,这不适用于重复项。

organization

字符串

角色作用的组织名称、ID 或命名 URL。

已弃用,请使用“organizations”。

organizations

列表 / 元素=字符串

角色作用的组织名称、ID 或命名 URL。

project

字符串

角色作用的项目名称、ID 或命名 URL。

已弃用,请使用“projects”。

projects

列表 / 元素=字符串

角色作用的项目名称、ID 或命名 URL。

request_timeout

浮点数

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

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

role

字符串 / 必需

要授予/撤销的角色类型。

选项

  • "admin"

  • "read"

  • "member"

  • "execute"

  • "adhoc"

  • "update"

  • "use"

  • "approval"

  • "auditor"

  • "project_admin"

  • "inventory_admin"

  • "credential_admin"

  • "workflow_admin"

  • "notification_admin"

  • "job_template_admin"

  • "execution_environment_admin"

state

字符串

期望状态。

“present” 状态表示用户应具有该角色。

“absent” 状态表示如果用户拥有该角色,则应将其撤销。

选项

  • "present" ←(默认)

  • "absent"

target_team

字符串

角色作用的团队名称、ID 或命名 URL。

例如,使某人成为团队的成员或管理员。

团队成员会隐式接收团队拥有的权限。

已弃用,请使用“target_teams”。

target_teams

列表 / 元素=字符串

角色作用的团队名称、ID 或命名 URL。

例如,使某人成为团队的成员或管理员。

团队成员会隐式接收团队拥有的权限。

team

字符串

接收角色指定权限的团队名称、ID 或命名 URL。

已弃用,请使用“teams”。

teams

列表 / 元素=字符串

接收角色指定权限的团队名称、ID 或命名 URL。

user

字符串

接收角色指定权限的用户名、ID 或命名 URL。

已弃用,请使用“users”。

users

列表 / 元素=字符串

接收角色指定权限的用户名、ID 或命名 URL。

validate_certs

别名: tower_verify_ssl

布尔值

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

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

这只应在个人控制的站点上使用自签名证书时使用。

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

选项

  • false

  • true

workflow

字符串

角色作用的工作流作业模板名称、ID 或命名 URL。

已弃用,请使用 'workflows'。

workflows

列表 / 元素=字符串

角色作用的工作流作业模板名称、ID 或命名 URL。

注释

注意

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

  • config_file 应采用以下格式:host=hostname username=username password=password

示例

- name: Add jdoe to the member role of My Team
  role:
    user: jdoe
    target_team: "My Team"
    role: member
    state: present

- name: Add Joe to multiple job templates and a workflow
  role:
    user: joe
    role: execute
    workflows:
      - test-role-workflow
    job_templates:
      - jt1
      - jt2
    state: present

作者

  • Wayne Witzel III (@wwitzel3)