f5networks.f5_modules.bigip_device_auth_radius 模块 – 在 BIG-IP 设备上管理 RADIUS 身份验证配置

注意

此模块是 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_device_auth_radius

f5networks.f5_modules 1.3.0 中的新增功能

概要

  • 模块创建 RADIUS 配置。

参数

参数

注释

accounting_bug

布尔值

启用或禁用计费响应向量的验证。

此选项仅在较旧的服务器上可能需要。

选项

  • false

  • true

fallback_to_local

布尔值

指定如果远程身份验证方法不可用,则系统使用本地身份验证方法。

此选项仅在 TMOS 13.0.0 及更高版本上可用。

选项

  • false

  • true

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 ← (默认)

retries

整数

指定 BIG-IP 本地流量管理系统在身份验证失败前允许的身份验证重试次数。

servers

列表 / 元素=字符串

指定与 RADIUS 身份验证配置文件一起使用的 RADIUS 服务器的名称。

service_type

字符串

指定向 RADIUS 服务器请求的服务类型。默认值为 authenticate-only

选项

  • "authenticate-only"

  • "login"

  • "default"

  • "framed"

  • "callback-login"

  • "callback-framed"

  • "outbound"

  • "administrative"

  • "nas-prompt"

  • "callback-nas-prompt"

  • "call-check"

  • "callback-administrative"

state

字符串

statepresent 时,确保 RADIUS 服务器存在。

stateabsent 时,确保 RADIUS 服务器被移除。

选项

  • "present" ← (默认)

  • "absent"

use_for_auth

布尔值

指定此身份验证源是否在系统中使用。

如果 true,模块将当前系统身份验证类型设置为 radius 的值。

如果 false,模块将身份验证类型设置为 local,类似于 stateabsent 的情况,但不会删除已配置的 RADIUS 资源。

选项

  • false

  • true

备注

注意

  • 此模块基于 RADIUS 身份验证的命令行 (TMSH) 配置功能,而不是 GUI。

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

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

  • F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 特定的配置持久保存到磁盘,请确保至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参考模块文档了解保存运行配置的正确使用方法。

示例

- name: Create an RADIUS device configuration
  bigip_device_auth_radius:
    servers:
      - "ansible_test1"
      - "ansible_test2"
    retries: 3
    service_type: authenticate-only
    accounting_bug: false
    use_for_auth: true
    fallback_to_local: true
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update an RADIUS device configuration
  bigip_device_auth_radius:
    retries: 5
    service_type: administrative
    accounting_bug: true
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Delete RADIUS auth configuration
  bigip_device_auth_radius:
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

描述

accounting_bug

布尔值

启用或禁用计费响应向量的验证。

返回:changed

示例: true

retries

整数

身份验证失败前尝试身份验证的次数。

返回:changed

示例: 10

servers

列表 / 元素=字符串

资源的服务器值。

返回:changed

示例: ["hash/dictionary of values"]

service_type

字符串

向 RADIUS 服务器请求的服务类型。

返回:changed

示例: "login"

作者

  • Andrey Kashcheev (@andreykashcheev)

  • Wojciech Wypior (@wojtek0806)