fortinet / fortinet.fortimanager / 2.4.0 / module / fmgr_user_radius_dynamicmapping Configure RADIUS server entries. | "added in version" 2.0.0 of fortinet.fortimanager" Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu) preview | supported by communityfortinet.fortimanager.fmgr_user_radius_dynamicmapping (2.4.0) — module
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections: - name: fortinet.fortimanager version: 2.4.0
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.
- 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"
adom: description: The parameter (adom) in requested url. required: true type: str state: choices: - present - absent description: The directive to create, update or delete an object. required: true type: str radius: description: The parameter (radius) in requested url. required: true type: str rc_failed: description: The rc codes list with which the conditions to fail will be overriden. elements: int type: list enable_log: default: false description: Enable/Disable logging for task. type: bool access_token: description: The token to access FortiManager without using username and password. type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. type: str bypass_validation: default: false description: Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool workspace_locking_adom: description: The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. type: int user_radius_dynamicmapping: description: The top level parameters set. required: false suboptions: _scope: description: No description. elements: dict suboptions: name: description: No description. type: str vdom: description: No description. type: str type: list account-key-cert-field: choices: - othername - rfc822name - dnsname description: Deprecated, please rename it to account_key_cert_field. Define subject identity field in certificate for user access right... type: str account-key-processing: choices: - same - strip description: Deprecated, please rename it to account_key_processing. Account key processing operation. type: str accounting-server: description: Deprecated, please rename it to accounting_server. elements: dict suboptions: id: description: No description. type: int interface: description: No description. type: str interface-select-method: choices: - auto - sdwan - specify description: Deprecated, please rename it to interface_select_method. type: str port: description: No description. type: int secret: description: (list) No description. type: raw server: description: No description. type: str source-ip: description: Deprecated, please rename it to source_ip. type: str status: choices: - disable - enable description: No description. type: str type: list acct-all-servers: choices: - disable - enable description: Deprecated, please rename it to acct_all_servers. type: str acct-interim-interval: description: Deprecated, please rename it to acct_interim_interval. type: int all-usergroup: choices: - disable - enable description: Deprecated, please rename it to all_usergroup. type: str auth-type: choices: - pap - chap - ms_chap - ms_chap_v2 - auto description: Deprecated, please rename it to auth_type. type: str ca-cert: description: Deprecated, please rename it to ca_cert. CA of server to trust under TLS. type: str call-station-id-type: choices: - legacy - IP - MAC description: Deprecated, please rename it to call_station_id_type. Calling & Called station identifier type configuration type: str class: description: (list) No description. type: raw client-cert: description: Deprecated, please rename it to client_cert. Client certificate to use under TLS. type: str delimiter: choices: - plus - comma description: Configure delimiter to be used for separating profile group names in the SSO attribute type: str 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 description: Deprecated, please rename it to dp_carrier_endpoint_attribute. type: str 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 description: Deprecated, please rename it to dp_carrier_endpoint_block_attribute. type: str dp-context-timeout: description: Deprecated, please rename it to dp_context_timeout. type: int dp-flush-ip-session: choices: - disable - enable description: Deprecated, please rename it to dp_flush_ip_session. type: str dp-hold-time: description: Deprecated, please rename it to dp_hold_time. type: int dp-http-header: description: Deprecated, please rename it to dp_http_header. type: str dp-http-header-fallback: choices: - ip-header-address - default-profile description: Deprecated, please rename it to dp_http_header_fallback. type: str dp-http-header-status: choices: - disable - enable description: Deprecated, please rename it to dp_http_header_status. type: str dp-http-header-suppress: choices: - disable - enable description: Deprecated, please rename it to dp_http_header_suppress. type: str dp-log-dyn_flags: choices: - none - protocol-error - profile-missing - context-missing - accounting-stop-missed - accounting-event - radiusd-other - endpoint-block description: Deprecated, please rename it to dp_log_dyn_flags. elements: str type: list dp-log-period: description: Deprecated, please rename it to dp_log_period. type: int dp-mem-percent: description: Deprecated, please rename it to dp_mem_percent. type: int 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 description: Deprecated, please rename it to dp_profile_attribute. type: str dp-profile-attribute-key: description: Deprecated, please rename it to dp_profile_attribute_key. type: str dp-radius-response: choices: - disable - enable description: Deprecated, please rename it to dp_radius_response. type: str dp-radius-server-port: description: Deprecated, please rename it to dp_radius_server_port. type: int dp-secret: description: (list) Deprecated, please rename it to dp_secret. type: raw dp-validate-request-secret: choices: - disable - enable description: Deprecated, please rename it to dp_validate_request_secret. type: str dynamic-profile: choices: - disable - enable description: Deprecated, please rename it to dynamic_profile. type: str endpoint-translation: choices: - disable - enable description: Deprecated, please rename it to endpoint_translation. type: str ep-carrier-endpoint-convert-hex: choices: - disable - enable description: Deprecated, please rename it to ep_carrier_endpoint_convert_hex. type: str ep-carrier-endpoint-header: description: Deprecated, please rename it to ep_carrier_endpoint_header. type: str ep-carrier-endpoint-header-suppress: choices: - disable - enable description: Deprecated, please rename it to ep_carrier_endpoint_header_suppress. type: str ep-carrier-endpoint-prefix: choices: - disable - enable description: Deprecated, please rename it to ep_carrier_endpoint_prefix. type: str ep-carrier-endpoint-prefix-range-max: description: Deprecated, please rename it to ep_carrier_endpoint_prefix_range_max. type: int ep-carrier-endpoint-prefix-range-min: description: Deprecated, please rename it to ep_carrier_endpoint_prefix_range_min. type: int ep-carrier-endpoint-prefix-string: description: Deprecated, please rename it to ep_carrier_endpoint_prefix_string. type: str ep-carrier-endpoint-source: choices: - http-header - cookie description: Deprecated, please rename it to ep_carrier_endpoint_source. type: str ep-ip-header: description: Deprecated, please rename it to ep_ip_header. type: str ep-ip-header-suppress: choices: - disable - enable description: Deprecated, please rename it to ep_ip_header_suppress. type: str ep-missing-header-fallback: choices: - session-ip - policy-profile description: Deprecated, please rename it to ep_missing_header_fallback. type: str ep-profile-query-type: choices: - session-ip - extract-ip - extract-carrier-endpoint description: Deprecated, please rename it to ep_profile_query_type. type: str group-override-attr-type: choices: - filter-Id - class description: Deprecated, please rename it to group_override_attr_type. type: str h3c-compatibility: choices: - disable - enable description: Deprecated, please rename it to h3c_compatibility. type: str interface: description: No description. type: str interface-select-method: choices: - auto - sdwan - specify description: Deprecated, please rename it to interface_select_method. type: str mac-case: choices: - uppercase - lowercase description: Deprecated, please rename it to mac_case. MAC authentication case type: str mac-password-delimiter: choices: - hyphen - single-hyphen - colon - none description: Deprecated, please rename it to mac_password_delimiter. MAC authentication password delimiter type: str mac-username-delimiter: choices: - hyphen - single-hyphen - colon - none description: Deprecated, please rename it to mac_username_delimiter. MAC authentication username delimiter type: str nas-id: description: Deprecated, please rename it to nas_id. Custom NAS identifier. type: str nas-id-type: choices: - legacy - custom - hostname description: Deprecated, please rename it to nas_id_type. NAS identifier type configuration type: str nas-ip: description: Deprecated, please rename it to nas_ip. type: str password-encoding: choices: - ISO-8859-1 - auto description: Deprecated, please rename it to password_encoding. type: str password-renewal: choices: - disable - enable description: Deprecated, please rename it to password_renewal. type: str radius-coa: choices: - disable - enable description: Deprecated, please rename it to radius_coa. type: str radius-port: description: Deprecated, please rename it to radius_port. type: int rsso: choices: - disable - enable description: No description. type: str rsso-context-timeout: description: Deprecated, please rename it to rsso_context_timeout. type: int 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 description: Deprecated, please rename it to rsso_endpoint_attribute. type: str 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 description: Deprecated, please rename it to rsso_endpoint_block_attribute. type: str rsso-ep-one-ip-only: choices: - disable - enable description: Deprecated, please rename it to rsso_ep_one_ip_only. type: str rsso-flush-ip-session: choices: - disable - enable description: Deprecated, please rename it to rsso_flush_ip_session. type: str rsso-log-flags: choices: - none - protocol-error - profile-missing - context-missing - accounting-stop-missed - accounting-event - radiusd-other - endpoint-block description: Deprecated, please rename it to rsso_log_flags. elements: str type: list rsso-log-period: description: Deprecated, please rename it to rsso_log_period. type: int rsso-radius-response: choices: - disable - enable description: Deprecated, please rename it to rsso_radius_response. type: str rsso-radius-server-port: description: Deprecated, please rename it to rsso_radius_server_port. type: int rsso-secret: description: (list) Deprecated, please rename it to rsso_secret. type: raw rsso-validate-request-secret: choices: - disable - enable description: Deprecated, please rename it to rsso_validate_request_secret. type: str secondary-secret: description: (list) Deprecated, please rename it to secondary_secret. type: raw secondary-server: description: Deprecated, please rename it to secondary_server. type: str secret: description: (list) No description. type: raw server: description: No description. type: str server-identity-check: choices: - disable - enable description: Deprecated, please rename it to server_identity_check. Enable/disable RADIUS server identity check type: str source-ip: description: Deprecated, please rename it to source_ip. type: str 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 description: Deprecated, please rename it to sso_attribute. type: str sso-attribute-key: description: Deprecated, please rename it to sso_attribute_key. type: str sso-attribute-value-override: choices: - disable - enable description: Deprecated, please rename it to sso_attribute_value_override. type: str status-ttl: description: Deprecated, please rename it to status_ttl. Time for which server reachability is cached so that when a server is unreacha... type: int switch-controller-acct-fast-framedip-detect: description: Deprecated, please rename it to switch_controller_acct_fast_framedip_detect. type: int switch-controller-nas-ip-dynamic: choices: - disable - enable description: Deprecated, please rename it to switch_controller_nas_ip_dynamic. Enable/Disable switch-controller nas-ip dynamic to dynam... type: str switch-controller-service-type: choices: - login - framed - callback-login - callback-framed - outbound - administrative - nas-prompt - authenticate-only - callback-nas-prompt - call-check - callback-administrative description: Deprecated, please rename it to switch_controller_service_type. elements: str type: list tertiary-secret: description: (list) Deprecated, please rename it to tertiary_secret. type: raw tertiary-server: description: Deprecated, please rename it to tertiary_server. type: str timeout: description: No description. type: int tls-min-proto-version: choices: - default - TLSv1 - TLSv1-1 - TLSv1-2 - SSLv3 - TLSv1-3 description: Deprecated, please rename it to tls_min_proto_version. Minimum supported protocol version for TLS connections type: str transport-protocol: choices: - udp - tcp - tls description: Deprecated, please rename it to transport_protocol. Transport protocol to be used type: str use-group-for-profile: choices: - disable - enable description: Deprecated, please rename it to use_group_for_profile. type: str use-management-vdom: choices: - disable - enable description: Deprecated, please rename it to use_management_vdom. type: str username-case-sensitive: choices: - disable - enable description: Deprecated, please rename it to username_case_sensitive. type: str type: dict
meta: contains: request_url: description: The full url requested. returned: always sample: /sys/login/user type: str response_code: description: The status of api request. returned: always sample: 0 type: int response_data: description: The api response. returned: always type: list response_message: description: The descriptive message of the api response. returned: always sample: OK. type: str system_information: description: The information of the target system. returned: always type: dict description: The result of the request. returned: always type: dict rc: description: The status the request. returned: always sample: 0 type: int version_check_warning: description: Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: complex type: list