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

New in version 2.0.0.

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.
  • Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0
True
6.2.0 6.2.1 6.2.2 6.2.3 6.2.5 6.2.6 6.2.7 6.2.8 6.2.9 6.2.10 6.2.11
True True True True True True True True True True True
6.4.0 6.4.1 6.4.2 6.4.3 6.4.4 6.4.5 6.4.6 6.4.7 6.4.8 6.4.9 6.4.10 6.4.11 6.4.12
True True True True True True True True True True True True True
7.0.0 7.0.1 7.0.2 7.0.3 7.0.4 7.0.5 7.0.6 7.0.7 7.0.8
True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3
True True True True
7.4.0
True

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • user_fsso - Configure Fortinet Single Sign On type: dict
    • _gui_meta - _Gui_Meta. type: str more...
    • dynamic_mapping - Dynamic_Mapping. type: array more...
      • _gui_meta - _Gui_Meta. type: str more...
      • _scope - _Scope. type: array more...
        • name - Name. type: str more...
        • vdom - Vdom. type: str more...
      • ldap-server - LDAP server to get group information. type: str more...
      • password - Password of the first FSSO collector agent. type: str more...
      • password2 - Password of the second FSSO collector agent. type: str more...
      • password3 - Password of the third FSSO collector agent. type: str more...
      • password4 - Password of the fourth FSSO collector agent. type: str more...
      • password5 - Password of the fifth FSSO collector agent. 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...
    • ldap-server - LDAP server to get group information. type: str more...
    • name - Name. type: str more...
    • password - Password of the first FSSO collector agent. type: str more...
    • password2 - Password of the second FSSO collector agent. type: str more...
    • password3 - Password of the third FSSO collector agent. type: str more...
    • password4 - Password of the fourth FSSO collector agent. type: str more...
    • password5 - Password of the fifth FSSO collector agent. 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...
    • 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...
    • 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...
    • 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 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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0

Status

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

Authors

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • 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.