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

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

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: list more...
      • _gui_meta _gui_meta. type: str more...
      • _scope _scope. type: list more...
        • name Name. type: str more...
        • vdom Vdom. type: str more...
      • ldap_server (Alias name: ldap-server) Ldap server to get group information. type: str more...
      • password Password of the first fsso collector agent. type: list more...
      • password2 Password of the second fsso collector agent. type: list more...
      • password3 Password of the third fsso collector agent. type: list more...
      • password4 Password of the fourth fsso collector agent. type: list more...
      • password5 Password of the fifth fsso collector agent. type: list 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 (Alias name: source-ip) Source ip for communications to fsso agent. type: str more...
      • source_ip6 (Alias name: 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 (Alias name: 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 (Alias name: user-info-server) Ldap server to get user information. type: list or str more...
      • ldap_poll (Alias name: ldap-poll) Enable/disable automatic fetching of groups from ldap server. type: str choices: [disable, enable] more...
      • ldap_poll_filter (Alias name: ldap-poll-filter) Filter used to fetch groups. type: str more...
      • ldap_poll_interval (Alias name: ldap-poll-interval) Interval in minutes within to fetch groups from ldap server. type: int more...
      • group_poll_interval (Alias name: 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 (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
      • logon_timeout (Alias name: 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 (Alias name: ssl-server-host-ip-check) Enable/disable server host/ip verification. type: str choices: [disable, enable] more...
    • ldap_server (Alias name: 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: list more...
    • password2 Password of the second fsso collector agent. type: list more...
    • password3 Password of the third fsso collector agent. type: list more...
    • password4 Password of the fourth fsso collector agent. type: list more...
    • password5 Password of the fifth fsso collector agent. type: list 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 (Alias name: source-ip) Source ip for communications to fsso agent. type: str more...
    • source_ip6 (Alias name: source-ip6) Ipv6 source for communications to fsso agent. type: str more...
    • ldap_poll (Alias name: ldap-poll) Enable/disable automatic fetching of groups from ldap server. type: str choices: [disable, enable] more...
    • ldap_poll_filter (Alias name: ldap-poll-filter) Filter used to fetch groups. type: str more...
    • ldap_poll_interval (Alias name: 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 (Alias name: 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 (Alias name: user-info-server) Ldap server to get user information. type: str more...
    • group_poll_interval (Alias name: 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 (Alias name: interface-select-method) Specify how to select outgoing interface to reach server. type: str choices: [auto, sdwan, specify] more...
    • logon_timeout (Alias name: 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 (Alias name: 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: 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: 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 sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

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)