W3cubDocs

/Ansible

fortinet.fortios.fortios_user_radius – Configure RADIUS server entries in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_user_radius.

New in version 2.10: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and radius category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no
  • yes
Enable/Disable logging for task.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
user_radius
dictionary
Configure RADIUS server entries.
accounting_server
list / elements=string
Additional accounting servers.
id
integer / required
ID (0 - 4294967295).
interface
string
Specify outgoing interface to reach server. Source system.interface.name.
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
Secret key.
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:
  • enable
  • disable
Status.
acct_all_servers
string
    Choices:
  • enable
  • disable
Enable/disable sending of accounting messages to all configured servers .
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:
  • auto
  • ms_chap_v2
  • ms_chap
  • chap
  • pap
Authentication methods/protocols permitted for this RADIUS server.
class
list / elements=string
Class attribute name(s).
name
string / required
Class name.
group_override_attr_type
string
    Choices:
  • filter-Id
  • class
RADIUS attribute type to override user group information.
h3c_compatibility
string
    Choices:
  • enable
  • disable
Enable/disable compatibility with the H3C, a mechanism that performs security checking for authentication.
interface
string
Specify outgoing interface to reach server. Source system.interface.name.
interface_select_method
string
    Choices:
  • auto
  • sdwan
  • specify
Specify how to select outgoing interface to reach server.
name
string / required
RADIUS server entry name.
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:
  • auto
  • ISO-8859-1
Password encoding.
password_renewal
string
    Choices:
  • enable
  • disable
Enable/disable password renewal.
radius_coa
string
    Choices:
  • enable
  • disable
Enable to allow a mechanism to change the attributes of an authentication, authorization, and accounting session after it is authenticated.
radius_port
integer
RADIUS service port number.
rsso
string
    Choices:
  • enable
  • disable
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
  • NAS-IP-Address
  • Framed-IP-Address
  • Framed-IP-Netmask
  • Filter-Id
  • Login-IP-Host
  • Reply-Message
  • Callback-Number
  • Callback-Id
  • Framed-Route
  • Framed-IPX-Network
  • Class
  • Called-Station-Id
  • Calling-Station-Id
  • NAS-Identifier
  • Proxy-State
  • Login-LAT-Service
  • Login-LAT-Node
  • Login-LAT-Group
  • Framed-AppleTalk-Zone
  • Acct-Session-Id
  • Acct-Multi-Session-Id
RADIUS attributes used to extract the user end point identifer from the RADIUS Start record.
rsso_endpoint_block_attribute
string
    Choices:
  • User-Name
  • NAS-IP-Address
  • Framed-IP-Address
  • Framed-IP-Netmask
  • Filter-Id
  • Login-IP-Host
  • Reply-Message
  • Callback-Number
  • Callback-Id
  • Framed-Route
  • Framed-IPX-Network
  • Class
  • Called-Station-Id
  • Calling-Station-Id
  • NAS-Identifier
  • Proxy-State
  • Login-LAT-Service
  • Login-LAT-Node
  • Login-LAT-Group
  • Framed-AppleTalk-Zone
  • Acct-Session-Id
  • Acct-Multi-Session-Id
RADIUS attributes used to block a user.
rsso_ep_one_ip_only
string
    Choices:
  • enable
  • disable
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:
  • enable
  • disable
Enable/disable flushing user IP sessions on RADIUS accounting Stop messages.
rsso_log_flags
list / elements=string
    Choices:
  • protocol-error
  • profile-missing
  • accounting-stop-missed
  • accounting-event
  • endpoint-block
  • radiusd-other
  • none
Events to log.
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:
  • enable
  • disable
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
RADIUS secret used by the RADIUS accounting server.
rsso_validate_request_secret
string
    Choices:
  • enable
  • disable
Enable/disable validating the RADIUS request shared secret in the Start or End record.
secondary_secret
string
Secret key to access the secondary server.
secondary_server
string
{<name_str|ip_str>} secondary RADIUS CN domain name or IP.
secret
string
Pre-shared secret key used to access the primary RADIUS server.
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
  • NAS-IP-Address
  • Framed-IP-Address
  • Framed-IP-Netmask
  • Filter-Id
  • Login-IP-Host
  • Reply-Message
  • Callback-Number
  • Callback-Id
  • Framed-Route
  • Framed-IPX-Network
  • Class
  • Called-Station-Id
  • Calling-Station-Id
  • NAS-Identifier
  • Proxy-State
  • Login-LAT-Service
  • Login-LAT-Node
  • Login-LAT-Group
  • Framed-AppleTalk-Zone
  • Acct-Session-Id
  • Acct-Multi-Session-Id
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:
  • enable
  • disable
Enable/disable override old attribute value with new value for the same endpoint.
switch_controller_acct_fast_framedip_detect
integer
Switch controller accounting message Framed-IP detection from DHCP snooping (seconds).
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
RADIUS service type.
tertiary_secret
string
Secret key to access the tertiary server.
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_management_vdom
string
    Choices:
  • enable
  • disable
Enable/disable using management VDOM to send requests.
username_case_sensitive
string
    Choices:
  • enable
  • disable
Enable/disable case sensitive user names.
vdom
string
Default:
"root"
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure RADIUS server entries.
    fortios_user_radius:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_radius:
        accounting_server:
         -
            id:  "4"
            interface: "<your_own_value> (source system.interface.name)"
            interface_select_method: "auto"
            port: "7"
            secret: "<your_own_value>"
            server: "192.168.100.40"
            source_ip: "84.230.14.43"
            status: "enable"
        acct_all_servers: "enable"
        acct_interim_interval: "13"
        all_usergroup: "disable"
        auth_type: "auto"
        class:
         -
            name: "default_name_17"
        group_override_attr_type: "filter-Id"
        h3c_compatibility: "enable"
        interface: "<your_own_value> (source system.interface.name)"
        interface_select_method: "auto"
        name: "default_name_22"
        nas_ip: "<your_own_value>"
        password_encoding: "auto"
        password_renewal: "enable"
        radius_coa: "enable"
        radius_port: "27"
        rsso: "enable"
        rsso_context_timeout: "29"
        rsso_endpoint_attribute: "User-Name"
        rsso_endpoint_block_attribute: "User-Name"
        rsso_ep_one_ip_only: "enable"
        rsso_flush_ip_session: "enable"
        rsso_log_flags: "protocol-error"
        rsso_log_period: "35"
        rsso_radius_response: "enable"
        rsso_radius_server_port: "37"
        rsso_secret: "<your_own_value>"
        rsso_validate_request_secret: "enable"
        secondary_secret: "<your_own_value>"
        secondary_server: "<your_own_value>"
        secret: "<your_own_value>"
        server: "192.168.100.40"
        source_ip: "84.230.14.43"
        sso_attribute: "User-Name"
        sso_attribute_key: "<your_own_value>"
        sso_attribute_value_override: "enable"
        switch_controller_acct_fast_framedip_detect: "48"
        switch_controller_service_type: "login"
        tertiary_secret: "<your_own_value>"
        tertiary_server: "<your_own_value>"
        timeout: "52"
        use_management_vdom: "enable"
        username_case_sensitive: "enable"

Return Values

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

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_user_radius_module.html