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` 参数控制帐户可以访问哪些分区。您选择的角色可能会影响允许指定的 partition。具体来说，`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 字符串	配置 auth 提供程序以从远程设备获取身份验证令牌。此选项在使用 BIG-IQ 设备时非常有用。
no_f5_teem 布尔值	如果为 `yes`，则不会将 TEEM 遥测数据发送到 F5。您可以通过设置环境变量 `F5_TELEMETRY_OFF` 来省略此选项。以前使用的变量 `F5_TEEM` 已弃用，因为其名称令人困惑。选项 `false` ← (默认) `true`
password 别名：pass、pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。您可以通过设置环境变量 `F5_PASSWORD` 来省略此选项。
server 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。您可以通过设置环境变量 `F5_SERVER` 来省略此选项。
server_port 整数	BIG-IP 服务器端口。您可以通过设置环境变量 `F5_SERVER_PORT` 来省略此选项。默认值： `443`
timeout 整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超时，则模块将出错。
transport 字符串	配置连接到远程设备时使用的传输连接。选项 `"rest"` ← (默认)
user 字符串 / 必需	连接 BIG-IP 或 BIG-IQ 的用户名。此用户必须拥有设备上的管理员权限。您可以通过设置环境变量`F5_USER`来省略此选项。
validate_certs 布尔值	如果为`no`，则不会验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。您可以通过设置环境变量`F5_VALIDATE_CERTS`来省略此选项。选项 `false` `true` ← (默认)
remote_access 布尔值	启用或禁用指定远程认证用户组的远程访问。创建新的远程角色时，如果未指定此参数，则默认为`true`。选项 `false` `true`
state 字符串	当`present`时，保证远程角色存在。当`absent`时，从系统中移除远程角色。选项 `"absent"` `"present"` ← (默认)
terminal_access 字符串	指定尚未明确分配用户角色的远程帐户的基于终端的可访问性。此处的常用值包括`tmsh`和`none`，但您也可以指定自定义值。创建新的远程角色时，如果未指定此参数，则默认为`none`。

注释 

注意

有关使用 Ansible 管理 F5 网络设备的更多信息，请参见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"`
remote_access 布尔值	是否允许远程访问。返回：changed 示例：`false`
terminal_access 字符串	远程角色的终端设置。返回：changed 示例：`"tmsh"`

作者

Tim Rupp (@caphrim007)