fortinet.fortimanager.fmgr_user_fsso module – Configure Fortinet Single Sign On
Note
This module is part of the fortinet.fortimanager collection (version 2.7.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_fsso
.
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 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. |
|
Gui meta. |
|
Dynamic mapping. |
|
Gui meta. |
|
Scope. |
|
Name. |
|
Vdom. |
|
Deprecated, please rename it to group_poll_interval. Group poll interval. |
|
Interface. |
|
Deprecated, please rename it to interface_select_method. Interface select method. Choices:
|
|
Deprecated, please rename it to ldap_poll. Ldap poll. Choices:
|
|
Deprecated, please rename it to ldap_poll_filter. Ldap poll filter. |
|
Deprecated, please rename it to ldap_poll_interval. Ldap poll interval. |
|
Deprecated, please rename it to ldap_server. Ldap server. |
|
Deprecated, please rename it to logon_timeout. Interval in minutes to keep logons after FSSO server down. |
|
(list) Password. |
|
(list) Password2. |
|
(list) Password3. |
|
(list) Password4. |
|
(list) Password5. |
|
Port. |
|
Port2. |
|
Port3. |
|
Port4. |
|
Port5. |
|
Server. |
|
Server2. |
|
Server3. |
|
Server4. |
|
Server5. |
|
Server Name Indication. |
|
Deprecated, please rename it to source_ip. Source ip. |
|
Deprecated, please rename it to source_ip6. Source ip6. |
|
Ssl. Choices:
|
|
Deprecated, please rename it to ssl_server_host_ip_check. Enable/disable server host/IP verification. Choices:
|
|
Deprecated, please rename it to ssl_trusted_cert. Ssl trusted cert. |
|
Type. Choices:
|
|
(list or str) Deprecated, please rename it to user_info_server. User info server. |
|
Deprecated, please rename it to group_poll_interval. Interval in minutes within to fetch groups from FSSO server, or unset… |
|
Specify outgoing interface to reach server. |
|
Deprecated, please rename it to interface_select_method. Specify how to select outgoing interface to reach server. Choices:
|
|
Deprecated, please rename it to ldap_poll. Enable/disable automatic fetching of groups from LDAP server. Choices:
|
|
Deprecated, please rename it to ldap_poll_filter. Filter used to fetch groups. |
|
Deprecated, please rename it to ldap_poll_interval. Interval in minutes within to fetch groups from LDAP server. |
|
Deprecated, please rename it to ldap_server. LDAP server to get group information. |
|
Deprecated, please rename it to logon_timeout. Interval in minutes to keep logons after FSSO server down. |
|
Name. |
|
(list) Password of the first FSSO collector agent. |
|
(list) Password of the second FSSO collector agent. |
|
(list) Password of the third FSSO collector agent. |
|
(list) Password of the fourth FSSO collector agent. |
|
(list) Password of the fifth FSSO collector agent. |
|
Port of the first FSSO collector agent. |
|
Port of the second FSSO collector agent. |
|
Port of the third FSSO collector agent. |
|
Port of the fourth FSSO collector agent. |
|
Port of the fifth FSSO collector agent. |
|
Domain name or IP address of the first FSSO collector agent. |
|
Domain name or IP address of the second FSSO collector agent. |
|
Domain name or IP address of the third FSSO collector agent. |
|
Domain name or IP address of the fourth FSSO collector agent. |
|
Domain name or IP address of the fifth FSSO collector agent. |
|
Server Name Indication. |
|
Deprecated, please rename it to source_ip. Source IP for communications to FSSO agent. |
|
Deprecated, please rename it to source_ip6. IPv6 source for communications to FSSO agent. |
|
Enable/disable use of SSL. Choices:
|
|
Deprecated, please rename it to ssl_server_host_ip_check. Enable/disable server host/IP verification. Choices:
|
|
Deprecated, please rename it to ssl_trusted_cert. Trusted server certificate or CA certificate. |
|
Server type. Choices:
|
|
Deprecated, please rename it to user_info_server. LDAP server to get user information. |
|
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 Fortinet Single Sign On (FSSO) agents.
fortinet.fortimanager.fmgr_user_fsso:
bypass_validation: false
adom: ansible
state: present
user_fsso:
name: ansible-test-fsso
password: fortinet
port: 9000
server: ansible
- 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 Fortinet Single Sign On (FSSO) agents
fortinet.fortimanager.fmgr_fact:
facts:
selector: "user_fsso"
params:
adom: "ansible"
fsso: "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 |