fortinet.fortimanager.fmgr_user_radius_dynamicmapping 模块 – 配置 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_dynamicmapping。

fortinet.fortimanager 2.0.0 中的新增功能

概要

• 此模块能够配置 FortiManager 设备。

• 示例包含所有需要在使用前调整为数据源的参数和值。

参数

参数	注释
access_token 字符串	无需使用用户名和密码即可访问 FortiManager 的令牌。
adom 字符串 / 必填	请求 URL 中的参数 (adom)。
bypass_validation 布尔值	仅当模块模式与 FortiManager API 结构不同时设置为 True，模块将继续执行而无需验证参数。 选项 false ← (默认) true
enable_log 布尔值	启用/禁用任务日志记录。 选项 false ← (默认) true
forticloud_access_token 字符串	使用 forticloud API 访问令牌验证 Ansible 客户端。
proposed_method 字符串	底层 Json RPC 请求的覆盖方法。 选项 "update" "set" "add"
radius 字符串 / 必填	请求 URL 中的参数 (radius)。
rc_failed 列表 / 元素=整数	将覆盖失败条件的 rc 代码列表。
rc_succeeded 列表 / 元素=整数	将覆盖成功条件的 rc 代码列表。
state 字符串 / 必填	创建、更新或删除对象的指令。 选项 "present" "absent"
user_radius_dynamicmapping 字典	设置的顶级参数。
_scope 列表 / 元素=字典	范围。
name 字符串	名称。
vdom 字符串	Vdom。
account_key_cert_field 别名：account-key-cert-field 字符串	定义证书中用于用户访问权限检查的主题标识字段。 选项 "othername" "rfc822name" "dnsname" "cn"
account_key_processing 别名：account-key-processing 字符串	帐户密钥处理操作。 选项 "same" "strip"
accounting_server 别名：accounting-server 列表 / 元素=字典	计费服务器。
id 整数	ID。
interface 字符串	接口。
interface_select_method 别名：interface-select-method 字符串	接口选择方法。 选项 "auto" "sdwan" "specify"
port 整数	端口。
secret 任意	(列表) 密钥。
server 字符串	服务器。
source_ip 别名：source-ip 字符串	源IP。
status 字符串	状态。 选项 "disable" "enable"
acct_all_servers 别名：acct-all-servers 字符串	所有计费服务器。 选项 "disable" "enable"
acct_interim_interval 别名：acct-interim-interval 整数	计费中间间隔。
all_usergroup 别名：all-usergroup 字符串	所有用户组。 选项 "disable" "enable"
auth_type 别名：auth-type 字符串	认证类型。 选项 "pap" "chap" "ms_chap" "ms_chap_v2" "auto"
ca_cert 别名：ca-cert 字符串	TLS 下信任的服务器 CA。
call_station_id_type 别名：call-station-id-type 字符串	呼叫和被叫站标识符类型配置 选项 "legacy" "IP" "MAC"
class 任意	(列表) 类别。
client_cert 别名：client-cert 字符串	TLS 下使用的客户端证书。
delimiter 字符串	配置用于分隔 SSO 属性中配置文件组名称的分隔符 选项 "plus" "comma"
dp_carrier_endpoint_attribute 别名：dp-carrier-endpoint-attribute 字符串	Dp 载波端点属性。 选项 "User-Name" "User-Password" "CHAP-Password" "NAS-IP-Address" "NAS-Port" "Service-Type" "Framed-Protocol" "Framed-IP-Address" "Framed-IP-Netmask" "Framed-Routing" "Filter-Id" "Framed-MTU" "Framed-Compression" "Login-IP-Host" "Login-Service" "Login-TCP-Port" "Reply-Message" "Callback-Number" "Callback-Id" "Framed-Route" "Framed-IPX-Network" "State" "Class" "Vendor-Specific" "Session-Timeout" "Idle-Timeout" "Termination-Action" "Called-Station-Id" "Calling-Station-Id" "NAS-Identifier" "Proxy-State" "Login-LAT-Service" "Login-LAT-Node" "Login-LAT-Group" "Framed-AppleTalk-Link" "Framed-AppleTalk-Network" "Framed-AppleTalk-Zone" "Acct-Status-Type" "Acct-Delay-Time" "Acct-Input-Octets" "Acct-Output-Octets" "Acct-Session-Id" "Acct-Authentic" "Acct-Session-Time" "Acct-Input-Packets" "Acct-Output-Packets" "Acct-Terminate-Cause" "Acct-Multi-Session-Id" "Acct-Link-Count" "CHAP-Challenge" "NAS-Port-Type" "Port-Limit" "Login-LAT-Port"
dp_carrier_endpoint_block_attribute 别名：dp-carrier-endpoint-block-attribute 字符串	Dp 载波端点阻塞属性。 选项 "User-Name" "User-Password" "CHAP-Password" "NAS-IP-Address" "NAS-Port" "Service-Type" "Framed-Protocol" "Framed-IP-Address" "Framed-IP-Netmask" "Framed-Routing" "Filter-Id" "Framed-MTU" "Framed-Compression" "Login-IP-Host" "Login-Service" "Login-TCP-Port" "Reply-Message" "Callback-Number" "Callback-Id" "Framed-Route" "Framed-IPX-Network" "State" "Class" "Vendor-Specific" "Session-Timeout" "Idle-Timeout" "Termination-Action" "Called-Station-Id" "Calling-Station-Id" "NAS-Identifier" "Proxy-State" "Login-LAT-Service" "Login-LAT-Node" "Login-LAT-Group" "Framed-AppleTalk-Link" "Framed-AppleTalk-Network" "Framed-AppleTalk-Zone" "Acct-Status-Type" "Acct-Delay-Time" "Acct-Input-Octets" "Acct-Output-Octets" "Acct-Session-Id" "Acct-Authentic" "Acct-Session-Time" "Acct-Input-Packets" "Acct-Output-Packets" "Acct-Terminate-Cause" "Acct-Multi-Session-Id" "Acct-Link-Count" "CHAP-Challenge" "NAS-Port-Type" "Port-Limit" "Login-LAT-Port"
dp_context_timeout 别名：dp-context-timeout 整数	Dp 上下文超时。
dp_flush_ip_session 别名：dp-flush-ip-session 字符串	Dp 清除 IP 会话。 选项 "disable" "enable"
dp_hold_time 别名：dp-hold-time 整数	Dp 保持时间。
dp_http_header 别名：dp-http-header 字符串	Dp HTTP 头。
dp_http_header_fallback 别名：dp-http-header-fallback 字符串	Dp HTTP 头回退。 选项 "ip-header-address" "default-profile"
dp_http_header_status 别名：dp-http-header-status 字符串	Dp HTTP 头状态。 选项 "disable" "enable"
dp_http_header_suppress 别名：dp-http-header-suppress 字符串	Dp HTTP 头抑制。 选项 "disable" "enable"
dp_log_dyn_flags 别名：dp-log-dyn_flags 列表 / 元素=字符串	Dp 日志动态标志。 选项 "none" "protocol-error" "profile-missing" "context-missing" "accounting-stop-missed" "accounting-event" "radiusd-other" "endpoint-block"
dp_log_period 别名：dp-log-period 整数	Dp 日志周期。
dp_mem_percent 别名：dp-mem-percent 整数	Dp 内存百分比。
dp_profile_attribute 别名：dp-profile-attribute 字符串	Dp 配置文件属性。 选项 "User-Name" "User-Password" "CHAP-Password" "NAS-IP-Address" "NAS-Port" "Service-Type" "Framed-Protocol" "Framed-IP-Address" "Framed-IP-Netmask" "Framed-Routing" "Filter-Id" "Framed-MTU" "Framed-Compression" "Login-IP-Host" "Login-Service" "Login-TCP-Port" "Reply-Message" "Callback-Number" "Callback-Id" "Framed-Route" "Framed-IPX-Network" "State" "Class" "Vendor-Specific" "Session-Timeout" "Idle-Timeout" "Termination-Action" "Called-Station-Id" "Calling-Station-Id" "NAS-Identifier" "Proxy-State" "Login-LAT-Service" "Login-LAT-Node" "Login-LAT-Group" "Framed-AppleTalk-Link" "Framed-AppleTalk-Network" "Framed-AppleTalk-Zone" "Acct-Status-Type" "Acct-Delay-Time" "Acct-Input-Octets" "Acct-Output-Octets" "Acct-Session-Id" "Acct-Authentic" "Acct-Session-Time" "Acct-Input-Packets" "Acct-Output-Packets" "Acct-Terminate-Cause" "Acct-Multi-Session-Id" "Acct-Link-Count" "CHAP-Challenge" "NAS-Port-Type" "Port-Limit" "Login-LAT-Port"
dp_profile_attribute_key 别名：dp-profile-attribute-key 字符串	Dp 配置文件属性键。
dp_radius_response 别名：dp-radius-response 字符串	Dp Radius 响应。 选项 "disable" "enable"
dp_radius_server_port 别名：dp-radius-server-port 整数	Dp Radius 服务器端口。
dp_secret 别名：dp-secret 任意	(列表) Dp 密钥。
dp_validate_request_secret 别名：dp-validate-request-secret 字符串	Dp 验证请求密钥。 选项 "disable" "enable"
dynamic_profile 别名：dynamic-profile 字符串	动态配置文件。 选项 "disable" "enable"
endpoint_translation 别名：endpoint-translation 字符串	端点转换。 选项 "disable" "enable"
ep_carrier_endpoint_convert_hex 别名：ep-carrier-endpoint-convert-hex 字符串	Ep 载波端点转换为十六进制。 选项 "disable" "enable"
ep_carrier_endpoint_header 别名：ep-carrier-endpoint-header 字符串	Ep 载波端点头。
ep_carrier_endpoint_header_suppress 别名：ep-carrier-endpoint-header-suppress 字符串	Ep 载波端点头抑制。 选项 "disable" "enable"
ep_carrier_endpoint_prefix 别名：ep-carrier-endpoint-prefix 字符串	Ep 载波端点前缀。 选项 "disable" "enable"
ep_carrier_endpoint_prefix_range_max 别名：ep-carrier-endpoint-prefix-range-max 整数	Ep 载波端点前缀范围最大值。
ep_carrier_endpoint_prefix_range_min 别名：ep-carrier-endpoint-prefix-range-min 整数	Ep 载波端点前缀范围最小值。
ep_carrier_endpoint_prefix_string 别名：ep-carrier-endpoint-prefix-string 字符串	Ep 载波端点前缀字符串。
ep_carrier_endpoint_source 别名：ep-carrier-endpoint-source 字符串	Ep 载波端点来源。 选项 "http-header" "cookie"
ep_ip_header 别名：ep-ip-header 字符串	Ep IP 头。
ep_ip_header_suppress 别名：ep-ip-header-suppress 字符串	Ep IP 头抑制。 选项 "disable" "enable"
ep_missing_header_fallback 别名：ep-missing-header-fallback 字符串	Ep 缺少头回退。 选项 "session-ip" "policy-profile"
ep_profile_query_type 别名：ep-profile-query-type 字符串	Ep 配置文件查询类型。 选项 "session-ip" "extract-ip" "extract-carrier-endpoint"
group_override_attr_type 别名：group-override-attr-type 字符串	组覆盖属性类型。 选项 "filter-Id" "class"
h3c_compatibility 别名：h3c-compatibility 字符串	H3C 兼容性。 选项 "disable" "enable"
interface 字符串	接口。
interface_select_method 别名：interface-select-method 字符串	接口选择方法。 选项 "auto" "sdwan" "specify"
mac_case 别名：mac-case 字符串	MAC 认证大小写。 选项 "uppercase" "lowercase"
mac_password_delimiter 别名：mac-password-delimiter 字符串	MAC 认证密码分隔符 选项 "hyphen" "single-hyphen" "colon" "none"
mac_username_delimiter 别名：mac-username-delimiter 字符串	MAC 认证用户名分隔符 选项 "hyphen" "single-hyphen" "colon" "none"
nas_id 别名：nas-id 字符串	自定义 NAS 标识符。
nas_id_type 别名：nas-id-type 字符串	NAS 标识符类型配置 选项 "legacy" "custom" "hostname"
nas_ip 别名：nas-ip 字符串	Nas IP。
password_encoding 别名：password-encoding 字符串	密码编码。 选项 "ISO-8859-1" "auto"
password_renewal 别名：password-renewal 字符串	密码更新。 选项 "disable" "enable"
radius_coa 别名：radius-coa 字符串	Radius COA。 选项 "disable" "enable"
radius_port 别名：radius-port 整数	Radius 端口。
rsso 字符串	Rsso。 选项 "disable" "enable"
rsso_context_timeout 别名：rsso-context-timeout 整数	Rsso 上下文超时。
rsso_endpoint_attribute 别名：rsso-endpoint-attribute 字符串	Rsso 端点属性。 选项 "User-Name" "User-Password" "CHAP-Password" "NAS-IP-Address" "NAS-Port" "Service-Type" "Framed-Protocol" "Framed-IP-Address" "Framed-IP-Netmask" "Framed-Routing" "Filter-Id" "Framed-MTU" "Framed-Compression" "Login-IP-Host" "Login-Service" "Login-TCP-Port" "Reply-Message" "Callback-Number" "Callback-Id" "Framed-Route" "Framed-IPX-Network" "State" "Class" "Session-Timeout" "Idle-Timeout" "Termination-Action" "Called-Station-Id" "Calling-Station-Id" "NAS-Identifier" "Proxy-State" "Login-LAT-Service" "Login-LAT-Node" "Login-LAT-Group" "Framed-AppleTalk-Link" "Framed-AppleTalk-Network" "Framed-AppleTalk-Zone" "Acct-Status-Type" "Acct-Delay-Time" "Acct-Input-Octets" "Acct-Output-Octets" "Acct-Session-Id" "Acct-Authentic" "Acct-Session-Time" "Acct-Input-Packets" "Acct-Output-Packets" "Acct-Terminate-Cause" "Acct-Multi-Session-Id" "Acct-Link-Count" "CHAP-Challenge" "NAS-Port-Type" "Port-Limit" "Login-LAT-Port"
rsso_endpoint_block_attribute 别名：rsso-endpoint-block-attribute 字符串	Rsso 端点阻塞属性。 选项 "User-Name" "User-Password" "CHAP-Password" "NAS-IP-Address" "NAS-Port" "Service-Type" "Framed-Protocol" "Framed-IP-Address" "Framed-IP-Netmask" "Framed-Routing" "Filter-Id" "Framed-MTU" "Framed-Compression" "Login-IP-Host" "Login-Service" "Login-TCP-Port" "Reply-Message" "Callback-Number" "Callback-Id" "Framed-Route" "Framed-IPX-Network" "State" "Class" "Session-Timeout" "Idle-Timeout" "Termination-Action" "Called-Station-Id" "Calling-Station-Id" "NAS-Identifier" "Proxy-State" "Login-LAT-Service" "Login-LAT-Node" "Login-LAT-Group" "Framed-AppleTalk-Link" "Framed-AppleTalk-Network" "Framed-AppleTalk-Zone" "Acct-Status-Type" "Acct-Delay-Time" "Acct-Input-Octets" "Acct-Output-Octets" "Acct-Session-Id" "Acct-Authentic" "Acct-Session-Time" "Acct-Input-Packets" "Acct-Output-Packets" "Acct-Terminate-Cause" "Acct-Multi-Session-Id" "Acct-Link-Count" "CHAP-Challenge" "NAS-Port-Type" "Port-Limit" "Login-LAT-Port"
rsso_ep_one_ip_only 别名：rsso-ep-one-ip-only 字符串	Rsso 仅一个 IP。 选项 "disable" "enable"
rsso_flush_ip_session 别名: rsso-flush-ip-session 字符串	Rsso 清理 IP 会话。 选项 "disable" "enable"
rsso_log_flags 别名: rsso-log-flags 列表 / 元素=字符串	Rsso 日志标志。 选项 "none" "protocol-error" "profile-missing" "context-missing" "accounting-stop-missed" "accounting-event" "radiusd-other" "endpoint-block"
rsso_log_period 别名: rsso-log-period 整数	Rsso 日志周期。
rsso_radius_response 别名: rsso-radius-response 字符串	Rsso Radius 响应。 选项 "disable" "enable"
rsso_radius_server_port 别名: rsso-radius-server-port 整数	Rsso Radius 服务器端口。
rsso_secret 别名: rsso-secret 任意	(列表) Rsso 密钥。
rsso_validate_request_secret 别名: rsso-validate-request-secret 字符串	Rsso 验证请求密钥。 选项 "disable" "enable"
secondary_secret 别名: secondary-secret 任意	(列表) 次要密钥。
secondary_server 别名: secondary-server 字符串	次要服务器。
密钥 任意	(列表) 密钥。
服务器 字符串	服务器。
server_identity_check 别名: server-identity-check 字符串	启用/禁用 RADIUS 服务器身份验证。 选项 "disable" "enable"
source_ip 别名：source-ip 字符串	源IP。
source_ip_interface 别名: source-ip-interface 任意	(列表) 与 RADIUS 服务器通信的源接口。
sso_attribute 别名: sso-attribute 字符串	SSO 属性。 选项 "User-Name" "User-Password" "CHAP-Password" "NAS-IP-Address" "NAS-Port" "Service-Type" "Framed-Protocol" "Framed-IP-Address" "Framed-IP-Netmask" "Framed-Routing" "Filter-Id" "Framed-MTU" "Framed-Compression" "Login-IP-Host" "Login-Service" "Login-TCP-Port" "Reply-Message" "Callback-Number" "Callback-Id" "Framed-Route" "Framed-IPX-Network" "State" "Class" "Session-Timeout" "Idle-Timeout" "Termination-Action" "Called-Station-Id" "Calling-Station-Id" "NAS-Identifier" "Proxy-State" "Login-LAT-Service" "Login-LAT-Node" "Login-LAT-Group" "Framed-AppleTalk-Link" "Framed-AppleTalk-Network" "Framed-AppleTalk-Zone" "Acct-Status-Type" "Acct-Delay-Time" "Acct-Input-Octets" "Acct-Output-Octets" "Acct-Session-Id" "Acct-Authentic" "Acct-Session-Time" "Acct-Input-Packets" "Acct-Output-Packets" "Acct-Terminate-Cause" "Acct-Multi-Session-Id" "Acct-Link-Count" "CHAP-Challenge" "NAS-Port-Type" "Port-Limit" "Login-LAT-Port"
sso_attribute_key 别名: sso-attribute-key 字符串	SSO 属性键。
sso_attribute_value_override 别名: sso-attribute-value-override 字符串	SSO 属性值覆盖。 选项 "disable" "enable"
status_ttl 别名: status-ttl 整数	服务器可达性缓存时间，当服务器不可达时，至少在此时间内不会重试……
switch_controller_acct_fast_framedip_detect 别名: switch-controller-acct-fast-framedip-detect 整数	交换机控制器帐户快速帧IP检测。
switch_controller_nas_ip_dynamic 别名: switch-controller-nas-ip-dynamic 字符串	启用/禁用交换机控制器 nas-ip 动态设置以动态设置 nas-ip。 选项 "disable" "enable"
switch_controller_service_type 别名: switch-controller-service-type 列表 / 元素=字符串	交换机控制器服务类型。 选项 "登录" "帧" "回调登录" "回调帧" "出站" "管理" "nas 提示" "仅身份验证" "回调 nas 提示" "呼叫检查" "回调管理"
tertiary_secret 别名: tertiary-secret 任意	(列表) 第三方密钥。
tertiary_server 别名: tertiary-server 字符串	第三方服务器。
超时 整数	超时。
tls_min_proto_version 别名: tls-min-proto-version 字符串	TLS 连接支持的最低协议版本 选项 "默认" "TLSv1" "TLSv1.1" "TLSv1.2" "SSLv3" "TLSv1.3"
transport_protocol 别名: transport-protocol 字符串	要使用的传输协议 选项 "udp" "tcp" "tls"
use_group_for_profile 别名: use-group-for-profile 字符串	使用组作为配置文件。 选项 "disable" "enable"
use_management_vdom 别名: use-management-vdom 字符串	使用管理vdom。 选项 "disable" "enable"
username_case_sensitive 别名: username-case-sensitive 字符串	用户名大小写敏感。 选项 "disable" "enable"
workspace_locking_adom 字符串	在工作区模式下运行 FortiManager 时要锁定的 ADOM，值可以是全局和其他值，包括 root。
workspace_locking_timeout 整数	等待其他用户释放工作区锁定的最大时间（秒）。 默认值: 300

