fortinet.fortimanager.fmgr_user_radius_dynamicmapping – Configure RADIUS server entries.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_user_radius_dynamicmapping.

New in version 2.10: of fortinet.fortimanager

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
radius
string / required
the parameter (radius) in requested url
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
user_radius_dynamicmapping
dictionary
the top level parameters set
_scope
list / elements=string
no description
name
string
Name.
vdom
string
Vdom.
accounting-server
list / elements=string
no description
id
integer
ID (0 - 4294967295).
interface
string
Specify outgoing interface to reach server.
interface-select-method
string
    Choices:
  • auto
  • sdwan
  • specify
Specify how to select outgoing interface to reach server.
port
integer
RADIUS accounting port number.
secret
string
no description
server
string
{<name_str|ip_str>} Server CN domain name or IP.
source-ip
string
Source IP address for communications to the RADIUS server.
status
string
    Choices:
  • disable
  • enable
Status.
acct-all-servers
string
    Choices:
  • disable
  • enable
Enable/disable sending of accounting messages to all configured servers (default = disable).
acct-interim-interval
integer
Time in seconds between each accounting interim update message.
all-usergroup
string
    Choices:
  • disable
  • enable
Enable/disable automatically including this RADIUS server in all user groups.
auth-type
string
    Choices:
  • pap
  • chap
  • ms_chap
  • ms_chap_v2
  • auto
Authentication methods/protocols permitted for this RADIUS server.
class
string
no description
dp-carrier-endpoint-attribute
string
    Choices:
  • 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-Attribute.
dp-carrier-endpoint-block-attribute
string
    Choices:
  • 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-context-timeout
integer
Dp-Context-Timeout.
dp-flush-ip-session
string
    Choices:
  • disable
  • enable
Dp-Flush-Ip-Session.
dp-hold-time
integer
Dp-Hold-Time.
dp-http-header
string
Dp-Http-Header.
dp-http-header-fallback
string
    Choices:
  • ip-header-address
  • default-profile
Dp-Http-Header-Fallback.
dp-http-header-status
string
    Choices:
  • disable
  • enable
Dp-Http-Header-Status.
dp-http-header-suppress
string
    Choices:
  • disable
  • enable
Dp-Http-Header-Suppress.
dp-log-dyn_flags
list / elements=string
    Choices:
  • none
  • protocol-error
  • profile-missing
  • context-missing
  • accounting-stop-missed
  • accounting-event
  • radiusd-other
  • endpoint-block
no description
dp-log-period
integer
Dp-Log-Period.
dp-mem-percent
integer
Dp-Mem-Percent.
dp-profile-attribute
string
    Choices:
  • 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.
dp-profile-attribute-key
string
Dp-Profile-Attribute-Key.
dp-radius-response
string
    Choices:
  • disable
  • enable
Dp-Radius-Response.
dp-radius-server-port
integer
Dp-Radius-Server-Port.
dp-secret
string
no description
dp-validate-request-secret
string
    Choices:
  • disable
  • enable
Dp-Validate-Request-Secret.
dynamic-profile
string
    Choices:
  • disable
  • enable
Dynamic-Profile.
endpoint-translation
string
    Choices:
  • disable
  • enable
Endpoint-Translation.
ep-carrier-endpoint-convert-hex
string
    Choices:
  • disable
  • enable
Ep-Carrier-Endpoint-Convert-Hex.
ep-carrier-endpoint-header
string
Ep-Carrier-Endpoint-Header.
ep-carrier-endpoint-header-suppress
string
    Choices:
  • disable
  • enable
Ep-Carrier-Endpoint-Header-Suppress.
ep-carrier-endpoint-prefix
string
    Choices:
  • disable
  • enable
Ep-Carrier-Endpoint-Prefix.
ep-carrier-endpoint-prefix-range-max
integer
Ep-Carrier-Endpoint-Prefix-Range-Max.
ep-carrier-endpoint-prefix-range-min
integer
Ep-Carrier-Endpoint-Prefix-Range-Min.
ep-carrier-endpoint-prefix-string
string
Ep-Carrier-Endpoint-Prefix-String.
ep-carrier-endpoint-source
string
    Choices:
  • http-header
  • cookie
Ep-Carrier-Endpoint-Source.
ep-ip-header
string
Ep-Ip-Header.
ep-ip-header-suppress
string
    Choices:
  • disable
  • enable
Ep-Ip-Header-Suppress.
ep-missing-header-fallback
string
    Choices:
  • session-ip
  • policy-profile
