lix_fortinet.fortios.fortios_authentication_rule (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Requirements

• ansible>=2.9

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 Rules.
    fortios_authentication_rule:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      authentication_rule:
        active_auth_method: "<your_own_value> (source authentication.scheme.name)"
        comments: "<your_own_value>"
        dstaddr:
         -
            name: "default_name_6 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
              .external-resource.name)"
        dstaddr6:
         -
            name: "default_name_8 (source firewall.address6.name firewall.addrgrp6.name)"
        ip_based: "enable"
        name: "default_name_10"
        protocol: "http"
        srcaddr:
         -
            name: "default_name_13 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name system
              .external-resource.name)"
        srcaddr6:
         -
            name: "default_name_15 (source firewall.address6.name firewall.addrgrp6.name)"
        srcintf:
         -
            name: "default_name_17 (source system.interface.name system.zone.name)"
        sso_auth_method: "<your_own_value> (source authentication.scheme.name)"
        status: "enable"
        transaction_based: "enable"
        web_auth_cookie: "enable"
        web_portal: "enable"

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

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

authentication_rule:
    default: null
    description:
    - Configure Authentication Rules.
    suboptions:
      active_auth_method:
        description:
        - Select an active authentication method. Source authentication.scheme.name.
        type: str
      comments:
        description:
        - Comment.
        type: str
      dstaddr:
        description:
        - Select an IPv4 destination address from available options. Required for web
          proxy authentication.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name
              firewall.proxy-addrgrp.name system .external-resource.name.
            type: str
        type: list
      dstaddr6:
        description:
        - Select an IPv6 destination address from available options. Required for web
          proxy authentication.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address6.name firewall.addrgrp6.name.
            type: str
        type: list
      ip_based:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IP-based authentication. When enabled, previously authenticated
          users from the same IP address will be exempted.
        type: str
      name:
        description:
        - Authentication rule name.
        required: true
        type: str
      protocol:
        choices:
        - http
        - ftp
        - socks
        - ssh
        description:
        - Authentication is required for the selected protocol .
        type: str
      srcaddr:
        description:
        - Authentication is required for the selected IPv4 source address.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name
              firewall.proxy-addrgrp.name system .external-resource.name.
            type: str
        type: list
      srcaddr6:
        description:
        - Authentication is required for the selected IPv6 source address.
        elements: dict
        suboptions:
          name:
            description:
            - Address name. Source firewall.address6.name firewall.addrgrp6.name.
            type: str
        type: list
      srcintf:
        description:
        - Incoming (ingress) interface.
        elements: dict
        suboptions:
          name:
            description:
            - Interface name. Source system.interface.name system.zone.name.
            type: str
        type: list
      sso_auth_method:
        description:
        - Select a single-sign on (SSO) authentication method. Source authentication.scheme.name.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this authentication rule.
        type: str
      transaction_based:
        choices:
        - enable
        - disable
        description:
        - Enable/disable transaction based authentication .
        type: str
      web_auth_cookie:
        choices:
        - enable
        - disable
        description:
        - Enable/disable Web authentication cookies .
        type: str
      web_portal:
        choices:
        - enable
        - disable
        description:
        - Enable/disable web portal for proxy transparent policy .
        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