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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The parameter (radius) in requested url. |
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The top level parameters set. |
|
Scope. |
|
Name. |
|
Vdom. |
|
Define subject identity field in certificate for user access right checking. Choices:
|
|
Account key processing operation. Choices:
|
|
Accounting server. |
|
Id. |
|
Interface. |
|
Interface select method. Choices:
|
|
Port. |
|
(list) Secret. |
|
Server. |
|
Source ip. |
|
Status. Choices:
|
|
Acct all servers. Choices:
|
|
Acct interim interval. |
|
All usergroup. Choices:
|
|
Auth type. Choices:
|
|
CA of server to trust under TLS. |
|
Calling & Called station identifier type configuration Choices:
|
|
(list) Class. |
|
Client certificate to use under TLS. |
|
Configure delimiter to be used for separating profile group names in the SSO attribute Choices:
|
|
Dp carrier endpoint attribute. Choices:
|
|
Dp carrier endpoint block attribute. Choices:
|
|
Dp context timeout. |
|
Dp flush ip session. Choices:
|
|
Dp hold time. |
|
Dp http header. |
|
Dp http header fallback. Choices:
|
|
Dp http header status. Choices:
|
|
Dp http header suppress. Choices:
|
|
Dp log dyn flags. Choices:
|
|
Dp log period. |
|
Dp mem percent. |
|
Dp profile attribute. Choices:
|
|
Dp profile attribute key. |
|
Dp radius response. Choices:
|
|
Dp radius server port. |
|
(list) Dp secret. |
|
Dp validate request secret. Choices:
|
|
Dynamic profile. Choices:
|
|
Endpoint translation. Choices:
|
|
Ep carrier endpoint convert hex. Choices:
|
|
Ep carrier endpoint header. |
|
Ep carrier endpoint header suppress. Choices:
|
|
Ep carrier endpoint prefix. Choices:
|
|
Ep carrier endpoint prefix range max. |
|
Ep carrier endpoint prefix range min. |
|
Ep carrier endpoint prefix string. |
|
Ep carrier endpoint source. Choices:
|
|
Ep ip header. |
|
Ep ip header suppress. Choices:
|
|
Ep missing header fallback. Choices:
|
|
Ep profile query type. Choices:
|
|
Group override attr type. Choices:
|
|
H3c compatibility. Choices:
|
|
Interface. |
|
Interface select method. Choices:
|
|
MAC authentication case Choices:
|
|
MAC authentication password delimiter Choices:
|
|
MAC authentication username delimiter Choices:
|
|
Custom NAS identifier. |
|
NAS identifier type configuration Choices:
|
|
Nas ip. |
|
Password encoding. Choices:
|
|
Password renewal. Choices:
|
|
Radius coa. Choices:
|
|
Radius port. |
|
Rsso. Choices:
|
|
Rsso context timeout. |
|
Rsso endpoint attribute. Choices:
|
|
Rsso endpoint block attribute. Choices:
|
|
Rsso ep one ip only. Choices:
|
|
Rsso flush ip session. Choices:
|
|
Rsso log flags. Choices:
|
|
Rsso log period. |
|
Rsso radius response. Choices:
|
|
Rsso radius server port. |
|
(list) Rsso secret. |
|
Rsso validate request secret. Choices:
|
|
(list) Secondary secret. |
|
Secondary server. |
|
(list) Secret. |
|
Server. |
|
Enable/disable RADIUS server identity check Choices:
|
|
Source ip. |
|
(list) Source interface for communication with the RADIUS server. |
|
Sso attribute. Choices:
|
|
Sso attribute key. |
|
Sso attribute value override. Choices:
|
|
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. |
|
Enable/Disable switch-controller nas-ip dynamic to dynamically set nas-ip. Choices:
|
|
Switch controller service type. Choices:
|
|
(list) Tertiary secret. |
|
Tertiary server. |
|
Timeout. |
|
Minimum supported protocol version for TLS connections Choices:
|
|
Transport protocol to be used Choices:
|
|
Use group for profile. Choices:
|
|
Use management vdom. Choices:
|
|
Username case sensitive. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |