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

Note

This module is part of the fortinet.fortimanager collection (version 2.8.0).

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

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"

radius

string / required

The parameter (radius) in requested url.

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_dynamicmapping

dictionary

The top level parameters set.

_scope

list / elements=dictionary

Scope.

name

string

Name.

vdom

string

Vdom.

account_key_cert_field

string

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

Choices:

  • "othername"

  • "rfc822name"

  • "dnsname"

  • "cn"

account_key_processing

string

Account key processing operation.

Choices:

  • "same"

  • "strip"

accounting_server

list / elements=dictionary

Accounting server.

id

integer

Id.

interface

string

Interface.

interface_select_method

string

Interface select method.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

port

integer

Port.

secret

any

(list) Secret.

server

string

Server.

source_ip

string

Source ip.

status

string

Status.

Choices:

  • "disable"

  • "enable"

acct_all_servers

string

Acct all servers.

Choices:

  • "disable"

  • "enable"

acct_interim_interval

integer

Acct interim interval.

all_usergroup

string

All usergroup.

Choices:

  • "disable"

  • "enable"

auth_type

string

Auth type.

Choices:

  • "pap"

  • "chap"

  • "ms_chap"

  • "ms_chap_v2"

  • "auto"

ca_cert

string

CA of server to trust under TLS.

call_station_id_type

string

Calling & Called station identifier type configuration

Choices:

  • "legacy"

  • "IP"

  • "MAC"

class

any

(list) Class.

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

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

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

integer

Dp context timeout.

dp_flush_ip_session

string

Dp flush ip session.

Choices:

  • "disable"

  • "enable"

dp_hold_time

integer

Dp hold time.

dp_http_header

string

Dp http header.

dp_http_header_fallback

string

Dp http header fallback.

Choices:

  • "ip-header-address"

  • "default-profile"

dp_http_header_status

string

Dp http header status.

Choices:

  • "disable"

  • "enable"

dp_http_header_suppress

string

Dp http header suppress.

Choices:

  • "disable"

  • "enable"

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

integer

Dp log period.

dp_mem_percent

integer

Dp mem percent.

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

string

Dp profile attribute key.

dp_radius_response

string

Dp radius response.

Choices:

  • "disable"

  • "enable"

dp_radius_server_port

integer

Dp radius server port.

dp_secret

any

(list) Dp secret.

dp_validate_request_secret

string

Dp validate request secret.

Choices:

  • "disable"

  • "enable"

dynamic_profile

string

Dynamic profile.

Choices:

  • "disable"

  • "enable"

endpoint_translation

string

Endpoint translation.

Choices:

  • "disable"

  • "enable"

ep_carrier_endpoint_convert_hex

string

Ep carrier endpoint convert hex.

Choices:

  • "disable"

  • "enable"

ep_carrier_endpoint_header

string

Ep carrier endpoint header.

ep_carrier_endpoint_header_suppress

string

Ep carrier endpoint header suppress.

Choices:

  • "disable"

  • "enable"

ep_carrier_endpoint_prefix

string

Ep carrier endpoint prefix.

Choices:

  • "disable"

  • "enable"

ep_carrier_endpoint_prefix_range_max

integer

Ep carrier endpoint prefix range max.

ep_carrier_endpoint_prefix_range_min

integer

Ep carrier endpoint prefix range min.

ep_carrier_endpoint_prefix_string

string

Ep carrier endpoint prefix string.

ep_carrier_endpoint_source

string

Ep carrier endpoint source.

Choices:

  • "http-header"

  • "cookie"

ep_ip_header

string

Ep ip header.

ep_ip_header_suppress

string

Ep ip header suppress.

Choices:

  • "disable"

  • "enable"

ep_missing_header_fallback

string

Ep missing header fallback.

Choices:

  • "session-ip"

  • "policy-profile"

ep_profile_query_type

string

Ep profile query type.

Choices:

  • "session-ip"

  • "extract-ip"

  • "extract-carrier-endpoint"

group_override_attr_type

string

Group override attr type.

Choices:

  • "filter-Id"

  • "class"

h3c_compatibility

string

H3c compatibility.

Choices:

  • "disable"

  • "enable"

interface

string

Interface.

interface_select_method

string

Interface select method.

Choices:

  • "auto"

  • "sdwan"

  • "specify"

mac_case

string

MAC authentication case

Choices:

  • "uppercase"

  • "lowercase"

mac_password_delimiter

string

MAC authentication password delimiter

Choices:

  • "hyphen"

  • "single-hyphen"

  • "colon"

  • "none"

mac_username_delimiter

string

MAC authentication username delimiter

Choices:

  • "hyphen"

  • "single-hyphen"

  • "colon"

  • "none"

nas_id

string

Custom NAS identifier.

nas_id_type

string

NAS identifier type configuration

Choices:

  • "legacy"

  • "custom"

  • "hostname"

nas_ip

string

Nas ip.

password_encoding

string

Password encoding.

Choices:

  • "ISO-8859-1"

  • "auto"

password_renewal

string

Password renewal.

Choices:

  • "disable"

  • "enable"

radius_coa

string

Radius coa.

Choices:

  • "disable"

  • "enable"

radius_port

integer

Radius port.

rsso

string

Rsso.

Choices:

  • "disable"

  • "enable"

rsso_context_timeout

integer

Rsso context timeout.

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

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

string

Rsso ep one ip only.

Choices:

  • "disable"

  • "enable"

rsso_flush_ip_session

string

Rsso flush ip session.

Choices:

  • "disable"

  • "enable"

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

integer

Rsso log period.

rsso_radius_response

string

Rsso radius response.

Choices:

  • "disable"

  • "enable"

rsso_radius_server_port

integer

Rsso radius server port.

rsso_secret

any

(list) Rsso secret.

rsso_validate_request_secret

string

Rsso validate request secret.

Choices:

  • "disable"

  • "enable"

secondary_secret

any

(list) Secondary secret.

secondary_server

string

Secondary server.

secret

any

(list) Secret.

server

string

Server.

server_identity_check

string

Enable/disable RADIUS server identity check

Choices:

  • "disable"

  • "enable"

source_ip

string

Source ip.

source_ip_interface

any

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

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

string

Sso attribute key.

sso_attribute_value_override

string

Sso attribute value override.

Choices:

  • "disable"

  • "enable"

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

integer

Switch controller acct fast framedip detect.

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

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

any

(list) Tertiary secret.

tertiary_server

string

Tertiary server.

timeout

integer

Timeout.

tls_min_proto_version

string

Minimum supported protocol version for TLS connections

Choices:

  • "default"

  • "TLSv1"

  • "TLSv1-1"

  • "TLSv1-2"

  • "SSLv3"

  • "TLSv1-3"

transport_protocol

string

Transport protocol to be used

Choices:

  • "udp"

  • "tcp"

  • "tls"

use_group_for_profile

string

Use group for profile.

Choices:

  • "disable"

  • "enable"

use_management_vdom

string

Use management vdom.

Choices:

  • "disable"

  • "enable"

username_case_sensitive

string

Username case sensitive.

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 dynamic mappings of RADIUS server
      fortinet.fortimanager.fmgr_user_radius_dynamicmapping:
        bypass_validation: false
        adom: ansible
        radius: ansible-test-radius # name
        state: present
        user_radius_dynamicmapping:
          _scope:
            - name: FGT_AWS # need a valid device name
              vdom: root # need a valid vdom name under the device
          server: ansible
          timeout: 100

- 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 dynamic mappings of RADIUS server
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_radius_dynamicmapping"
          params:
            adom: "ansible"
            radius: "ansible-test-radius" # name
            dynamic_mapping: "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)