f5networks.f5_modules.bigip_device_auth_radius_server 模块 – 管理设备的 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_server

f5networks.f5_modules 1.3.0 中的新增功能

概要

  • 管理设备的 RADIUS 服务器配置。

  • bigip_device_auth_radius 模块一起使用。

参数

参数

注释

描述

字符串

RADIUS 服务器的描述。

ip

字符串

服务器的 IP 地址。

创建新资源时,此参数是必需的。

名称

字符串 / 必需

指定要管理的 RADIUS 服务器的名称。

分区

字符串

用于管理资源的设备分区。

默认值: "Common"

端口

整数

服务器的端口。

有效值范围是 065535(包括两者)。

提供程序

字典

在 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 来省略此选项。

server_port

整数

BIG-IP 服务器端口。

您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。

默认值: 443

超时

整数

指定与网络设备通信时(用于连接或发送命令)的超时秒数。 如果在操作完成之前超出超时时间,则模块将出错。

传输

字符串

配置连接到远程设备时使用的传输连接。

选择

  • "rest" ← (默认)

用户

字符串 / 必需

用于连接到 BIG-IP 或 BIG-IQ 的用户名。 此用户必须具有设备上的管理权限。

您可以通过设置环境变量 F5_USER 来省略此选项。

validate_certs

布尔值

如果为 no,则不验证 SSL 证书。 仅在个人控制的使用自签名证书的站点上使用此选项。

您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。

选择

  • false

  • true ← (默认)

密钥

字符串

指定用于访问 RADIUS 服务器的密钥。

创建新资源时,此参数是必需的。

状态

字符串

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

stateabsent 时,确保删除 RADIUS 服务器。

选择

  • "present" ← (默认)

  • "absent"(缺席)

超时

整数

指定超时值,单位为秒。

有效值的范围为 160,包括边界值。

update_secret

字符串

always 如果指定了 secret,则始终更新密码。

on_create 仅为新创建的服务器设置密码。

选择

  • "always" ← (默认)

  • "on_create"

注释

注意

  • 有关使用 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 RADIUS server configuration
  bigip_device_auth_radius_server:
    name: "ansible_test"
    ip: "1.1.1.1"
    port: 1812
    secret: "secret"
    timeout: 5
    update_secret: on_create
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update RADIUS server configuration
  bigip_device_auth_radius_server:
    name: "ansible_test"
    ip: "10.10.10.1"
    description: "this is a test"
    port: 1813
    timeout: 10
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove RADIUS server configuration
  bigip_device_auth_radius_server:
    name: "ansible_test"
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

通用返回值记录在这里,以下是此模块特有的字段

描述

描述

字符串

用户定义的 RADIUS 服务器描述。

返回: changed (已更改)

示例: "this is my server"

ip

字符串

RADIUS 服务器的 IP 地址。

返回: changed (已更改)

示例: "1.1.1.1"

端口

整数

RADIUS 服务端口。

返回: changed (已更改)

示例: 1812

超时

整数

超时值。

返回: changed (已更改)

示例: 3

作者

  • Wojciech Wypior (@wojtek0806)