fmgr_user_fsso – Configure Fortinet Single Sign On (FSSO) agents.¶

New in version 2.10.

Synopsis
Requirements
FortiManager Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

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	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
user_fsso - no description type: dict

_gui_meta - _Gui_Meta. type: str more...

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

_gui_meta True True True True True True True True True
dynamic_mapping - Dynamic_Mapping. type: array more...

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

dynamic_mapping True True True True True True True True True
- _gui_meta - _Gui_Meta. type: str more...
  
  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
  
  _gui_meta True True True True True True True True True
- _scope - _Scope. type: array more...
  
  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
  
  _scope True True True True True True True True True
  - name - Name. type: str more...
    
    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
    
    name True True True True True True True True True
  - vdom - Vdom. type: str more...
    
    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
    
    vdom True True True True True True True True True
- ldap-server - LDAP server to get group information. type: str more...
  
  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
  
  ldap-server True True True True True True True True True
- password - Password of the first FSSO collector agent. type: str more...
  
  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
  
  password True True True True True True True True True
- password2 - Password of the second FSSO collector agent. type: str more...
  
  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
  
  password2 True True True True True True True True True
- password3 - Password of the third FSSO collector agent. type: str more...
  
  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
  
  password3 True True True True True True True True True
- password4 - Password of the fourth FSSO collector agent. type: str more...
  
  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
  
  password4 True True True True True True True True True
- password5 - Password of the fifth FSSO collector agent. type: str more...
  
  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
  
  password5 True True True True True True True True True
- port - Port of the first FSSO collector agent. type: int more...
  
  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
  
  port True True True True True True True True True
- port2 - Port of the second FSSO collector agent. type: int more...
  
  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
  
  port2 True True True True True True True True True
- port3 - Port of the third FSSO collector agent. type: int more...
  
  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
  
  port3 True True True True True True True True True
- port4 - Port of the fourth FSSO collector agent. type: int more...
  
  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
  
  port4 True True True True True True True True True
- port5 - Port of the fifth FSSO collector agent. type: int more...
  
  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
  
  port5 True True True True True True True True True
- server - Domain name or IP address of the first FSSO collector agent. type: str more...
  
  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
  
  server True True True True True True True True True
- server2 - Domain name or IP address of the second FSSO collector agent. type: str more...
  
  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
  
  server2 True True True True True True True True True
- server3 - Domain name or IP address of the third FSSO collector agent. type: str more...
  
  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
  
  server3 True True True True True True True True True
- server4 - Domain name or IP address of the fourth FSSO collector agent. type: str more...
  
  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
  
  server4 True True True True True True True True True
- server5 - Domain name or IP address of the fifth FSSO collector agent. type: str more...
  
  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
  
  server5 True True True True True True True True True
- source-ip - Source IP for communications to FSSO agent. type: str more...
  
  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
  
  source-ip True True True True True True True True True
- source-ip6 - IPv6 source for communications to FSSO agent. type: str more...
  
  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
  
  source-ip6 True True True True True True True True True
- ssl - Enable/disable use of SSL. type: str choices: [disable, enable] more...
  
  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
  
  ssl True True True True True True True True True
- ssl-trusted-cert - Trusted server certificate or CA certificate. type: str more...
  
  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
  
  ssl-trusted-cert True True True True True True True True True
- type - Server type. type: str choices: [default, fortiems, fortinac, fortiems-cloud] more...
  
  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
  
  type True True True True True True True True True
- user-info-server - LDAP server to get user information. type: str more...
  
  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-info-server True True True True True True True True True
- ldap-poll - Enable/disable automatic fetching of groups from LDAP server. type: str choices: [disable, enable] more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  ldap-poll True True True True True True True True
- ldap-poll-filter - Filter used to fetch groups. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  ldap-poll-filter True True True True True True True True
- ldap-poll-interval - Interval in minutes within to fetch groups from LDAP server. type: int more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  ldap-poll-interval True True True True True True True True
- group-poll-interval - Interval in minutes within to fetch groups from FSSO server, or unset to disable. type: int more...
  
  6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  group-poll-interval True True True True True True True
- interface - Specify outgoing interface to reach server. type: str more...
  
  6.4.2 6.4.5 7.0.0 7.2.0
  
  interface True True True True
- interface-select-method - Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
  
  6.4.2 6.4.5 7.0.0 7.2.0
  
  interface-select-method True True True True
