fortios_user_radius.rst

source:	fortios_user_radius.py
orphan:

fortios_user_radius -- Configure RADIUS server entries in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

	Supported Version Ranges
fortios_user_radius	v6.0.0 -> latest

Parameters

• 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 -> latest

• account_key_cert_field - Define subject identity field in certificate for user access right checking. type: str choices: othername, rfc822name, dnsname more...

  	Supported Version Ranges
  account_key_cert_field	v7.4.1 -> latest
  [othername]	v6.0.0 -> latest
  [rfc822name]	v6.0.0 -> latest
  [dnsname]	v6.0.0 -> latest

• 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 -> latest
  [same]	v6.0.0 -> latest
  [strip]	v6.0.0 -> latest

• accounting_server - Additional accounting servers. type: list member_path: accounting_server:id more...

  	Supported Version Ranges
  accounting_server	v6.0.0 -> latest

• id - ID (0 - 4294967295). see Notes. type: int required: true more...

  	Supported Version Ranges
  id	v6.0.0 -> latest

• 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 -> latest

• 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 -> latest
  [auto]	v6.0.0 -> latest
  [sdwan]	v6.0.0 -> latest
  [specify]	v6.0.0 -> latest

• port - RADIUS accounting port number. type: int more...

  	Supported Version Ranges
  port	v6.0.0 -> latest

• secret - Secret key. type: str more...

  	Supported Version Ranges
  secret	v6.0.0 -> latest

• server - Server CN domain name or IP address. type: str more...

  	Supported Version Ranges
  server	v6.0.0 -> latest

• source_ip - Source IP address for communications to the RADIUS server. type: str more...

  	Supported Version Ranges
  source_ip	v6.0.0 -> latest

• status - Status. type: str choices: enable, disable more...

  	Supported Version Ranges
  status	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• 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 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• acct_interim_interval - Time in seconds between each accounting interim update message. type: int more...

  	Supported Version Ranges
  acct_interim_interval	v6.0.0 -> latest

• 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 -> latest
  [disable]	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest

• 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 -> latest
  [auto]	v6.0.0 -> latest
  [ms_chap_v2]	v6.0.0 -> latest
  [ms_chap]	v6.0.0 -> latest
  [chap]	v6.0.0 -> latest
  [pap]	v6.0.0 -> latest

• 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 -> latest

• 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 -> latest
  [legacy]	v6.0.0 -> latest
  [IP]	v6.0.0 -> latest
  [MAC]	v6.0.0 -> latest

• class - Class attribute name(s). type: list member_path: class:name more...

  	Supported Version Ranges
  class	v6.0.0 -> latest

• name - Class name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• client_cert - Client certificate to use under TLS. Source vpn.certificate.local.name. type: str more...

  	Supported Version Ranges
  client_cert	v7.4.0 -> latest

• 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 -> latest
  [plus]	v6.0.0 -> latest
  [comma]	v6.0.0 -> latest

• 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 -> latest
  [filter-Id]	v6.0.0 -> latest
  [class]	v6.0.0 -> latest

• 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 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• 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 -> latest

• 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 -> latest
  [auto]	v6.0.0 -> latest
  [sdwan]	v6.0.0 -> latest
  [specify]	v6.0.0 -> latest

• mac_case - MAC authentication case . type: str choices: uppercase, lowercase more...

  	Supported Version Ranges
  mac_case	v7.2.1 -> latest
  [uppercase]	v6.0.0 -> latest
  [lowercase]	v6.0.0 -> latest

• 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 -> latest
  [hyphen]	v6.0.0 -> latest
  [single-hyphen]	v6.0.0 -> latest
  [colon]	v6.0.0 -> latest
  [none]	v6.0.0 -> latest

• 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 -> latest
  [hyphen]	v6.0.0 -> latest
  [single-hyphen]	v6.0.0 -> latest
  [colon]	v6.0.0 -> latest
  [none]	v6.0.0 -> latest

• name - RADIUS server entry name. type: str required: true more...

  	Supported Version Ranges
  name	v6.0.0 -> latest

• nas_id - Custom NAS identifier. type: str more...

  	Supported Version Ranges
  nas_id	v7.2.4 -> latest

