:source: fortios_user_radius.py
:orphan:
.. fortios_user_radius:
fortios_user_radius -- Configure RADIUS server entries in Fortinet's FortiOS and FortiGate.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
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
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - 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. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- user_radius - Configure RADIUS server entries. type: dict
more...
| Supported Version Ranges |
| user_radius |
v6.0.0 -> 7.6.6 |
- account_key_cert_field - Define subject identity field in certificate for user access right checking. type: str choices: othername, rfc822name, dnsname, cn
more...
|
Supported Version Ranges |
| account_key_cert_field |
v7.4.1 -> 7.6.6 |
| [othername] |
v7.4.1 -> 7.6.6 |
| [rfc822name] |
v7.4.1 -> 7.6.6 |
| [dnsname] |
v7.4.1 -> 7.6.6 |
| [cn] |
v7.4.4 -> 7.6.6 |
- account_key_processing - Account key processing operation. The FortiGate will keep either the whole domain or strip the domain from the subject identity. type: str choices: same, strip
more...
|
Supported Version Ranges |
| account_key_processing |
v7.4.1 -> 7.6.6 |
| [same] |
v7.4.1 -> 7.6.6 |
| [strip] |
v7.4.1 -> 7.6.6 |
- accounting_server - Additional accounting servers. type: list member_path: accounting_server:id
more...
| Supported Version Ranges |
| accounting_server |
v6.0.0 -> 7.6.6 |
- id - ID (0 - 4294967295). see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| interface |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify
more...
|
Supported Version Ranges |
| interface_select_method |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [auto] |
v6.2.0 -> v6.2.0 |
| [sdwan] |
v6.2.0 -> v6.2.0 |
| [specify] |
v6.2.0 -> v6.2.0 |
- port - RADIUS accounting port number. type: int
more...
|
Supported Version Ranges |
| port |
v6.0.0 -> 7.6.6 |
- secret - Secret key. type: str
more...
|
Supported Version Ranges |
| secret |
v6.0.0 -> 7.6.6 |
- server - Server CN domain name or IP address. type: str
more...
|
Supported Version Ranges |
| server |
v6.0.0 -> 7.6.6 |
- source_ip - Source IP address for communications to the RADIUS server. type: str
more...
|
Supported Version Ranges |
| source_ip |
v6.0.0 -> 7.6.6 |
- status - Status. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| status |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- vrf_select - VRF ID used for connection to server. type: int
more...
|
Supported Version Ranges |
| vrf_select |
v7.6.1 -> 7.6.6 |
- acct_all_servers - Enable/disable sending of accounting messages to all configured servers . type: str choices: enable, disable
more...
|
Supported Version Ranges |
| acct_all_servers |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- acct_interim_interval - Time in seconds between each accounting interim update message. type: int
more...
|
Supported Version Ranges |
| acct_interim_interval |
v6.0.0 -> 7.6.6 |
- all_usergroup - Enable/disable automatically including this RADIUS server in all user groups. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| all_usergroup |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- auth_type - Authentication methods/protocols permitted for this RADIUS server. type: str choices: auto, ms_chap_v2, ms_chap, chap, pap
more...
|
Supported Version Ranges |
| auth_type |
v6.0.0 -> 7.6.6 |
| [auto] |
v6.0.0 -> 7.6.6 |
| [ms_chap_v2] |
v6.0.0 -> 7.6.6 |
| [ms_chap] |
v6.0.0 -> 7.6.6 |
| [chap] |
v6.0.0 -> 7.6.6 |
| [pap] |
v6.0.0 -> 7.6.6 |
- ca_cert - CA of server to trust under TLS. Source vpn.certificate.ca.name. type: str
more...
|
Supported Version Ranges |
| ca_cert |
v7.4.0 -> 7.6.6 |
- call_station_id_type - Calling & Called station identifier type configuration , this option is not available for 802.1x authentication. type: str choices: legacy, IP, MAC
more...
|
Supported Version Ranges |
| call_station_id_type |
v7.4.1 -> 7.6.6 |
| [legacy] |
v7.4.1 -> 7.6.6 |
| [IP] |
v7.4.1 -> 7.6.6 |
| [MAC] |
v7.4.1 -> 7.6.6 |
- class - Class attribute name(s). type: list member_path: class:name
more...
| Supported Version Ranges |
| class |
v6.0.0 -> 7.6.6 |
- name - Class name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- client_cert - Client certificate to use under TLS. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| client_cert |
v7.4.0 -> 7.6.6 |
- delimiter - Configure delimiter to be used for separating profile group names in the SSO attribute . type: str choices: plus, comma
more...
|
Supported Version Ranges |
| delimiter |
v7.2.0 -> 7.6.6 |
| [plus] |
v7.2.0 -> 7.6.6 |
| [comma] |
v7.2.0 -> 7.6.6 |
- group_override_attr_type - RADIUS attribute type to override user group information. type: str choices: filter-Id, class
more...
|
Supported Version Ranges |
| group_override_attr_type |
v6.4.0 -> 7.6.6 |
| [filter-Id] |
v6.4.0 -> 7.6.6 |
| [class] |
v6.4.0 -> 7.6.6 |
- h3c_compatibility - Enable/disable compatibility with the H3C, a mechanism that performs security checking for authentication. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| h3c_compatibility |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- interface - Specify outgoing interface to reach server. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| interface |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
- interface_select_method - Specify how to select outgoing interface to reach server. type: str choices: auto, sdwan, specify
more...
|
Supported Version Ranges |
| interface_select_method |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [auto] |
v6.2.0 -> v6.2.0 |
| [sdwan] |
v6.2.0 -> v6.2.0 |
| [specify] |
v6.2.0 -> v6.2.0 |
- mac_case - MAC authentication case . type: str choices: uppercase, lowercase
more...
|
Supported Version Ranges |
| mac_case |
v7.2.1 -> 7.6.6 |
| [uppercase] |
v7.2.1 -> 7.6.6 |
| [lowercase] |
v7.2.1 -> 7.6.6 |
- mac_password_delimiter - MAC authentication password delimiter . type: str choices: hyphen, single-hyphen, colon, none
more...
|
Supported Version Ranges |
| mac_password_delimiter |
v7.2.1 -> 7.6.6 |
| [hyphen] |
v7.2.1 -> 7.6.6 |
| [single-hyphen] |
v7.2.1 -> 7.6.6 |
| [colon] |
v7.2.1 -> 7.6.6 |
| [none] |
v7.2.1 -> 7.6.6 |
- mac_username_delimiter - MAC authentication username delimiter . type: str choices: hyphen, single-hyphen, colon, none
more...
|
Supported Version Ranges |
| mac_username_delimiter |
v7.2.1 -> 7.6.6 |
| [hyphen] |
v7.2.1 -> 7.6.6 |
| [single-hyphen] |
v7.2.1 -> 7.6.6 |
| [colon] |
v7.2.1 -> 7.6.6 |
| [none] |
v7.2.1 -> 7.6.6 |
- name - RADIUS server entry name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- nas_id - Custom NAS identifier. type: str
more...
|
Supported Version Ranges |
| nas_id |
v7.2.4 -> 7.6.6 |
- nas_id_type - NAS identifier type configuration . type: str choices: legacy, custom, hostname
more...
|
Supported Version Ranges |
| nas_id_type |
v7.2.4 -> 7.6.6 |
| [legacy] |
v7.2.4 -> 7.6.6 |
| [custom] |
v7.2.4 -> 7.6.6 |
| [hostname] |
v7.2.4 -> 7.6.6 |
- nas_ip - IP address used to communicate with the RADIUS server and used as NAS-IP-Address and Called-Station-ID attributes. type: str
more...
|
Supported Version Ranges |
| nas_ip |
v6.0.0 -> 7.6.6 |
- password_encoding - Password encoding. type: str choices: auto, ISO-8859-1
more...
|
Supported Version Ranges |
| password_encoding |
v6.0.0 -> 7.6.6 |
| [auto] |
v6.0.0 -> 7.6.6 |
| [ISO-8859-1] |
v6.0.0 -> 7.6.6 |
- password_renewal - Enable/disable password renewal. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| password_renewal |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- radius_coa - Enable to allow a mechanism to change the attributes of an authentication, authorization, and accounting session after it is authenticated. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| radius_coa |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- radius_port - RADIUS service port number. type: int
more...
|
Supported Version Ranges |
| radius_port |
v6.0.0 -> 7.6.6 |
- require_message_authenticator - Require message authenticator in authentication response. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| require_message_authenticator |
v7.6.1 -> 7.6.6 |
| [enable] |
v7.6.1 -> 7.6.6 |
| [disable] |
v7.6.1 -> 7.6.6 |
- rsso - Enable/disable RADIUS based single sign on feature. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| rsso |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- rsso_context_timeout - Time in seconds before the logged out user is removed from the "user context list" of logged on users. type: int
more...
|
Supported Version Ranges |
| rsso_context_timeout |
v6.0.0 -> 7.6.6 |
- rsso_endpoint_attribute - RADIUS attributes used to extract the user end point identifier from the RADIUS Start record. type: str 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
more...
|
Supported Version Ranges |
| rsso_endpoint_attribute |
v6.0.0 -> 7.6.6 |
| [User-Name] |
v6.0.0 -> 7.6.6 |
| [NAS-IP-Address] |
v6.0.0 -> 7.6.6 |
| [Framed-IP-Address] |
v6.0.0 -> 7.6.6 |
| [Framed-IP-Netmask] |
v6.0.0 -> 7.6.6 |
| [Filter-Id] |
v6.0.0 -> 7.6.6 |
| [Login-IP-Host] |
v6.0.0 -> 7.6.6 |
| [Reply-Message] |
v6.0.0 -> 7.6.6 |
| [Callback-Number] |
v6.0.0 -> 7.6.6 |
| [Callback-Id] |
v6.0.0 -> 7.6.6 |
| [Framed-Route] |
v6.0.0 -> 7.6.6 |
| [Framed-IPX-Network] |
v6.0.0 -> 7.6.6 |
| [Class] |
v6.0.0 -> 7.6.6 |
| [Called-Station-Id] |
v6.0.0 -> 7.6.6 |
| [Calling-Station-Id] |
v6.0.0 -> 7.6.6 |
| [NAS-Identifier] |
v6.0.0 -> 7.6.6 |
| [Proxy-State] |
v6.0.0 -> 7.6.6 |
| [Login-LAT-Service] |
v6.0.0 -> 7.6.6 |
| [Login-LAT-Node] |
v6.0.0 -> 7.6.6 |
| [Login-LAT-Group] |
v6.0.0 -> 7.6.6 |
| [Framed-AppleTalk-Zone] |
v6.0.0 -> 7.6.6 |
| [Acct-Session-Id] |
v6.0.0 -> 7.6.6 |
| [Acct-Multi-Session-Id] |
v6.0.0 -> 7.6.6 |
- rsso_endpoint_block_attribute - RADIUS attributes used to block a user. type: str 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
more...
|
Supported Version Ranges |
| rsso_endpoint_block_attribute |
v6.0.0 -> 7.6.6 |
| [User-Name] |
v6.0.0 -> 7.6.6 |
| [NAS-IP-Address] |
v6.0.0 -> 7.6.6 |
| [Framed-IP-Address] |
v6.0.0 -> 7.6.6 |
| [Framed-IP-Netmask] |
v6.0.0 -> 7.6.6 |
| [Filter-Id] |
v6.0.0 -> 7.6.6 |
| [Login-IP-Host] |
v6.0.0 -> 7.6.6 |
| [Reply-Message] |
v6.0.0 -> 7.6.6 |
| [Callback-Number] |
v6.0.0 -> 7.6.6 |
| [Callback-Id] |
v6.0.0 -> 7.6.6 |
| [Framed-Route] |
v6.0.0 -> 7.6.6 |
| [Framed-IPX-Network] |
v6.0.0 -> 7.6.6 |
| [Class] |
v6.0.0 -> 7.6.6 |
| [Called-Station-Id] |
v6.0.0 -> 7.6.6 |
| [Calling-Station-Id] |
v6.0.0 -> 7.6.6 |
| [NAS-Identifier] |
v6.0.0 -> 7.6.6 |
| [Proxy-State] |
v6.0.0 -> 7.6.6 |
| [Login-LAT-Service] |
v6.0.0 -> 7.6.6 |
| [Login-LAT-Node] |
v6.0.0 -> 7.6.6 |
| [Login-LAT-Group] |
v6.0.0 -> 7.6.6 |
| [Framed-AppleTalk-Zone] |
v6.0.0 -> 7.6.6 |
| [Acct-Session-Id] |
v6.0.0 -> 7.6.6 |
| [Acct-Multi-Session-Id] |
v6.0.0 -> 7.6.6 |
- rsso_ep_one_ip_only - Enable/disable the replacement of old IP addresses with new ones for the same endpoint on RADIUS accounting Start messages. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| rsso_ep_one_ip_only |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- rsso_flush_ip_session - Enable/disable flushing user IP sessions on RADIUS accounting Stop messages. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| rsso_flush_ip_session |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- rsso_log_flags - Events to log. type: list choices: protocol-error, profile-missing, accounting-stop-missed, accounting-event, endpoint-block, radiusd-other, none
more...
|
Supported Version Ranges |
| rsso_log_flags |
v6.0.0 -> 7.6.6 |
| [protocol-error] |
v6.0.0 -> 7.6.6 |
| [profile-missing] |
v6.0.0 -> 7.6.6 |
| [accounting-stop-missed] |
v6.0.0 -> 7.6.6 |
| [accounting-event] |
v6.0.0 -> 7.6.6 |
| [endpoint-block] |
v6.0.0 -> 7.6.6 |
| [radiusd-other] |
v6.0.0 -> 7.6.6 |
| [none] |
v6.0.0 -> 7.6.6 |
- rsso_log_period - Time interval in seconds that group event log messages will be generated for dynamic profile events. type: int
more...
|
Supported Version Ranges |
| rsso_log_period |
v6.0.0 -> 7.6.6 |
- rsso_radius_response - Enable/disable sending RADIUS response packets after receiving Start and Stop records. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| rsso_radius_response |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- rsso_radius_server_port - UDP port to listen on for RADIUS Start and Stop records. type: int
more...
|
Supported Version Ranges |
| rsso_radius_server_port |
v6.0.0 -> 7.6.6 |
- rsso_secret - RADIUS secret used by the RADIUS accounting server. type: str
more...
|
Supported Version Ranges |
| rsso_secret |
v6.0.0 -> 7.6.6 |
- rsso_validate_request_secret - Enable/disable validating the RADIUS request shared secret in the Start or End record. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| rsso_validate_request_secret |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- secondary_secret - Secret key to access the secondary server. type: str
more...
|
Supported Version Ranges |
| secondary_secret |
v6.0.0 -> 7.6.6 |
- secondary_server - Secondary RADIUS CN domain name or IP address. type: str
more...
|
Supported Version Ranges |
| secondary_server |
v6.0.0 -> 7.6.6 |
- secret - Pre-shared secret key used to access the primary RADIUS server. type: str
more...
|
Supported Version Ranges |
| secret |
v6.0.0 -> 7.6.6 |
- server - Primary RADIUS server CN domain name or IP address. type: str
more...
|
Supported Version Ranges |
| server |
v6.0.0 -> 7.6.6 |
- server_identity_check - Enable/disable RADIUS server identity check (verify server domain name/IP address against the server certificate). type: str choices: enable, disable
more...
|
Supported Version Ranges |
| server_identity_check |
v7.4.0 -> 7.6.6 |
| [enable] |
v7.4.0 -> 7.6.6 |
| [disable] |
v7.4.0 -> 7.6.6 |
- source_ip - Source IP address for communications to the RADIUS server. type: str
more...
|
Supported Version Ranges |
| source_ip |
v6.0.0 -> 7.6.6 |
- source_ip_interface - Source interface for communication with the RADIUS server. Source system.interface.name. type: str
more...
|
Supported Version Ranges |
| source_ip_interface |
v7.6.0 -> 7.6.6 |
- sso_attribute - RADIUS attribute that contains the profile group name to be extracted from the RADIUS Start record. type: str 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
more...
|
Supported Version Ranges |
| sso_attribute |
v6.0.0 -> 7.6.6 |
| [User-Name] |
v6.0.0 -> 7.6.6 |
| [NAS-IP-Address] |
v6.0.0 -> 7.6.6 |
| [Framed-IP-Address] |
v6.0.0 -> 7.6.6 |
| [Framed-IP-Netmask] |
v6.0.0 -> 7.6.6 |
| [Filter-Id] |
v6.0.0 -> 7.6.6 |
| [Login-IP-Host] |
v6.0.0 -> 7.6.6 |
| [Reply-Message] |
v6.0.0 -> 7.6.6 |
| [Callback-Number] |
v6.0.0 -> 7.6.6 |
| [Callback-Id] |
v6.0.0 -> 7.6.6 |
| [Framed-Route] |
v6.0.0 -> 7.6.6 |
| [Framed-IPX-Network] |
v6.0.0 -> 7.6.6 |
| [Class] |
v6.0.0 -> 7.6.6 |
| [Called-Station-Id] |
v6.0.0 -> 7.6.6 |
| [Calling-Station-Id] |
v6.0.0 -> 7.6.6 |
| [NAS-Identifier] |
v6.0.0 -> 7.6.6 |
| [Proxy-State] |
v6.0.0 -> 7.6.6 |
| [Login-LAT-Service] |
v6.0.0 -> 7.6.6 |
| [Login-LAT-Node] |
v6.0.0 -> 7.6.6 |
| [Login-LAT-Group] |
v6.0.0 -> 7.6.6 |
| [Framed-AppleTalk-Zone] |
v6.0.0 -> 7.6.6 |
| [Acct-Session-Id] |
v6.0.0 -> 7.6.6 |
| [Acct-Multi-Session-Id] |
v6.0.0 -> 7.6.6 |
- sso_attribute_key - Key prefix for SSO group value in the SSO attribute. type: str
more...
|
Supported Version Ranges |
| sso_attribute_key |
v6.0.0 -> 7.6.6 |
- sso_attribute_value_override - Enable/disable override old attribute value with new value for the same endpoint. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| sso_attribute_value_override |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- status_ttl - 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). type: int
more...
|
Supported Version Ranges |
| status_ttl |
v7.4.0 -> 7.6.6 |
- switch_controller_acct_fast_framedip_detect - Switch controller accounting message Framed-IP detection from DHCP snooping (seconds). type: int
more...
|
Supported Version Ranges |
| switch_controller_acct_fast_framedip_detect |
v6.4.0 -> 7.6.6 |
- switch_controller_nas_ip_dynamic - Enable/Disable switch-controller nas-ip dynamic to dynamically set nas-ip. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| switch_controller_nas_ip_dynamic |
v7.4.2 -> 7.6.6 |
| [enable] |
v7.4.2 -> 7.6.6 |
| [disable] |
v7.4.2 -> 7.6.6 |
- switch_controller_service_type - RADIUS service type. type: list choices: login, framed, callback-login, callback-framed, outbound, administrative, nas-prompt, authenticate-only, callback-nas-prompt, call-check, callback-administrative
more...
|
Supported Version Ranges |
| switch_controller_service_type |
v6.4.0 -> v6.4.0 |
v6.4.4 -> 7.6.6 |
| [login] |
v6.4.0 -> v6.4.0 |
| [framed] |
v6.4.0 -> v6.4.0 |
| [callback-login] |
v6.4.0 -> v6.4.0 |
| [callback-framed] |
v6.4.0 -> v6.4.0 |
| [outbound] |
v6.4.0 -> v6.4.0 |
| [administrative] |
v6.4.0 -> v6.4.0 |
| [nas-prompt] |
v6.4.0 -> v6.4.0 |
| [authenticate-only] |
v6.4.0 -> v6.4.0 |
| [callback-nas-prompt] |
v6.4.0 -> v6.4.0 |
| [call-check] |
v6.4.0 -> v6.4.0 |
| [callback-administrative] |
v6.4.0 -> v6.4.0 |
- tertiary_secret - Secret key to access the tertiary server. type: str
more...
|
Supported Version Ranges |
| tertiary_secret |
v6.0.0 -> 7.6.6 |
- tertiary_server - Tertiary RADIUS CN domain name or IP address. type: str
more...
|
Supported Version Ranges |
| tertiary_server |
v6.0.0 -> 7.6.6 |
- timeout - Time in seconds to retry connecting server. type: int
more...
|
Supported Version Ranges |
| timeout |
v6.0.0 -> 7.6.6 |
- tls_min_proto_version - Minimum supported protocol version for TLS connections . type: str choices: default, SSLv3, TLSv1, TLSv1-1, TLSv1-2, TLSv1-3
more...
|
Supported Version Ranges |
| tls_min_proto_version |
v7.4.0 -> 7.6.6 |
| [default] |
v7.4.0 -> 7.6.6 |
| [SSLv3] |
v7.4.0 -> 7.6.6 |
| [TLSv1] |
v7.4.0 -> 7.6.6 |
| [TLSv1-1] |
v7.4.0 -> 7.6.6 |
| [TLSv1-2] |
v7.4.0 -> 7.6.6 |
| [TLSv1-3] |
v7.4.1 -> 7.6.6 |
- transport_protocol - Transport protocol to be used . type: str choices: udp, tcp, tls
more...
|
Supported Version Ranges |
| transport_protocol |
v7.4.0 -> 7.6.6 |
| [udp] |
v7.4.0 -> 7.6.6 |
| [tcp] |
v7.4.0 -> 7.6.6 |
| [tls] |
v7.4.0 -> 7.6.6 |
- use_management_vdom - Enable/disable using management VDOM to send requests. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| use_management_vdom |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- username_case_sensitive - Enable/disable case sensitive user names. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| username_case_sensitive |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- vrf_select - VRF ID used for connection to server. type: int
more...
|
Supported Version Ranges |
| vrf_select |
v7.6.1 -> 7.6.6 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- name: Configure RADIUS server entries.
fortinet.fortios.fortios_user_radius:
vdom: "{{ vdom }}"
state: "present"
access_token: ""
user_radius:
account_key_cert_field: "othername"
account_key_processing: "same"
accounting_server:
-
id: "6"
interface: " (source system.interface.name)"
interface_select_method: "auto"
port: "0"
secret: ""
server: "192.168.100.40"
source_ip: "84.230.14.43"
status: "enable"
vrf_select: "0"
acct_all_servers: "enable"
acct_interim_interval: "0"
all_usergroup: "disable"
auth_type: "auto"
ca_cert: " (source vpn.certificate.ca.name)"
call_station_id_type: "legacy"
class:
-
name: "default_name_22"
client_cert: " (source vpn.certificate.local.name)"
delimiter: "plus"
group_override_attr_type: "filter-Id"
h3c_compatibility: "enable"
interface: " (source system.interface.name)"
interface_select_method: "auto"
mac_case: "uppercase"
mac_password_delimiter: "hyphen"
mac_username_delimiter: "hyphen"
name: "default_name_32"
nas_id: ""
nas_id_type: "legacy"
nas_ip: ""
password_encoding: "auto"
password_renewal: "enable"
radius_coa: "enable"
radius_port: "0"
require_message_authenticator: "enable"
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: ""
rsso_validate_request_secret: "enable"
secondary_secret: ""
secondary_server: ""
secret: ""
server: "192.168.100.40"
server_identity_check: "enable"
source_ip: "84.230.14.43"
source_ip_interface: " (source system.interface.name)"
sso_attribute: "User-Name"
sso_attribute_key: ""
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: ""
tertiary_server: ""
timeout: "5"
tls_min_proto_version: "default"
transport_protocol: "udp"
use_management_vdom: "enable"
username_case_sensitive: "enable"
vrf_select: "0"
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
.. hint::
If you notice any issues in this documentation, you can create a pull request to improve it.