Ep-Missing-Header-Fallback.
ep-profile-query-type
string
    Choices:
  • session-ip
  • extract-ip
  • extract-carrier-endpoint
Ep-Profile-Query-Type.
group-override-attr-type
string
    Choices:
  • filter-Id
  • class
Group-Override-Attr-Type.
h3c-compatibility
string
    Choices:
  • disable
  • enable
Enable/disable compatibility with the H3C, a mechanism that performs security checking for authentication.
interface
string
Specify outgoing interface to reach server.
interface-select-method
string
    Choices:
  • auto
  • sdwan
  • specify
Specify how to select outgoing interface to reach server.
nas-ip
string
IP address used to communicate with the RADIUS server and used as NAS-IP-Address and Called-Station-ID attributes.
password-encoding
string
    Choices:
  • ISO-8859-1
  • auto
Password encoding.
password-renewal
string
    Choices:
  • disable
  • enable
Enable/disable password renewal.
radius-coa
string
    Choices:
  • disable
  • enable
Enable to allow a mechanism to change the attributes of an authentication, authorization, and accounting session after it is a...
radius-port
integer
RADIUS service port number.
rsso
string
    Choices:
  • disable
  • enable
Enable/disable RADIUS based single sign on feature.
rsso-context-timeout
integer
Time in seconds before the logged out user is removed from the "user context list" of logged on users.
rsso-endpoint-attribute
string
    Choices:
  • 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
RADIUS attributes used to extract the user end point identifer from the RADIUS Start record.
rsso-endpoint-block-attribute
string
    Choices:
  • 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
RADIUS attributes used to block a user.
rsso-ep-one-ip-only
string
    Choices:
  • disable
  • enable
Enable/disable the replacement of old IP addresses with new ones for the same endpoint on RADIUS accounting Start messages.
rsso-flush-ip-session
string
    Choices:
  • disable
  • enable
Enable/disable flushing user IP sessions on RADIUS accounting Stop messages.
rsso-log-flags
list / elements=string
    Choices:
  • none
  • protocol-error
  • profile-missing
  • context-missing
  • accounting-stop-missed
  • accounting-event
  • radiusd-other
  • endpoint-block
no description
rsso-log-period
integer
Time interval in seconds that group event log messages will be generated for dynamic profile events.
rsso-radius-response
string
    Choices:
  • disable
  • enable
Enable/disable sending RADIUS response packets after receiving Start and Stop records.
rsso-radius-server-port
integer
UDP port to listen on for RADIUS Start and Stop records.
rsso-secret
string
no description
rsso-validate-request-secret
string
    Choices:
  • disable
  • enable
Enable/disable validating the RADIUS request shared secret in the Start or End record.
secondary-secret
string
no description
secondary-server
string
{<name_str|ip_str>} secondary RADIUS CN domain name or IP.
secret
string
no description
server
string
Primary RADIUS server CN domain name or IP address.
source-ip
string
Source IP address for communications to the RADIUS server.
sso-attribute
string
    Choices:
  • 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
RADIUS attribute that contains the profile group name to be extracted from the RADIUS Start record.
sso-attribute-key
string
Key prefix for SSO group value in the SSO attribute.
sso-attribute-value-override
string
    Choices:
  • disable
  • enable
Enable/disable override old attribute value with new value for the same endpoint.
switch-controller-acct-fast-framedip-detect
integer
Switch-Controller-Acct-Fast-Framedip-Detect.
switch-controller-service-type
list / elements=string
    Choices:
  • login
  • framed
  • callback-login
  • callback-framed
  • outbound
  • administrative
  • nas-prompt
  • authenticate-only
  • callback-nas-prompt
  • call-check
  • callback-administrative
no description
tertiary-secret
string
no description
tertiary-server
string
{<name_str|ip_str>} tertiary RADIUS CN domain name or IP.
timeout
integer
Time in seconds between re-sending authentication requests.
use-group-for-profile
string
    Choices:
  • disable
  • enable
Use-Group-For-Profile.
use-management-vdom
string
    Choices:
  • disable
  • enable
Enable/disable using management VDOM to send requests.
username-case-sensitive
string
    Choices:
  • disable
  • enable
Enable/disable case sensitive user names.
workspace_locking_adom
string
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout
integer
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  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
     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: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  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
     fmgr_fact:
       facts:
           selector: 'user_radius_dynamicmapping'
           params:
               adom: 'ansible'
               radius: 'ansible-test-radius' # name
               dynamic_mapping: ''

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)