• nas_id_type - NAS identifier type configuration . type: str choices: legacy, custom, hostname more...

  	Supported Version Ranges
  nas_id_type	v7.2.4 -> latest
  [legacy]	v6.0.0 -> latest
  [custom]	v6.0.0 -> latest
  [hostname]	v6.0.0 -> latest

• 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 -> latest

• password_encoding - Password encoding. type: str choices: auto, ISO-8859-1 more...

  	Supported Version Ranges
  password_encoding	v6.0.0 -> latest
  [auto]	v6.0.0 -> latest
  [ISO-8859-1]	v6.0.0 -> latest

• password_renewal - Enable/disable password renewal. type: str choices: enable, disable more...

  	Supported Version Ranges
  password_renewal	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• 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 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• radius_port - RADIUS service port number. type: int more...

  	Supported Version Ranges
  radius_port	v6.0.0 -> latest

• rsso - Enable/disable RADIUS based single sign on feature. type: str choices: enable, disable more...

  	Supported Version Ranges
  rsso	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• 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 -> latest

• 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 -> latest
  [User-Name]	v6.0.0 -> latest
  [NAS-IP-Address]	v6.0.0 -> latest
  [Framed-IP-Address]	v6.0.0 -> latest
  [Framed-IP-Netmask]	v6.0.0 -> latest
  [Filter-Id]	v6.0.0 -> latest
  [Login-IP-Host]	v6.0.0 -> latest
  [Reply-Message]	v6.0.0 -> latest
  [Callback-Number]	v6.0.0 -> latest
  [Callback-Id]	v6.0.0 -> latest
  [Framed-Route]	v6.0.0 -> latest
  [Framed-IPX-Network]	v6.0.0 -> latest
  [Class]	v6.0.0 -> latest
  [Called-Station-Id]	v6.0.0 -> latest
  [Calling-Station-Id]	v6.0.0 -> latest
  [NAS-Identifier]	v6.0.0 -> latest
  [Proxy-State]	v6.0.0 -> latest
  [Login-LAT-Service]	v6.0.0 -> latest
  [Login-LAT-Node]	v6.0.0 -> latest
  [Login-LAT-Group]	v6.0.0 -> latest
  [Framed-AppleTalk-Zone]	v6.0.0 -> latest
  [Acct-Session-Id]	v6.0.0 -> latest
  [Acct-Multi-Session-Id]	v6.0.0 -> latest

• 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 -> latest
  [User-Name]	v6.0.0 -> latest
  [NAS-IP-Address]	v6.0.0 -> latest
  [Framed-IP-Address]	v6.0.0 -> latest
  [Framed-IP-Netmask]	v6.0.0 -> latest
  [Filter-Id]	v6.0.0 -> latest
  [Login-IP-Host]	v6.0.0 -> latest
  [Reply-Message]	v6.0.0 -> latest
  [Callback-Number]	v6.0.0 -> latest
  [Callback-Id]	v6.0.0 -> latest
  [Framed-Route]	v6.0.0 -> latest
  [Framed-IPX-Network]	v6.0.0 -> latest
  [Class]	v6.0.0 -> latest
  [Called-Station-Id]	v6.0.0 -> latest
  [Calling-Station-Id]	v6.0.0 -> latest
  [NAS-Identifier]	v6.0.0 -> latest
  [Proxy-State]	v6.0.0 -> latest
  [Login-LAT-Service]	v6.0.0 -> latest
  [Login-LAT-Node]	v6.0.0 -> latest
  [Login-LAT-Group]	v6.0.0 -> latest
  [Framed-AppleTalk-Zone]	v6.0.0 -> latest
  [Acct-Session-Id]	v6.0.0 -> latest
  [Acct-Multi-Session-Id]	v6.0.0 -> latest

• 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 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• 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 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• 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 -> latest
  [protocol-error]	v6.0.0 -> latest
  [profile-missing]	v6.0.0 -> latest
  [accounting-stop-missed]	v6.0.0 -> latest
  [accounting-event]	v6.0.0 -> latest
  [endpoint-block]	v6.0.0 -> latest
  [radiusd-other]	v6.0.0 -> latest
  [none]	v6.0.0 -> latest

• 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 -> latest

• 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 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• 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 -> latest

• rsso_secret - RADIUS secret used by the RADIUS accounting server. type: str more...

  	Supported Version Ranges
  rsso_secret	v6.0.0 -> latest

