fortiswitch_user_setting – User authentication setting in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify user feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

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

  • ansible>=2.11

FortiSW Version Compatibility


v7.0.0 v7.0.1 v7.0.2 v7.0.3
fortiswitch_user_setting yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • user_setting - User authentication setting. type: dict
    • auth_blackout_time - Authentication blackout time (0 - 3600 sec). type: int
    • auth_cert - HTTPS server cert for policy authentication. type: str
    • auth_http_basic - Enable/disable use of HTTP BASIC for HTTP authentication. type: str choices: enable, disable
    • auth_invalid_max - Maximum number of invalid authentication attempts allowed before blackout (1 - 100). type: int
    • auth_multi_group - Enable/disable retrival of all groups a user belongs to. type: str choices: enable, disable
    • auth_ports - Authentication port table. type: list member_path: auth_ports:id
      • id - ID. type: int required: true
      • port - Non-standard port for firewall user authentication (1 - 65535). type: int
      • type - Service type. type: str choices: http, https, ftp, telnet
    • auth_secure_http - Enable/disable use of HTTPS for HTTP authentication. type: str choices: enable, disable
    • auth_timeout - Firewall user authentication timeout (1 - 480). type: int
    • auth_timeout_type - Authenticated policy expiration behavior. type: str choices: idle-timeout, hard-timeout, new-session
    • auth_type - Allowed firewall policy authentication methods. type: str choices: http, https, ftp, telnet

Examples

- hosts: fortiswitch01
  collections:
    - fortinet.fortiswitch
  connection: httpapi
  vars:
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: User authentication setting.
    fortiswitch_user_setting:
      user_setting:
        auth_blackout_time: "3"
        auth_cert: "<your_own_value>"
        auth_http_basic: "enable"
        auth_invalid_max: "6"
        auth_multi_group: "enable"
        auth_ports:
         -
            id:  "9"
            port: "10"
            type: "http"
        auth_secure_http: "enable"
        auth_timeout: "13"
        auth_timeout_type: "idle-timeout"
        auth_type: "http"

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:

  • build - Build number of the fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

Status

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

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)

Hint

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