fortinet.fortios.fortios_system_npu (1.1.7) — module

Configure NPU attributes in Fortinet's FortiOS and FortiGate.

| "added in version" 2.10 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:==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 system feature and npu category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.4.0


Requirements

Usage examples

  • 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 NPU attributes.
    fortios_system_npu:
      vdom:  "{{ vdom }}"
      system_npu:
        fp_anomaly:
            esp_minlen_err: "drop"
            icmp_csum_err: "drop"
            icmp_minlen_err: "drop"
            ipv4_csum_err: "drop"
            ipv4_ihl_err: "drop"
            ipv4_len_err: "drop"
            ipv4_opt_err: "drop"
            ipv4_ttlzero_err: "drop"
            ipv4_ver_err: "drop"
            ipv6_exthdr_len_err: "drop"
            ipv6_exthdr_order_err: "drop"
            ipv6_ihl_err: "drop"
            ipv6_plen_zero: "drop"
            ipv6_ver_err: "drop"
            tcp_csum_err: "drop"
            tcp_hlen_err: "drop"
            tcp_plen_err: "drop"
            udp_csum_err: "drop"
            udp_hlen_err: "drop"
            udp_len_err: "drop"
            udp_plen_err: "drop"
            udplite_cover_err: "drop"
            udplite_csum_err: "drop"
            unknproto_minlen_err: "drop"
        iph_rsvd_re_cksum: "enable"
        per_session_accounting: "disable"

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

system_npu:
    default: null
    description:
    - Configure NPU attributes.
    suboptions:
      fp_anomaly:
        description:
        - NP6Lite anomaly protection (packet drop or send trap to host).
        suboptions:
          esp_minlen_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 ESP short packet anomalies.
            type: str
          icmp_csum_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 ICMP packet checksum anomalies.
            type: str
          icmp_minlen_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 ICMP short packet anomalies.
            type: str
          ipv4_csum_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 packet checksum anomalies.
            type: str
          ipv4_ihl_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 header length anomalies.
            type: str
          ipv4_len_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 packet length anomalies.
            type: str
          ipv4_opt_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 option parsing anomalies.
            type: str
          ipv4_ttlzero_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 TTL field zero anomalies.
            type: str
          ipv4_ver_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 header version anomalies.
            type: str
          ipv6_exthdr_len_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv6 packet chain extension header total length anomalies.
            type: str
          ipv6_exthdr_order_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv6 packet extension header ordering anomalies.
            type: str
          ipv6_ihl_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv6 packet length anomalies.
            type: str
          ipv6_plen_zero:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv6 packet payload length zero anomalies.
            type: str
          ipv6_ver_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv6 packet version anomalies.
            type: str
          tcp_csum_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 TCP packet checksum anomalies.
            type: str
          tcp_hlen_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 TCP header length anomalies.
            type: str
          tcp_plen_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 TCP packet length anomalies.
            type: str
          udp_csum_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 UDP packet checksum anomalies.
            type: str
          udp_hlen_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 UDP packet header length anomalies.
            type: str
          udp_len_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 UDP packet length anomalies.
            type: str
          udp_plen_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 UDP packet minimum length anomalies.
            type: str
          udplite_cover_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 UDP-Lite packet coverage anomalies.
            type: str
          udplite_csum_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 UDP-Lite packet checksum anomalies.
            type: str
          unknproto_minlen_err:
            choices:
            - drop
            - trap-to-host
            description:
            - Invalid IPv4 L4 unknown protocol short packet anomalies.
            type: str
        type: dict
      iph_rsvd_re_cksum:
        choices:
        - enable
        - disable
        description:
        - Enable/disable IP checksum re-calculation for packets with iph.reserved bit
          set.
        type: str
      per_session_accounting:
        choices:
        - disable
        - traffic-log-only
        - enable
        description:
        - Enable/disable per-session accounting.
        type: str
    type: dict

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    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