• 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 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• secondary_secret - Secret key to access the secondary server. type: str more...

  	Supported Version Ranges
  secondary_secret	v6.0.0 -> latest

• secondary_server - Secondary RADIUS CN domain name or IP address. type: str more...

  	Supported Version Ranges
  secondary_server	v6.0.0 -> latest

• secret - Pre-shared secret key used to access the primary RADIUS server. type: str more...

  	Supported Version Ranges
  secret	v6.0.0 -> latest

• server - Primary RADIUS server CN domain name or IP address. type: str more...

  	Supported Version Ranges
  server	v6.0.0 -> latest

• 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 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• source_ip - Source IP address for communications to the RADIUS server. type: str more...

  	Supported Version Ranges
  source_ip	v6.0.0 -> latest

• 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 -> latest
  [User-Name]	v6.0.0 -> latest
  [NAS-IP-Address]	v6.0.0 -> latest
  [Framed-IP-Address]	v6.0.0 -> latest
  [Framed-IP-Netmask]	v6.0.0 -> latest
  [Filter-Id]	v6.0.0 -> latest
  [Login-IP-Host]	v6.0.0 -> latest
  [Reply-Message]	v6.0.0 -> latest
  [Callback-Number]	v6.0.0 -> latest
  [Callback-Id]	v6.0.0 -> latest
  [Framed-Route]	v6.0.0 -> latest
  [Framed-IPX-Network]	v6.0.0 -> latest
  [Class]	v6.0.0 -> latest
  [Called-Station-Id]	v6.0.0 -> latest
  [Calling-Station-Id]	v6.0.0 -> latest
  [NAS-Identifier]	v6.0.0 -> latest
  [Proxy-State]	v6.0.0 -> latest
  [Login-LAT-Service]	v6.0.0 -> latest
  [Login-LAT-Node]	v6.0.0 -> latest
  [Login-LAT-Group]	v6.0.0 -> latest
  [Framed-AppleTalk-Zone]	v6.0.0 -> latest
  [Acct-Session-Id]	v6.0.0 -> latest
  [Acct-Multi-Session-Id]	v6.0.0 -> latest

• 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 -> latest

• 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 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• 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 -> latest

• 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 -> latest

• 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 -> latest
  [login]	v6.0.0 -> latest
  [framed]	v6.0.0 -> latest
  [callback-login]	v6.0.0 -> latest
  [callback-framed]	v6.0.0 -> latest
  [outbound]	v6.0.0 -> latest
  [administrative]	v6.0.0 -> latest
  [nas-prompt]	v6.0.0 -> latest
  [authenticate-only]	v6.0.0 -> latest
  [callback-nas-prompt]	v6.0.0 -> latest
  [call-check]	v6.0.0 -> latest
  [callback-administrative]	v6.0.0 -> latest

• tertiary_secret - Secret key to access the tertiary server. type: str more...

  	Supported Version Ranges
  tertiary_secret	v6.0.0 -> latest

• tertiary_server - Tertiary RADIUS CN domain name or IP address. type: str more...

  	Supported Version Ranges
  tertiary_server	v6.0.0 -> latest

• timeout - Time in seconds to retry connecting server. type: int more...

  	Supported Version Ranges
  timeout	v6.0.0 -> latest

• 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 -> latest
  [default]	v6.0.0 -> latest
  [SSLv3]	v6.0.0 -> latest
  [TLSv1]	v6.0.0 -> latest
  [TLSv1-1]	v6.0.0 -> latest
  [TLSv1-2]	v6.0.0 -> latest
  [TLSv1-3]	v7.4.1 -> latest

• transport_protocol - Transport protocol to be used . type: str choices: udp, tcp, tls more...

  	Supported Version Ranges
  transport_protocol	v7.4.0 -> latest
  [udp]	v6.0.0 -> latest
  [tcp]	v6.0.0 -> latest
  [tls]	v6.0.0 -> latest

• 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 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

• username_case_sensitive - Enable/disable case sensitive user names. type: str choices: enable, disable more...

  	Supported Version Ranges
  username_case_sensitive	v6.0.0 -> latest
  [enable]	v6.0.0 -> latest
  [disable]	v6.0.0 -> latest

Notes

Note

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

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"
          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_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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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