fortinet.fortios.fortios_user_fsso (2.3.6) — module

Configure Fortinet Single Sign On (FSSO) agents in Fortinet's FortiOS and FortiGate.

| "added in version" 2.0.0 of fortinet.fortios"

Authors: Link Zheng (@chillancezen), Jie Xue (@JieX19), Hongbin Lu (@fgtdev-hblu), Frank Shen (@frankshen01), Miguel Angel Munoz (@mamunozgonzalez), Nicolas Thomas (@thomnico)

preview | supported by community

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6


Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify user feature and fsso category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure Fortinet Single Sign On (FSSO) agents.
  fortinet.fortios.fortios_user_fsso:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_fsso:
          group_poll_interval: "0"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "auto"
          ldap_poll: "enable"
          ldap_poll_filter: "<your_own_value>"
          ldap_poll_interval: "180"
          ldap_server: "<your_own_value> (source user.ldap.name)"
          logon_timeout: "5"
          name: "default_name_11"
          password: "<your_own_value>"
          password2: "<your_own_value>"
          password3: "<your_own_value>"
          password4: "<your_own_value>"
          password5: "<your_own_value>"
          port: "8000"
          port2: "8000"
          port3: "8000"
          port4: "8000"
          port5: "8000"
          server: "192.168.100.40"
          server2: "<your_own_value>"
          server3: "<your_own_value>"
          server4: "<your_own_value>"
          server5: "<your_own_value>"
          sni: "<your_own_value>"
          source_ip: "84.230.14.43"
          source_ip6: "<your_own_value>"
          ssl: "enable"
          ssl_server_host_ip_check: "enable"
          ssl_trusted_cert: "<your_own_value> (source vpn.certificate.remote.name vpn.certificate.ca.name)"
          type: "default"
          user_info_server: "<your_own_value> (source user.ldap.name)"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

user_fsso:
    default: null
    description:
    - Configure Fortinet Single Sign On (FSSO) agents.
    suboptions:
      group_poll_interval:
        description:
        - Interval in minutes within to fetch groups from FSSO server, or unset to disable.
        type: int
      interface:
        description:
        - Specify outgoing interface to reach server. Source system.interface.name.
        type: str
      interface_select_method:
        choices:
        - auto
        - sdwan
        - specify
        description:
        - Specify how to select outgoing interface to reach server.
        type: str
      ldap_poll:
        choices:
        - enable
        - disable
        description:
        - Enable/disable automatic fetching of groups from LDAP server.
        type: str
      ldap_poll_filter:
        description:
        - Filter used to fetch groups.
        type: str
      ldap_poll_interval:
        description:
        - Interval in minutes within to fetch groups from LDAP server.
        type: int
      ldap_server:
        description:
        - LDAP server to get group information. Source user.ldap.name.
        type: str
      logon_timeout:
        description:
        - Interval in minutes to keep logons after FSSO server down.
        type: int
      name:
        description:
        - Name.
        required: true
        type: str
      password:
        description:
        - Password of the first FSSO collector agent.
        type: str
      password2:
        description:
        - Password of the second FSSO collector agent.
        type: str
      password3:
        description:
        - Password of the third FSSO collector agent.
        type: str
      password4:
        description:
        - Password of the fourth FSSO collector agent.
        type: str
      password5:
        description:
        - Password of the fifth FSSO collector agent.
        type: str
      port:
        description:
        - Port of the first FSSO collector agent.
        type: int
      port2:
        description:
        - Port of the second FSSO collector agent.
        type: int
      port3:
        description:
        - Port of the third FSSO collector agent.
        type: int
      port4:
        description:
        - Port of the fourth FSSO collector agent.
        type: int
      port5:
        description:
        - Port of the fifth FSSO collector agent.
        type: int
      server:
        description:
        - Domain name or IP address of the first FSSO collector agent.
        type: str
      server2:
        description:
        - Domain name or IP address of the second FSSO collector agent.
        type: str
      server3:
        description:
        - Domain name or IP address of the third FSSO collector agent.
        type: str
      server4:
        description:
        - Domain name or IP address of the fourth FSSO collector agent.
        type: str
      server5:
        description:
        - Domain name or IP address of the fifth FSSO collector agent.
        type: str
      sni:
        description:
        - Server Name Indication.
        type: str
      source_ip:
        description:
        - Source IP for communications to FSSO agent.
        type: str
      source_ip6:
        description:
        - IPv6 source for communications to FSSO agent.
        type: str
      ssl:
        choices:
        - enable
        - disable
        description:
        - Enable/disable use of SSL.
        type: str
      ssl_server_host_ip_check:
        choices:
        - enable
        - disable
        description:
        - Enable/disable server host/IP verification.
        type: str
      ssl_trusted_cert:
        description:
        - Trusted server certificate or CA certificate. Source vpn.certificate.remote.name
          vpn.certificate.ca.name.
        type: str
      type:
        choices:
        - default
        - fortinac
        - fortiems
        - fortiems-cloud
        description:
        - Server type.
        type: str
      user_info_server:
        description:
        - LDAP server to get user information. Source user.ldap.name.
        type: str
    type: dict

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str