fortinet.fortimanager.fmgr_user_radius module – Configure RADIUS server entries.

Note

This module is part of the fortinet.fortimanager collection (version 2.8.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.fortimanager.

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

New in fortinet.fortimanager 2.0.0

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

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

user_radius

dictionary

The top level parameters set.

account_key_cert_field

aliases: account-key-cert-field

string

Define subject identity field in certificate for user access right checking.

Choices:

  • "othername"

  • "rfc822name"

  • "dnsname"

  • "cn"

account_key_processing

aliases: account-key-processing

string

Account key processing operation.

Choices:

  • "same"

  • "strip"

accounting_server

aliases: accounting-server

list / elements=dictionary

Accounting server.

id

integer

ID

interface

string

Specify outgoing interface to reach server.

interface_select_method

aliases: interface-select-method

string

Specify how to select outgoing interface to reach server.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

port

integer

RADIUS accounting port number.

secret

any

(list) Secret key.

server

string

No description

source_ip

aliases: source-ip

string

Source IP address for communications to the RADIUS server.

status

string

Status.

Choices:

  • "disable"

  • "enable"

acct_all_servers

aliases: acct-all-servers

string

Enable/disable sending of accounting messages to all configured servers

Choices:

  • "disable"

  • "enable"

acct_interim_interval

aliases: acct-interim-interval

integer

Time in seconds between each accounting interim update message.

all_usergroup

aliases: all-usergroup

string

Enable/disable automatically including this RADIUS server in all user groups.

Choices:

  • "disable"

  • "enable"

auth_type

aliases: auth-type

string

Authentication methods/protocols permitted for this RADIUS server.

Choices:

  • "pap"

  • "chap"

  • "ms_chap"

  • "ms_chap_v2"

  • "auto"

ca_cert

aliases: ca-cert

string

CA of server to trust under TLS.

call_station_id_type

aliases: call-station-id-type

string

Calling & Called station identifier type configuration

Choices:

  • "legacy"

  • "IP"

  • "MAC"

class

any

(list) Class attribute name

client_cert

aliases: client-cert

string

Client certificate to use under TLS.

delimiter

string

Configure delimiter to be used for separating profile group names in the SSO attribute

Choices:

  • "plus"

  • "comma"

dynamic_mapping

list / elements=dictionary

Dynamic mapping.

_scope

list / elements=dictionary

Scope.

name

string

Name.

vdom

string

Vdom.

account_key_cert_field

aliases: account-key-cert-field

string

Define subject identity field in certificate for user access right checking.

Choices:

  • "othername"

  • "rfc822name"

  • "dnsname"

  • "cn"

account_key_processing

aliases: account-key-processing

string

Account key processing operation.

Choices:

  • "same"

  • "strip"

accounting_server

aliases: accounting-server

list / elements=dictionary

Accounting server.

id

integer

Id.

interface

string

Interface.

interface_select_method

aliases: interface-select-method

string

Interface select method.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

port

integer

Port.

secret

any

(list) Secret.

server

string

Server.

source_ip

aliases: source-ip

string

Source ip.

status

string

Status.

Choices:

  • "disable"

  • "enable"

acct_all_servers

aliases: acct-all-servers

string

Acct all servers.

Choices:

  • "disable"

  • "enable"

acct_interim_interval

aliases: acct-interim-interval

integer

Acct interim interval.

all_usergroup

aliases: all-usergroup

string

All usergroup.

Choices:

  • "disable"

  • "enable"

auth_type

aliases: auth-type

string

Auth type.

Choices:

  • "pap"

  • "chap"

  • "ms_chap"

  • "ms_chap_v2"

  • "auto"

ca_cert

aliases: ca-cert

string

CA of server to trust under TLS.

call_station_id_type

aliases: call-station-id-type

string

Calling & Called station identifier type configuration

Choices:

  • "legacy"

  • "IP"

  • "MAC"

class

any

(list) Class.

client_cert

aliases: client-cert

string

Client certificate to use under TLS.

delimiter

string

Configure delimiter to be used for separating profile group names in the SSO attribute

Choices:

  • "plus"

  • "comma"

dp_carrier_endpoint_attribute

aliases: dp-carrier-endpoint-attribute

string

Dp carrier endpoint attribute.

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

aliases: dp-carrier-endpoint-block-attribute

string

Dp carrier endpoint block attribute.

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_context_timeout

aliases: dp-context-timeout

integer

Dp context timeout.

dp_flush_ip_session

aliases: dp-flush-ip-session

string

Dp flush ip session.

Choices:

  • "disable"

  • "enable"

dp_hold_time

aliases: dp-hold-time

integer

Dp hold time.

dp_http_header

aliases: dp-http-header

string

Dp http header.

dp_http_header_fallback

aliases: dp-http-header-fallback

string

Dp http header fallback.

Choices:

  • "ip-header-address"

  • "default-profile"

dp_http_header_status

aliases: dp-http-header-status

string

Dp http header status.

Choices:

  • "disable"

  • "enable"

dp_http_header_suppress

aliases: dp-http-header-suppress

string

Dp http header suppress.

Choices:

  • "disable"

  • "enable"

dp_log_dyn_flags

aliases: dp-log-dyn_flags

list / elements=string

Dp log dyn flags.

Choices:

  • "none"

  • "protocol-error"

  • "profile-missing"

  • "context-missing"

  • "accounting-stop-missed"

  • "accounting-event"

  • "radiusd-other"

  • "endpoint-block"

dp_log_period

aliases: dp-log-period

integer

Dp log period.

dp_mem_percent

aliases: dp-mem-percent

integer

Dp mem percent.

dp_profile_attribute

aliases: dp-profile-attribute

string

Dp profile attribute.

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_key

aliases: dp-profile-attribute-key

string

Dp profile attribute key.

dp_radius_response

aliases: dp-radius-response

string

Dp radius response.

Choices:

  • "disable"

  • "enable"

dp_radius_server_port

aliases: dp-radius-server-port

integer

Dp radius server port.

dp_secret

aliases: dp-secret

any

(list) Dp secret.

dp_validate_request_secret

aliases: dp-validate-request-secret

string

Dp validate request secret.

Choices:

  • "disable"

  • "enable"

dynamic_profile

aliases: dynamic-profile

string

Dynamic profile.

Choices:

  • "disable"

  • "enable"

endpoint_translation

aliases: endpoint-translation

string

Endpoint translation.

Choices:

  • "disable"

  • "enable"

ep_carrier_endpoint_convert_hex

aliases: ep-carrier-endpoint-convert-hex

string

Ep carrier endpoint convert hex.

Choices:

  • "disable"

  • "enable"

ep_carrier_endpoint_header

aliases: ep-carrier-endpoint-header

string

Ep carrier endpoint header.

ep_carrier_endpoint_header_suppress

aliases: ep-carrier-endpoint-header-suppress

string

Ep carrier endpoint header suppress.

Choices:

  • "disable"

  • "enable"

ep_carrier_endpoint_prefix

aliases: ep-carrier-endpoint-prefix

string

Ep carrier endpoint prefix.

Choices:

  • "disable"

  • "enable"

ep_carrier_endpoint_prefix_range_max

aliases: ep-carrier-endpoint-prefix-range-max

integer

Ep carrier endpoint prefix range max.

ep_carrier_endpoint_prefix_range_min

aliases: ep-carrier-endpoint-prefix-range-min

integer

Ep carrier endpoint prefix range min.

ep_carrier_endpoint_prefix_string

aliases: ep-carrier-endpoint-prefix-string

string

Ep carrier endpoint prefix string.

ep_carrier_endpoint_source

aliases: ep-carrier-endpoint-source

string

Ep carrier endpoint source.

Choices:

  • "http-header"

  • "cookie"

ep_ip_header

aliases: ep-ip-header

string

Ep ip header.

ep_ip_header_suppress

aliases: ep-ip-header-suppress

string

Ep ip header suppress.

Choices:

  • "disable"

  • "enable"

ep_missing_header_fallback

aliases: ep-missing-header-fallback

string

Ep missing header fallback.

Choices:

  • "session-ip"

  • "policy-profile"

ep_profile_query_type

aliases: ep-profile-query-type

string

Ep profile query type.

Choices:

  • "session-ip"

  • "extract-ip"

  • "extract-carrier-endpoint"

group_override_attr_type

aliases: group-override-attr-type

string

Group override attr type.

Choices:

  • "filter-Id"

  • "class"

h3c_compatibility

aliases: h3c-compatibility

string

H3c compatibility.

Choices:

  • "disable"

  • "enable"

interface

string

Interface.

interface_select_method

aliases: interface-select-method

string

Interface select method.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

mac_case

aliases: mac-case

string

MAC authentication case

Choices:

  • "uppercase"

  • "lowercase"

mac_password_delimiter

aliases: mac-password-delimiter

string

MAC authentication password delimiter

Choices:

  • "hyphen"

  • "single-hyphen"

  • "colon"

  • "none"

mac_username_delimiter

aliases: mac-username-delimiter

string

MAC authentication username delimiter

Choices:

  • "hyphen"

  • "single-hyphen"

  • "colon"

  • "none"

nas_id

aliases: nas-id

string

Custom NAS identifier.

nas_id_type

aliases: nas-id-type

string

NAS identifier type configuration

Choices:

  • "legacy"

  • "custom"

  • "hostname"

nas_ip

aliases: nas-ip

string

Nas ip.

password_encoding

aliases: password-encoding

string

Password encoding.

Choices:

  • "ISO-8859-1"

  • "auto"

password_renewal

aliases: password-renewal

string

Password renewal.

Choices:

  • "disable"

  • "enable"

radius_coa

aliases: radius-coa

string

Radius coa.

Choices:

  • "disable"

  • "enable"

radius_port

aliases: radius-port

integer

Radius port.

rsso

string

Rsso.

Choices:

  • "disable"

  • "enable"

rsso_context_timeout

aliases: rsso-context-timeout

integer

Rsso context timeout.

rsso_endpoint_attribute

aliases: rsso-endpoint-attribute

string

Rsso endpoint attribute.

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"

rsso_endpoint_block_attribute

aliases: rsso-endpoint-block-attribute

string

Rsso endpoint block attribute.

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"

rsso_ep_one_ip_only

aliases: rsso-ep-one-ip-only

string

Rsso ep one ip only.

Choices:

  • "disable"

  • "enable"

rsso_flush_ip_session

aliases: rsso-flush-ip-session

string

Rsso flush ip session.

Choices:

  • "disable"

  • "enable"

rsso_log_flags

aliases: rsso-log-flags

list / elements=string

Rsso log flags.

Choices:

  • "none"

  • "protocol-error"

  • "profile-missing"

  • "context-missing"

  • "accounting-stop-missed"

  • "accounting-event"

  • "radiusd-other"

  • "endpoint-block"

rsso_log_period

aliases: rsso-log-period

integer

Rsso log period.

rsso_radius_response

aliases: rsso-radius-response

string

Rsso radius response.

Choices:

  • "disable"

  • "enable"

rsso_radius_server_port

aliases: rsso-radius-server-port

integer

Rsso radius server port.

rsso_secret

aliases: rsso-secret

any

(list) Rsso secret.

rsso_validate_request_secret

aliases: rsso-validate-request-secret

string

Rsso validate request secret.

Choices:

  • "disable"

  • "enable"

secondary_secret

aliases: secondary-secret

any

(list) Secondary secret.

secondary_server

aliases: secondary-server

string

Secondary server.

secret

any

(list) Secret.

server

string

Server.

server_identity_check

aliases: server-identity-check

string

Enable/disable RADIUS server identity check

Choices:

  • "disable"

  • "enable"

source_ip

aliases: source-ip

string

Source ip.

source_ip_interface

aliases: source-ip-interface

any

(list) Source interface for communication with the RADIUS server.

sso_attribute

aliases: sso-attribute

string

Sso attribute.

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"

sso_attribute_key

aliases: sso-attribute-key

string

Sso attribute key.

sso_attribute_value_override

aliases: sso-attribute-value-override

string

Sso attribute value override.

Choices:

  • "disable"

  • "enable"

status_ttl

aliases: status-ttl

integer

Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at l…

switch_controller_acct_fast_framedip_detect

aliases: switch-controller-acct-fast-framedip-detect

integer

Switch controller acct fast framedip detect.

switch_controller_nas_ip_dynamic

aliases: switch-controller-nas-ip-dynamic

string

Enable/Disable switch-controller nas-ip dynamic to dynamically set nas-ip.

Choices:

  • "disable"

  • "enable"

switch_controller_service_type

aliases: switch-controller-service-type

list / elements=string

Switch controller service type.

Choices:

  • "login"

  • "framed"

  • "callback-login"

  • "callback-framed"

  • "outbound"

  • "administrative"

  • "nas-prompt"

  • "authenticate-only"

  • "callback-nas-prompt"

  • "call-check"

  • "callback-administrative"

tertiary_secret

aliases: tertiary-secret

any

(list) Tertiary secret.

tertiary_server

aliases: tertiary-server

string

Tertiary server.

timeout

integer

Timeout.

tls_min_proto_version

aliases: tls-min-proto-version

string

Minimum supported protocol version for TLS connections

Choices:

  • "default"

  • "TLSv1"

  • "TLSv1-1"

  • "TLSv1-2"

  • "SSLv3"

  • "TLSv1-3"

transport_protocol

aliases: transport-protocol

string

Transport protocol to be used

Choices:

  • "udp"

  • "tcp"

  • "tls"

use_group_for_profile

aliases: use-group-for-profile

string

Use group for profile.

Choices:

  • "disable"

  • "enable"

use_management_vdom

aliases: use-management-vdom

string

Use management vdom.

Choices:

  • "disable"

  • "enable"

username_case_sensitive

aliases: username-case-sensitive

string

Username case sensitive.

Choices:

  • "disable"

  • "enable"

group_override_attr_type

aliases: group-override-attr-type

string

RADIUS attribute type to override user group information.

Choices:

  • "filter-Id"

  • "class"

h3c_compatibility

aliases: h3c-compatibility

string

Enable/disable compatibility with the H3C, a mechanism that performs security checking for authentication.

Choices:

  • "disable"

  • "enable"

interface

string

Specify outgoing interface to reach server.

interface_select_method

aliases: interface-select-method

string

Specify how to select outgoing interface to reach server.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

mac_case

aliases: mac-case

string

MAC authentication case

Choices:

  • "uppercase"

  • "lowercase"

mac_password_delimiter

aliases: mac-password-delimiter

string

MAC authentication password delimiter

Choices:

  • "hyphen"

  • "single-hyphen"

  • "colon"

  • "none"

mac_username_delimiter

aliases: mac-username-delimiter

string

MAC authentication username delimiter

Choices:

  • "hyphen"

  • "single-hyphen"

  • "colon"

  • "none"

name

string / required

RADIUS server entry name.

nas_id

aliases: nas-id

string

Custom NAS identifier.

nas_id_type

aliases: nas-id-type

string

NAS identifier type configuration

Choices:

  • "legacy"

  • "custom"

  • "hostname"

nas_ip

aliases: 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

aliases: password-encoding

string

Password encoding.

Choices:

  • "ISO-8859-1"

  • "auto"

password_renewal

aliases: password-renewal

string

Enable/disable password renewal.

Choices:

  • "disable"

  • "enable"

radius_coa

aliases: radius-coa

string

Enable to allow a mechanism to change the attributes of an authentication, authorization, and accounting session after it …

Choices:

  • "disable"

  • "enable"

radius_port

aliases: radius-port

integer

RADIUS service port number.

rsso

string

Enable/disable RADIUS based single sign on feature.

Choices:

  • "disable"

  • "enable"

rsso_context_timeout

aliases: 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

aliases: rsso-endpoint-attribute

string

RADIUS attributes used to extract the user end point identifer from the RADIUS Start record.

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"

rsso_endpoint_block_attribute

aliases: rsso-endpoint-block-attribute

string

RADIUS attributes used to block a user.

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"

rsso_ep_one_ip_only

aliases: rsso-ep-one-ip-only

string

Enable/disable the replacement of old IP addresses with new ones for the same endpoint on RADIUS accounting Start messages.

Choices:

  • "disable"

  • "enable"

rsso_flush_ip_session

aliases: rsso-flush-ip-session

string

Enable/disable flushing user IP sessions on RADIUS accounting Stop messages.

Choices:

  • "disable"

  • "enable"

rsso_log_flags

aliases: rsso-log-flags

list / elements=string

Events to log.

Choices:

  • "none"

  • "protocol-error"

  • "profile-missing"

  • "context-missing"

  • "accounting-stop-missed"

  • "accounting-event"

  • "radiusd-other"

  • "endpoint-block"

rsso_log_period

aliases: rsso-log-period

integer

Time interval in seconds that group event log messages will be generated for dynamic profile events.

rsso_radius_response

aliases: rsso-radius-response

string

Enable/disable sending RADIUS response packets after receiving Start and Stop records.

Choices:

  • "disable"

  • "enable"

rsso_radius_server_port

aliases: rsso-radius-server-port

integer

UDP port to listen on for RADIUS Start and Stop records.

rsso_secret

aliases: rsso-secret

any

(list) RADIUS secret used by the RADIUS accounting server.

rsso_validate_request_secret

aliases: rsso-validate-request-secret

string

Enable/disable validating the RADIUS request shared secret in the Start or End record.

Choices:

  • "disable"

  • "enable"

secondary_secret

aliases: secondary-secret

any

(list) Secret key to access the secondary server.

secondary_server

aliases: secondary-server

string

No description

secret

any

(list) Pre-shared secret key used to access the primary RADIUS server.

server

string

Primary RADIUS server CN domain name or IP address.

server_identity_check

aliases: server-identity-check

string

Enable/disable RADIUS server identity check

Choices:

  • "disable"

  • "enable"

source_ip

aliases: source-ip

string

Source IP address for communications to the RADIUS server.

source_ip_interface

aliases: source-ip-interface

any

(list) Source interface for communication with the RADIUS server.

sso_attribute

aliases: sso-attribute

string

RADIUS attribute that contains the profile group name to be extracted from the RADIUS Start record.

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"

sso_attribute_key

aliases: sso-attribute-key

string

Key prefix for SSO group value in the SSO attribute.

sso_attribute_value_override

aliases: sso-attribute-value-override

string

Enable/disable override old attribute value with new value for the same endpoint.

Choices:

  • "disable"

  • "enable"

status_ttl

aliases: status-ttl

integer

Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at least thi…

switch_controller_acct_fast_framedip_detect

aliases: switch-controller-acct-fast-framedip-detect

integer

Switch controller accounting message Framed-IP detection from DHCP snooping

switch_controller_nas_ip_dynamic

aliases: switch-controller-nas-ip-dynamic

string

Enable/Disable switch-controller nas-ip dynamic to dynamically set nas-ip.

Choices:

  • "disable"

  • "enable"

switch_controller_service_type

aliases: switch-controller-service-type

list / elements=string

RADIUS service type.

Choices:

  • "login"

  • "framed"

  • "callback-login"

  • "callback-framed"

  • "outbound"

  • "administrative"

  • "nas-prompt"

  • "authenticate-only"

  • "callback-nas-prompt"

  • "call-check"

  • "callback-administrative"

tertiary_secret

aliases: tertiary-secret

any

(list) Secret key to access the tertiary server.

tertiary_server

aliases: tertiary-server

string

No description

timeout

integer

Time in seconds between re-sending authentication requests.

tls_min_proto_version

aliases: tls-min-proto-version

string

Minimum supported protocol version for TLS connections

Choices:

  • "default"

  • "TLSv1"

  • "TLSv1-1"

  • "TLSv1-2"

  • "SSLv3"

  • "TLSv1-3"

transport_protocol

aliases: transport-protocol

string

Transport protocol to be used

Choices:

  • "udp"

  • "tcp"

  • "tls"

use_management_vdom

aliases: use-management-vdom

string

Enable/disable using management VDOM to send requests.

Choices:

  • "disable"

  • "enable"

username_case_sensitive

aliases: username-case-sensitive

string

Enable/disable case sensitive user names.

Choices:

  • "disable"

  • "enable"

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

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure RADIUS server entries.
      fortinet.fortimanager.fmgr_user_radius:
        bypass_validation: false
        adom: ansible
        state: present
        user_radius:
          name: ansible-test-radius
          server: ansible
          timeout: 200

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the RADIUS server entries
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_radius"
          params:
            adom: "ansible"
            radius: "your_value"

Return Values

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

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)