f5networks.f5_modules.bigip_remote_role 模块 – 管理 BIG-IP 上的远程角色

注意

此模块是 f5networks.f5_modules 集合（版本 1.32.1）的一部分。

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

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定：f5networks.f5_modules.bigip_remote_role。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP 系统上的远程角色。远程角色用于在外部处理用户身份验证的情况下。对 BIG-IP 的本地访问控制由定义的远程角色控制，身份验证（以及扩展的角色分配）在外部处理。

参数

参数	注释
assigned_role 字符串	指定帐户的授权（访问级别）。 创建新的远程角色时，如果未提供此参数，则默认值为 none。 partition_access 参数控制帐户可以访问哪些分区。 您选择的角色可能会影响允许指定的分区。具体来说，诸如 administrator、auditor 和 resource-administrator 之类的角色需要 partition_access 为 all。 系统附带一组预先存在的角色。它们是 none、guest、operator、application-editor、manager、certificate-manager、irule-manager、user-manager、resource-administrator、auditor、administrator 和 firewall-manager。
attribute_string 字符串	指定以 cn=, ou=, dc= 格式保存在组中的用户帐户属性。 创建新的远程角色时，此参数是必需的。
line_order 整数	指定文件 /config/bigip/auth/remoterole 中行的顺序。 LDAP 和 Active Directory 服务器逐行读取此文件。 信息的顺序很重要；因此，F5 建议您将第一行设置为 1000。这允许您将来在第一行之前插入行。 创建新的远程角色时，此参数是必需的。
name 字符串 / 必需	指定远程角色的名称。
partition_access 字符串	指定帐户可访问的分区。 此参数支持保留名称 all 和 Common，以及用户可以访问的特定分区。 可以访问分区的用户可以操作该分区中的对象，这由用户的 assigned_role 授予的权限确定。 创建新的远程角色时，如果未指定此参数，则默认值为 all。
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
auth_provider 字符串	配置身份验证提供程序以从远程设备获取身份验证令牌。 此选项实际上在使用 BIG-IQ 设备时使用。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 以前使用的变量 F5_TEEM 已被弃用，因为它的名称令人困惑。 选择 false ←（默认） true
密码 别名: pass, pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
服务器 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
服务器端口 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值: 443
超时 整数	指定与网络设备通信（用于连接或发送命令）的超时时间（以秒为单位）。 如果在操作完成之前超过超时时间，模块将报错。
传输 字符串	配置连接到远程设备时使用的传输连接。 选择 "rest" ← (默认)
用户 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。 该用户必须在设备上具有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
验证证书 布尔值	如果为 no，则不验证 SSL 证书。 仅在个人控制的使用自签名证书的站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选择 false true ← (默认)
远程访问 布尔值	启用或禁用指定远程身份验证用户组的远程访问。 创建新的远程角色时，如果未指定此参数，则默认为 true。 选择 false true
状态 字符串	当为 present 时，保证远程角色存在。 当为 absent 时，从系统中删除远程角色。 选择 "absent" "present" ← (默认)
终端访问 字符串	指定未明确分配用户角色的远程帐户的基于终端的访问权限。 此参数的常见值包括 tmsh 和 none，但您也可以指定自定义值。 创建新的远程角色时，如果未指定此参数，则默认为 none。

说明

注意

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。

• 需要 BIG-IP 软件版本 >= 12。

• F5 模块仅操作 F5 产品的运行配置。 要确保 BIG-IP 的特定配置持久化到磁盘，请务必至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。 有关正确使用该模块来保存运行配置，请参阅该模块的文档。

示例

- name: Create a remote role
  bigip_remote_role:
    name: ldap_group
    line_order: 1
    attribute_string: memberOf=cn=ldap_group,cn=ldap.group,ou=ldap
    remote_access: true
    assigned_role: administrator
    partition_access: all
    terminal_access: none
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
assigned_role 字符串	此远程角色关联的系统角色。 返回: changed 示例: "administrator"
attribute_string 字符串	资源的新的属性字符串。 返回: changed 示例: "memberOf=cn=ldap_group,cn=ldap.group,ou=ldap"
line_order 整数	LDAP 和 Active Directory 服务器的远程角色的顺序。 返回: changed 示例: 1000
partition_access 字符串	角色有权访问的分区。 返回: changed 示例: "all"
远程访问 布尔值	是否允许远程访问。 返回: changed 示例: false
终端访问 字符串	远程角色的终端设置。 返回: changed 示例: "tmsh"

作者

• Tim Rupp (@caphrim007)

集合链接

• 问题跟踪器
• 主页
• 存储库（源）