- logon-timeout - Interval in minutes to keep logons after FSSO server down. type: int more...
  
  7.2.0
  
  logon-timeout True
- sni - Server Name Indication. type: str more...
  
  7.2.0
  
  sni True
- ssl-server-host-ip-check - Enable/disable server host/IP verification. type: str choices: [disable, enable] more...
  
  7.2.0
  
  ssl-server-host-ip-check True
ldap-server - LDAP server to get group information. type: str more...

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

ldap-server True True True True True True True True True
name - Name. type: str more...

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

name True True True True True True True True True
password - Password of the first FSSO collector agent. type: str more...

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

password True True True True True True True True True
password2 - Password of the second FSSO collector agent. type: str more...

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

password2 True True True True True True True True True
password3 - Password of the third FSSO collector agent. type: str more...

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

password3 True True True True True True True True True
password4 - Password of the fourth FSSO collector agent. type: str more...

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

password4 True True True True True True True True True
password5 - Password of the fifth FSSO collector agent. type: str more...

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

password5 True True True True True True True True True
port - Port of the first FSSO collector agent. type: int more...

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

port True True True True True True True True True
port2 - Port of the second FSSO collector agent. type: int more...

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

port2 True True True True True True True True True
port3 - Port of the third FSSO collector agent. type: int more...

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

port3 True True True True True True True True True
port4 - Port of the fourth FSSO collector agent. type: int more...

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

port4 True True True True True True True True True
port5 - Port of the fifth FSSO collector agent. type: int more...

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

port5 True True True True True True True True True
server - Domain name or IP address of the first FSSO collector agent. type: str more...

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

server True True True True True True True True True
server2 - Domain name or IP address of the second FSSO collector agent. type: str more...

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

server2 True True True True True True True True True
server3 - Domain name or IP address of the third FSSO collector agent. type: str more...

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

server3 True True True True True True True True True
server4 - Domain name or IP address of the fourth FSSO collector agent. type: str more...

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

server4 True True True True True True True True True
server5 - Domain name or IP address of the fifth FSSO collector agent. type: str more...

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

server5 True True True True True True True True True
source-ip - Source IP for communications to FSSO agent. type: str more...

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

source-ip True True True True True True True True True
source-ip6 - IPv6 source for communications to FSSO agent. type: str more...

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

source-ip6 True True True True True True True True True
ldap-poll - Enable/disable automatic fetching of groups from LDAP server. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ldap-poll True True True True True True True True
ldap-poll-filter - Filter used to fetch groups. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ldap-poll-filter True True True True True True True True
ldap-poll-interval - Interval in minutes within to fetch groups from LDAP server. type: int more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ldap-poll-interval True True True True True True True True
ssl - Enable/disable use of SSL. type: str choices: [disable, enable] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ssl True True True True True True True True
ssl-trusted-cert - Trusted server certificate or CA certificate. type: str more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ssl-trusted-cert True True True True True True True True
type - Server type. type: str choices: [default, fortiems, fortinac, fortiems-cloud] more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

type True True True True True True True True
user-info-server - LDAP server to get user information. type: str more...

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-info-server True True True True True True True True
group-poll-interval - Interval in minutes within to fetch groups from FSSO server, or unset to disable. type: int more...

6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

group-poll-interval True True True True True True True
interface - Specify outgoing interface to reach server. type: str more...

6.4.2 6.4.5 7.0.0 7.2.0

interface True True True True
interface-select-method - Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...

6.4.2 6.4.5 7.0.0 7.2.0

interface-select-method True True True True
logon-timeout - Interval in minutes to keep logons after FSSO server down. type: int more...

7.2.0

logon-timeout True
sni - Server Name Indication. type: str more...

7.2.0

sni True
ssl-server-host-ip-check - Enable/disable server host/IP verification. type: str choices: [disable, enable] more...

7.2.0

ssl-server-host-ip-check True

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 Fortinet Single Sign On (FSSO) agents
     fmgr_fact:
       facts:
           selector: 'user_fsso'
           params:
               adom: 'ansible'
               fsso: '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 Fortinet Single Sign On (FSSO) agents.
     fmgr_user_fsso:
        bypass_validation: False
        adom: ansible
        state: present
        user_fsso:
           name: ansible-test-fsso
           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

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.