fortinet.fortios.fortios_authentication_setting (1.1.7) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 1.1.7

Description

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

Requirements

• ansible>=2.9.0

Usage examples

Scanned by Steampunk Spotter

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

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure authentication setting.
    fortios_authentication_setting:
      vdom:  "{{ vdom }}"
      authentication_setting:
        active_auth_scheme: "<your_own_value> (source authentication.scheme.name)"
        auth_https: "enable"
        captive_portal: "<your_own_value> (source firewall.address.name)"
        captive_portal_ip: "<your_own_value>"
        captive_portal_ip6: "<your_own_value>"
        captive_portal_port: "8"
        captive_portal_ssl_port: "9"
        captive_portal_type: "fqdn"
        captive_portal6: "<your_own_value> (source firewall.address6.name)"
        sso_auth_scheme: "<your_own_value> (source authentication.scheme.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

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

authentication_setting:
    default: null
    description:
    - Configure authentication setting.
    suboptions:
      active_auth_scheme:
        description:
        - Active authentication method (scheme name). Source authentication.scheme.name.
        type: str
      auth_https:
        choices:
        - enable
        - disable
        description:
        - Enable/disable redirecting HTTP user authentication to HTTPS.
        type: str
      captive_portal:
        description:
        - Captive portal host name. Source firewall.address.name.
        type: str
      captive_portal6:
        description:
        - IPv6 captive portal host name. Source firewall.address6.name.
        type: str
      captive_portal_ip:
        description:
        - Captive portal IP address.
        type: str
      captive_portal_ip6:
        description:
        - Captive portal IPv6 address.
        type: str
      captive_portal_port:
        description:
        - Captive portal port number (1 - 65535).
        type: int
      captive_portal_ssl_port:
        description:
        - Captive portal SSL port number (1 - 65535).
        type: int
      captive_portal_type:
        choices:
        - fqdn
        - ip
        description:
        - Captive portal type.
        type: str
      sso_auth_scheme:
        description:
        - Single-Sign-On authentication method (scheme name). Source authentication.scheme.name.
        type: str
    type: dict

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