fortinet.fortios.fortios_user_radius module – Configure RADIUS server entries in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_user_radius
.
New in fortinet.fortios 2.0.0
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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure RADIUS server entries. |
|
Define subject identity field in certificate for user access right checking. Choices:
|
|
Account key processing operation. The FortiGate will keep either the whole domain or strip the domain from the subject identity. Choices:
|
|
Additional accounting servers. |
|
ID (0 - 4294967295). see <a href=’#notes’>Notes</a>. |
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
RADIUS accounting port number. |
|
Secret key. |
|
Server CN domain name or IP address. |
|
Source IP address for communications to the RADIUS server. |
|
Status. Choices:
|
|
Enable/disable sending of accounting messages to all configured servers . Choices:
|
|
Time in seconds between each accounting interim update message. |
|
Enable/disable automatically including this RADIUS server in all user groups. Choices:
|
|
Authentication methods/protocols permitted for this RADIUS server. Choices:
|
|
CA of server to trust under TLS. Source vpn.certificate.ca.name. |
|
Calling & Called station identifier type configuration , this option is not available for 802.1x authentication. Choices:
|
|
Class attribute name(s). |
|
Class name. |
|
Client certificate to use under TLS. Source vpn.certificate.local.name. |
|
Configure delimiter to be used for separating profile group names in the SSO attribute . Choices:
|
|
RADIUS attribute type to override user group information. Choices:
|
|
Enable/disable compatibility with the H3C, a mechanism that performs security checking for authentication. Choices:
|
|
Specify outgoing interface to reach server. Source system.interface.name. |
|
Specify how to select outgoing interface to reach server. Choices:
|
|
MAC authentication case . Choices:
|
|
MAC authentication password delimiter . Choices:
|
|
MAC authentication username delimiter . Choices:
|
|
RADIUS server entry name. |
|
Custom NAS identifier. |
|
NAS identifier type configuration . Choices:
|
|
IP address used to communicate with the RADIUS server and used as NAS-IP-Address and Called-Station-ID attributes. |
|
Password encoding. Choices:
|
|
Enable/disable password renewal. Choices:
|
|
Enable to allow a mechanism to change the attributes of an authentication, authorization, and accounting session after it is authenticated. Choices:
|
|
RADIUS service port number. |
|
Enable/disable RADIUS based single sign on feature. Choices:
|
|
Time in seconds before the logged out user is removed from the “user context list” of logged on users. |
|
RADIUS attributes used to extract the user end point identifier from the RADIUS Start record. Choices:
|
|
RADIUS attributes used to block a user. Choices:
|
|
Enable/disable the replacement of old IP addresses with new ones for the same endpoint on RADIUS accounting Start messages. Choices:
|
|
Enable/disable flushing user IP sessions on RADIUS accounting Stop messages. Choices:
|
|
Events to log. Choices:
|
|
Time interval in seconds that group event log messages will be generated for dynamic profile events. |
|
Enable/disable sending RADIUS response packets after receiving Start and Stop records. Choices:
|
|
UDP port to listen on for RADIUS Start and Stop records. |
|
RADIUS secret used by the RADIUS accounting server. |
|
Enable/disable validating the RADIUS request shared secret in the Start or End record. Choices:
|
|
Secret key to access the secondary server. |
|
Secondary RADIUS CN domain name or IP address. |
|
Pre-shared secret key used to access the primary RADIUS server. |
|
Primary RADIUS server CN domain name or IP address. |
|
Enable/disable RADIUS server identity check (verify server domain name/IP address against the server certificate). Choices:
|
|
Source IP address for communications to the RADIUS server. |
|
Source interface for communication with the RADIUS server. Source system.interface.name. |
|
RADIUS attribute that contains the profile group name to be extracted from the RADIUS Start record. Choices:
|
|
Key prefix for SSO group value in the SSO attribute. |
|
Enable/disable override old attribute value with new value for the same endpoint. Choices:
|
|
Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at least this period of time (0 = cache disabled). |
|
Switch controller accounting message Framed-IP detection from DHCP snooping (seconds). |
|
Enable/Disable switch-controller nas-ip dynamic to dynamically set nas-ip. Choices:
|
|
RADIUS service type. Choices:
|
|
Secret key to access the tertiary server. |
|
Tertiary RADIUS CN domain name or IP address. |
|
Time in seconds to retry connecting server. |
|
Minimum supported protocol version for TLS connections . Choices:
|
|
Transport protocol to be used . Choices:
|
|
Enable/disable using management VDOM to send requests. Choices:
|
|
Enable/disable case sensitive user names. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure RADIUS server entries.
fortinet.fortios.fortios_user_radius:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_radius:
account_key_cert_field: "othername"
account_key_processing: "same"
accounting_server:
-
id: "6"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
port: "0"
secret: "<your_own_value>"
server: "192.168.100.40"
source_ip: "84.230.14.43"
status: "enable"
acct_all_servers: "enable"
acct_interim_interval: "0"
all_usergroup: "disable"
auth_type: "auto"
ca_cert: "<your_own_value> (source vpn.certificate.ca.name)"
call_station_id_type: "legacy"
class:
-
name: "default_name_21"
client_cert: "<your_own_value> (source vpn.certificate.local.name)"
delimiter: "plus"
group_override_attr_type: "filter-Id"
h3c_compatibility: "enable"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
mac_case: "uppercase"
mac_password_delimiter: "hyphen"
mac_username_delimiter: "hyphen"
name: "default_name_31"
nas_id: "<your_own_value>"
nas_id_type: "legacy"
nas_ip: "<your_own_value>"
password_encoding: "auto"
password_renewal: "enable"
radius_coa: "enable"
radius_port: "0"
rsso: "enable"
rsso_context_timeout: "28800"
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: "0"
rsso_radius_response: "enable"
rsso_radius_server_port: "1813"
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"
server_identity_check: "enable"
source_ip: "84.230.14.43"
source_ip_interface: "<your_own_value> (source system.interface.name)"
sso_attribute: "User-Name"
sso_attribute_key: "<your_own_value>"
sso_attribute_value_override: "enable"
status_ttl: "300"
switch_controller_acct_fast_framedip_detect: "2"
switch_controller_nas_ip_dynamic: "enable"
switch_controller_service_type: "login"
tertiary_secret: "<your_own_value>"
tertiary_server: "<your_own_value>"
timeout: "5"
tls_min_proto_version: "default"
transport_protocol: "udp"
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 |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |