ansible.builtin.fortios_user_fsso (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

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

Requirements

• fortiosapi>=0.9.8

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure Fortinet Single Sign On (FSSO) agents.
    fortios_user_fsso:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      user_fsso:
        ldap_server: "<your_own_value> (source user.ldap.name)"
        name: "default_name_4"
        password: "<your_own_value>"
        password2: "<your_own_value>"
        password3: "<your_own_value>"
        password4: "<your_own_value>"
        password5: "<your_own_value>"
        port: "10"
        port2: "11"
        port3: "12"
        port4: "13"
        port5: "14"
        server: "192.168.100.40"
        server2: "<your_own_value>"
        server3: "<your_own_value>"
        server4: "<your_own_value>"
        server5: "<your_own_value>"
        source_ip: "84.230.14.43"
        source_ip6: "<your_own_value>"

Inputs

    
host:
    description:
    - FortiOS or FortiGate IP address.
    required: false
    type: str

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

https:
    default: true
    description:
    - Indicates if the requests towards FortiGate must use HTTPS protocol.
    type: bool

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

password:
    default: ''
    description:
    - FortiOS or FortiGate password.
    type: str

username:
    description:
    - FortiOS or FortiGate username.
    required: false
    type: str

user_fsso:
    default: null
    description:
    - Configure Fortinet Single Sign On (FSSO) agents.
    suboptions:
      ldap_server:
        description:
        - LDAP server to get group information. Source user.ldap.name.
        type: str
      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
      source_ip:
        description:
        - Source IP for communications to FSSO agent.
        type: str
      source_ip6:
        description:
        - IPv6 source for communications to FSSO agent.
        type: str
    type: dict

ssl_verify:
    default: true
    description:
    - Ensures FortiGate certificate must be verified by a proper CA.
    type: bool

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