fortinet.fortimanager.fmgr_user_radius 模块 – 配置 RADIUS 服务器条目。
注意
此模块是 fortinet.fortimanager 集合（版本 2.8.2）的一部分。
如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install fortinet.fortimanager。
要在 playbook 中使用它，请指定：fortinet.fortimanager.fmgr_user_radius。
fortinet.fortimanager 2.0.0 中的新增功能
概要
此模块能够配置 FortiManager 设备。
示例包括所有参数和值，这些参数和值在使用前需要调整为数据源。
参数
参数 |
注释 |
|---|---|
在不使用用户名和密码的情况下访问 FortiManager 的令牌。 |
|
请求 URL 中的参数 (adom)。 |
|
仅当模块模式与 FortiManager API 结构不同时才设置为 True，模块继续执行而不验证参数。 选项
|
|
启用/禁用任务日志记录。 选项
|
|
使用 forticloud API 访问令牌对 Ansible 客户端进行身份验证。 |
|
基础 Json RPC 请求的覆盖方法。 选项
|
|
将覆盖失败条件的 rc 代码列表。 |
|
将覆盖成功条件的 rc 代码列表。 |
|
创建、更新或删除对象的指令。 选项
|
|
设置的顶层参数。 |
|
定义证书中用于用户访问权限检查的主题标识字段。 选项
|
|
帐户密钥处理操作。 选项
|
|
计费服务器。 |
|
ID |
|
指定用于连接服务器的传出接口。 |
|
指定如何选择用于连接服务器的传出接口。 选项
|
|
RADIUS 计费端口号。 |
|
（列表）密钥。 |
|
无描述 |
|
与 RADIUS 服务器通信的源 IP 地址。 |
|
状态。 选项
|
|
启用/禁用将计费消息发送到所有配置的服务器 选项
|
|
每个计费临时更新消息之间的时间（以秒为单位）。 |
|
启用/禁用自动将此 RADIUS 服务器包括在所有用户组中。 选项
|
|
此 RADIUS 服务器允许的身份验证方法/协议。 选项
|
|
TLS 下要信任的服务器的 CA。 |
|
呼叫和被呼叫站标识符类型配置 选项
|
|
（列表）类属性名称 |
|
TLS 下要使用的客户端证书。 |
|
配置分隔符，用于分隔 SSO 属性中的配置文件组名称 选项
|
|
动态映射。 |
|
范围。 |
|
名称。 |
|
Vdom。 |
|
定义证书中用于用户访问权限检查的主题标识字段。 选项
|
|
帐户密钥处理操作。 选项
|
|
计费服务器。 |
|
Id。 |
|
接口。 |
|
接口选择方法。 选项
|
|
端口。 |
|
（列表）密钥。 |
|
服务器。 |
|
源 IP。 |
|
状态。 选项
|
|
所有计费服务器。 选项
|
|
会计临时间隔。 |
|
所有用户组。 选项
|
|
认证类型。 选项
|
|
TLS 下要信任的服务器的 CA。 |
|
呼叫和被呼叫站标识符类型配置 选项
|
|
（列表）类。 |
|
TLS 下要使用的客户端证书。 |
|
配置分隔符，用于分隔 SSO 属性中的配置文件组名称 选项
|
|
Dp 运营商端点属性。 选项
|
|
Dp 运营商端点阻止属性。 选项
|
|
Dp 上下文超时。 |
|
Dp 刷新 IP 会话。 选项
|
|
Dp 保持时间。 |
|
Dp HTTP 标头。 |
|
Dp HTTP 标头回退。 选项
|
|
Dp HTTP 标头状态。 选项
|
|
Dp HTTP 标头抑制。 选项
|
|
Dp 日志动态标志。 选项
|
|
Dp 日志周期。 |
|
Dp 内存百分比。 |
|
Dp 配置文件属性。 选项
|
|
Dp 配置文件属性键。 |
|
Dp Radius 响应。 选项
|
|
Dp Radius 服务器端口。 |
|
（列表）Dp 密钥。 |
|
Dp 验证请求密钥。 选项
|
|
动态配置文件。 选项
|
|
端点转换。 选项
|
|
Ep 运营商端点转换十六进制。 选项
|
|
Ep 运营商端点标头。 |
|
Ep 运营商端点标头抑制。 选项
|
|
Ep 运营商端点前缀。 选项
|
|
Ep 运营商端点前缀范围最大值。 |
|
Ep 运营商端点前缀范围最小值。 |
|
Ep 运营商端点前缀字符串。 |
|
Ep 运营商端点源。 选项
|
|
Ep IP 标头。 |
|
Ep IP 标头抑制。 选项
|
|
Ep 缺少标头回退。 选项
|
|
Ep 配置文件查询类型。 选项
|
|
组覆盖属性类型。 选项
|
|
H3c 兼容性。 选项
|
|
接口。 |
|
接口选择方法。 选项
|
|
MAC 身份验证大小写 选项
|
|
MAC 身份验证密码分隔符 选项
|
|
MAC 身份验证用户名分隔符 选项
|
|
自定义 NAS 标识符。 |
|
NAS 标识符类型配置 选项
|
|
Nas IP。 |
|
密码编码。 选项
|
|
密码续订。 选项
|
|
Radius Coa。 选项
|
|
Radius 端口。 |
|
Rsso。 选项
|
|
Rsso 上下文超时。 |
|
Rsso 端点属性。 选项
|
|
Rsso 端点阻止属性。 选项
|
|
Rsso ep 仅限一个 IP。 选项
|
|
Rsso 刷新 IP 会话。 选项
|
|
Rsso 日志标志。 选项
|
|
Rsso 日志周期。 |
|
Rsso radius 响应。 选项
|
|
Rsso radius 服务器端口。 |
|
(列表) Rsso 密钥。 |
|
Rsso 验证请求密钥。 选项
|
|
(列表) 辅助密钥。 |
|
辅助服务器。 |
|
（列表）密钥。 |
|
服务器。 |
|
启用/禁用 RADIUS 服务器身份检查。 选项
|
|
源 IP。 |
|
(列表) 与 RADIUS 服务器通信的源接口。 |
|
Sso 属性。 选项
|
|
Sso 属性键。 |
|
Sso 属性值覆盖。 选项
|
|
服务器可达性缓存的时间，以便当服务器无法访问时，至少在... |
|
交换机控制器 acct 快速 framedip 检测。 |
|
启用/禁用交换机控制器 nas-ip 动态设置 nas-ip。 选项
|
|
交换机控制器服务类型。 选项
|
|
(列表) 第三密钥。 |
|
第三服务器。 |
|
超时。 |
|
TLS 连接支持的最低协议版本 选项
|
|
要使用的传输协议 选项
|
|
使用组作为配置文件。 选项
|
|
使用管理 VDOM。 选项
|
|
用户名区分大小写。 选项
|
|
RADIUS 属性类型，用于覆盖用户组信息。 选项
|
|
启用/禁用与 H3C 的兼容性，这是一种执行身份验证安全检查的机制。 选项
|
|
指定用于连接服务器的传出接口。 |
|
指定如何选择用于连接服务器的传出接口。 选项
|
|
MAC 身份验证大小写 选项
|
|
MAC 身份验证密码分隔符 选项
|
|
MAC 身份验证用户名分隔符 选项
|
|
RADIUS 服务器条目名称。 |
|
自定义 NAS 标识符。 |
|
NAS 标识符类型配置 选项
|
|
用于与 RADIUS 服务器通信并用作 NAS-IP-Address 和 Called-Station-ID 属性的 IP 地址。 |
|
密码编码。 选项
|
|
启用/禁用密码更新。 选项
|
|
启用此选项以允许在身份验证、授权和计费会话后更改其属性的机制。 选项
|
|
RADIUS 服务端口号。 |
|
启用/禁用基于 RADIUS 的单点登录功能。 选项
|
|
在注销用户从已登录用户用户上下文列表中移除之前的时间（以秒为单位）。 |
|
用于从 RADIUS Start 记录中提取用户端点标识符的 RADIUS 属性。 选项
|
|
用于阻止用户的 RADIUS 属性。 选项
|
|
启用/禁用在 RADIUS 计费开始消息上，用相同端点的新 IP 地址替换旧 IP 地址。 选项
|
|
启用/禁用在 RADIUS 计费停止消息上刷新用户 IP 会话。 选项
|
|
要记录的事件。 选项
|
|
将为动态配置文件事件生成组事件日志消息的时间间隔（以秒为单位）。 |
|
启用/禁用在接收到开始和停止记录后发送 RADIUS 响应数据包。 选项
|
|
用于侦听 RADIUS 开始和停止记录的 UDP 端口。 |
|
(列表) RADIUS 计费服务器使用的 RADIUS 密钥。 |
|
启用/禁用验证开始或结束记录中的 RADIUS 请求共享密钥。 选项
|
|
(列表) 用于访问辅助服务器的密钥。 |
|
无描述 |
|
(列表) 用于访问主 RADIUS 服务器的预共享密钥。 |
|
主 RADIUS 服务器 CN 域名或 IP 地址。 |
|
启用/禁用 RADIUS 服务器身份检查。 选项
|
|
与 RADIUS 服务器通信的源 IP 地址。 |
|
(列表) 与 RADIUS 服务器通信的源接口。 |
|
包含要从 RADIUS Start 记录中提取的配置文件组名称的 RADIUS 属性。 选项
|
|
SSO 属性中 SSO 组值的前缀键。 |
|
启用/禁用使用相同端点的新值覆盖旧属性值。 选项
|
|
服务器可达性缓存的时间，以便当服务器无法访问时，至少不会重试此... |
|
来自 DHCP 侦听的交换机控制器计费消息 Framed-IP 检测 |
|
启用/禁用交换机控制器 nas-ip 动态设置 nas-ip。 选项
|
|
RADIUS 服务类型。 选项
|
|
(列表) 用于访问第三服务器的密钥。 |
|
无描述 |
|
重新发送身份验证请求之间的时间（以秒为单位）。 |
|
TLS 连接支持的最低协议版本 选项
|
|
要使用的传输协议 选项
|
|
启用/禁用使用管理 VDOM 发送请求。 选项
|
|
启用/禁用区分大小写的用户名。 选项
|
|
要在工作区模式下运行的 FortiManager 中锁定的 adom，该值可以是 global 和其他（包括 root）。 |
|
等待其他用户释放工作区锁定的最长时间（以秒为单位）。 默认: |
备注
注意
从 2.4.0 版本开始，所有输入参数都使用下划线命名约定 (snake_case)。请将诸如 “var-name” 的参数更改为 “var_name”。旧的参数名称仍然可用，但您将收到弃用警告。您可以通过在 ansible.cfg 中设置 deprecation_warnings=False 来忽略此警告。
此 FortiManager 模块支持在工作区锁定模式下运行，顶层参数 workspace_locking_adom 和 workspace_locking_timeout 帮助完成此项工作。
要创建或更新对象，请使用 state present 指令。
要删除对象，请使用 state absent 指令。
通常，当返回非零 rc 时，运行一个模块可能会失败。您还可以使用参数 rc_failed 和 rc_succeeded 来覆盖失败或成功的条件。
示例
- name: Example playbook
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure RADIUS server entries.
fortinet.fortimanager.fmgr_user_radius:
bypass_validation: false
adom: ansible
state: present
user_radius:
name: ansible-test-radius
server: ansible
timeout: 200
- name: Gathering fortimanager facts
hosts: fortimanagers
gather_facts: false
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Retrieve all the RADIUS server entries
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_radius"
params:
adom: "ansible"
radius: "your_value"
返回值
常见的返回值已在此处记录 此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
请求的结果。 返回: 总是 |
|
请求的完整 URL。 返回: 总是 示例: |
|
API 请求的状态。 返回: 总是 示例: |
|
API 响应。 返回: 总是 |
|
API 响应的描述性消息。 返回: 总是 示例: |
|
目标系统的信息。 返回: 总是 |
|
请求的状态。 返回: 总是 示例: |
|
如果 playbook 中使用的参数不受当前 FortiManager 版本支持，则发出警告。 返回: 复杂类型 |