fmgr_user_fsso_dynamicmapping – Configure Fortinet Single Sign On (FSSO) agents.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
6.2.1 |
6.2.3 |
6.2.5 |
6.4.0 |
6.4.2 |
6.4.5 |
7.0.0 |
7.2.0 |
|
| user_fsso_dynamicmapping | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- enable_log - Enable/Disable logging for task type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- adom - The parameter in requested url type: str required: true
- fsso - The parameter in requested url type: str required: true
- user_fsso_dynamicmapping - no description type: dict
- _gui_meta - _Gui_Meta. type: str more...
- _scope - No description for the parameter type: array more...
- ldap-server - LDAP server to get group information. type: str more...
- password - No description for the parameter type: str more...
- password2 - No description for the parameter type: str more...
- password3 - No description for the parameter type: str more...
- password4 - No description for the parameter type: str more...
- password5 - No description for the parameter type: str more...
- port - Port of the first FSSO collector agent. type: int more...
- port2 - Port of the second FSSO collector agent. type: int more...
- port3 - Port of the third FSSO collector agent. type: int more...
- port4 - Port of the fourth FSSO collector agent. type: int more...
- port5 - Port of the fifth FSSO collector agent. type: int more...
- server - Domain name or IP address of the first FSSO collector agent. type: str more...
- server2 - Domain name or IP address of the second FSSO collector agent. type: str more...
- server3 - Domain name or IP address of the third FSSO collector agent. type: str more...
- server4 - Domain name or IP address of the fourth FSSO collector agent. type: str more...
- server5 - Domain name or IP address of the fifth FSSO collector agent. type: str more...
- source-ip - Source IP for communications to FSSO agent. type: str more...
- source-ip6 - IPv6 source for communications to FSSO agent. type: str more...
- ssl - Enable/disable use of SSL. type: str choices: [disable, enable] more...
- ssl-trusted-cert - Trusted server certificate or CA certificate. type: str more...
- type - Server type. type: str choices: [default, fortiems, fortinac, fortiems-cloud] more...
- user-info-server - LDAP server to get user information. type: str more...
- ldap-poll - Enable/disable automatic fetching of groups from LDAP server. type: str choices: [disable, enable] more...
- ldap-poll-filter - Filter used to fetch groups. type: str more...
- ldap-poll-interval - Interval in minutes within to fetch groups from LDAP server. type: int more...
- group-poll-interval - Interval in minutes within to fetch groups from FSSO server, or unset to disable. type: int more...
- interface - Specify outgoing interface to reach server. type: str more...
- interface-select-method - Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
- logon-timeout - Interval in minutes to keep logons after FSSO server down. type: int more...
- sni - Server Name Indication. type: str more...
- ssl-server-host-ip-check - Enable/disable server host/IP verification. type: str choices: [disable, enable] more...
Notes¶
Note
- 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: 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 Fortinet Single Sign On (FSSO) agent
fmgr_fact:
facts:
selector: 'user_fsso_dynamicmapping'
params:
adom: 'ansible'
fsso: 'ansible-test-fsso' # name
dynamic_mapping: 'your_value'
- 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 Fortinet Single Sign On (FSSO) agent
fmgr_user_fsso_dynamicmapping:
bypass_validation: False
adom: ansible
fsso: ansible-test-fsso # name
state: present
user_fsso_dynamicmapping:
_scope:
-
name: FGT_AWS # need a valid device name
vdom: root # need a valid vdom name under the device
password: fortinet
port: 9000
server: ansible
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict