drmofu / drmofu.fortimanager / 2.2.2 / module / fmgr_user_radius_dynamicmapping Configure RADIUS server entries. | "added in version" 2.0.0 of drmofu.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 communitydrmofu.fortimanager.fmgr_user_radius_dynamicmapping (2.2.2) — module
Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2
collections: - name: drmofu.fortimanager version: 2.2.2
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.
- hosts: fortimanager00 collections: - fortinet.fortimanager 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 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: fortimanager00 gather_facts: no connection: httpapi collections: - fortinet.fortimanager 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 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 required: false type: list enable_log: default: false description: Enable/Disable logging for task. required: false type: bool access_token: description: The token to access FortiManager without using username and password. required: false type: str rc_succeeded: description: The rc codes list with which the conditions to succeed will be overriden. elements: int required: false type: list proposed_method: choices: - update - set - add description: The overridden method for the underlying Json RPC request. required: false 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. required: false 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. required: false type: str forticloud_access_token: description: Authenticate Ansible client with forticloud API access token. required: false type: str workspace_locking_timeout: default: 300 description: The maximum time in seconds to wait for other user to release the workspace lock. required: false type: int user_radius_dynamicmapping: description: the top level parameters set required: false suboptions: _scope: description: description elements: dict suboptions: name: description: no description type: str vdom: description: no description type: str type: list accounting-server: description: description elements: dict suboptions: id: description: no description type: int interface: description: no description type: str interface-select-method: choices: - auto - sdwan - specify description: no description type: str port: description: no description type: int secret: description: description type: str server: description: no description type: str source-ip: description: no description type: str status: choices: - disable - enable description: no description type: str type: list acct-all-servers: choices: - disable - enable description: no description type: str acct-interim-interval: description: no description type: int all-usergroup: choices: - disable - enable description: no description type: str auth-type: choices: - pap - chap - ms_chap - ms_chap_v2 - auto description: no description type: str ca-cert: description: CA of server to trust under TLS. type: str class: description: description type: str client-cert: description: 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: no description 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: no description type: str dp-context-timeout: description: no description type: int dp-flush-ip-session: choices: - disable - enable description: no description type: str dp-hold-time: description: no description type: int dp-http-header: description: no description type: str dp-http-header-fallback: choices: - ip-header-address - default-profile description: no description type: str dp-http-header-status: choices: - disable - enable description: no description type: str dp-http-header-suppress: choices: - disable - enable description: no description type: str dp-log-dyn_flags: choices: - none - protocol-error - profile-missing - context-missing - accounting-stop-missed - accounting-event - radiusd-other - endpoint-block description: description elements: str type: list dp-log-period: description: no description type: int dp-mem-percent: description: no description 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: no description type: str dp-profile-attribute-key: description: no description type: str dp-radius-response: choices: - disable - enable description: no description type: str dp-radius-server-port: description: no description type: int dp-secret: description: description type: str dp-validate-request-secret: choices: - disable - enable description: no description type: str dynamic-profile: choices: - disable - enable description: no description type: str endpoint-translation: choices: - disable - enable description: no description type: str ep-carrier-endpoint-convert-hex: choices: - disable - enable description: no description type: str ep-carrier-endpoint-header: description: no description type: str ep-carrier-endpoint-header-suppress: choices: - disable - enable description: no description type: str ep-carrier-endpoint-prefix: choices: - disable - enable description: no description type: str ep-carrier-endpoint-prefix-range-max: description: no description type: int ep-carrier-endpoint-prefix-range-min: description: no description type: int ep-carrier-endpoint-prefix-string: description: no description type: str ep-carrier-endpoint-source: choices: - http-header - cookie description: no description type: str ep-ip-header: description: no description type: str ep-ip-header-suppress: choices: - disable - enable description: no description type: str ep-missing-header-fallback: choices: - session-ip - policy-profile description: no description type: str ep-profile-query-type: choices: - session-ip - extract-ip - extract-carrier-endpoint description: no description type: str group-override-attr-type: choices: - filter-Id - class description: no description type: str h3c-compatibility: choices: - disable - enable description: no description type: str interface: description: no description type: str interface-select-method: choices: - auto - sdwan - specify description: no description type: str mac-case: choices: - uppercase - lowercase description: MAC authentication case type: str mac-password-delimiter: choices: - hyphen - single-hyphen - colon - none description: MAC authentication password delimiter type: str mac-username-delimiter: choices: - hyphen - single-hyphen - colon - none description: MAC authentication username delimiter type: str nas-id: description: Custom NAS identifier. type: str nas-id-type: choices: - legacy - custom - hostname description: NAS identifier type configuration type: str nas-ip: description: no description type: str password-encoding: choices: - ISO-8859-1 - auto description: no description type: str password-renewal: choices: - disable - enable description: no description type: str radius-coa: choices: - disable - enable description: no description type: str radius-port: description: no description type: int rsso: choices: - disable - enable description: no description type: str rsso-context-timeout: description: no description 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: no description 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: no description type: str rsso-ep-one-ip-only: choices: - disable - enable description: no description type: str rsso-flush-ip-session: choices: - disable - enable description: no description type: str rsso-log-flags: choices: - none - protocol-error - profile-missing - context-missing - accounting-stop-missed - accounting-event - radiusd-other - endpoint-block description: description elements: str type: list rsso-log-period: description: no description type: int rsso-radius-response: choices: - disable - enable description: no description type: str rsso-radius-server-port: description: no description type: int rsso-secret: description: description type: str rsso-validate-request-secret: choices: - disable - enable description: no description type: str secondary-secret: description: description type: str secondary-server: description: no description type: str secret: description: description type: str server: description: no description type: str server-identity-check: choices: - disable - enable description: Enable/disable RADIUS server identity check type: str source-ip: description: no description 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: no description type: str sso-attribute-key: description: no description type: str sso-attribute-value-override: choices: - disable - enable description: no description type: str status-ttl: description: Time for which server reachability is cached so that when a server is unreachable, it will not be retried for at least this per... type: int switch-controller-acct-fast-framedip-detect: description: no description type: int 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: description elements: str type: list tertiary-secret: description: description type: str tertiary-server: description: no description type: str timeout: description: no description type: int tls-min-proto-version: choices: - default - TLSv1 - TLSv1-1 - TLSv1-2 - SSLv3 description: Minimum supported protocol version for TLS connections type: str transport-protocol: choices: - udp - tcp - tls description: Transport protocol to be used type: str use-group-for-profile: choices: - disable - enable description: no description type: str use-management-vdom: choices: - disable - enable description: no description type: str username-case-sensitive: choices: - disable - enable description: no description 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