注释

注意

• 从 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 dynamic mappings of RADIUS server
      fortinet.fortimanager.fmgr_user_radius_dynamicmapping:
        bypass_validation: false
        adom: ansible
        radius: ansible-test-radius # name
        state: present
        user_radius_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          server: ansible
          timeout: 100

- 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 dynamic mappings of RADIUS server
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_radius_dynamicmapping"
          params:
            adom: "ansible"
            radius: "ansible-test-radius" # name
            dynamic_mapping: "your_value"

返回值

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

键	描述
meta 字典	请求的结果。 返回值: 始终
request_url 字符串	请求的完整 URL。 返回值: 始终 示例: "/sys/login/user"
response_code 整数	API 请求的状态。 返回值: 始终 示例: 0
response_data 列表 / 元素=字符串	API 响应。 返回值: 始终
response_message 字符串	API 响应的描述性消息。 返回值: 始终 示例: "OK."
system_information 字典	目标系统的信息。 返回值: 始终
rc 整数	请求的状态。 返回值: 始终 示例: 0
version_check_warning 列表 / 元素=字符串	如果剧本中使用的参数不受当前 FortiManager 版本支持，则会发出警告。 返回值: 复杂

作者

• 杜欣伟 (@dux-fortinet)

• 李兴 (@lix-fortinet)

• 薛杰 (@JieX19)

• 郑链 (@chillancezen)

• 沈芳 (@fshen01)

• 卢洪斌 (@fgtdev-hblu)

收藏链接

• 问题跟踪器
• 主页
• 代码库 (源代码)