fortios_system_npu – Configure NPU attributes in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
Synopsis¶
- 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¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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 default: root
- system_npu - Configure NPU attributes. type: dict
- fp_anomaly - NP6Lite anomaly protection (packet drop or send trap to host). type: dict
- esp_minlen_err - Invalid IPv4 ESP short packet anomalies. type: str choices: drop, trap-to-host
- icmp_csum_err - Invalid IPv4 ICMP packet checksum anomalies. type: str choices: drop, trap-to-host
- icmp_minlen_err - Invalid IPv4 ICMP short packet anomalies. type: str choices: drop, trap-to-host
- ipv4_csum_err - Invalid IPv4 packet checksum anomalies. type: str choices: drop, trap-to-host
- ipv4_ihl_err - Invalid IPv4 header length anomalies. type: str choices: drop, trap-to-host
- ipv4_len_err - Invalid IPv4 packet length anomalies. type: str choices: drop, trap-to-host
- ipv4_opt_err - Invalid IPv4 option parsing anomalies. type: str choices: drop, trap-to-host
- ipv4_ttlzero_err - Invalid IPv4 TTL field zero anomalies. type: str choices: drop, trap-to-host
- ipv4_ver_err - Invalid IPv4 header version anomalies. type: str choices: drop, trap-to-host
- ipv6_exthdr_len_err - Invalid IPv6 packet chain extension header total length anomalies. type: str choices: drop, trap-to-host
- ipv6_exthdr_order_err - Invalid IPv6 packet extension header ordering anomalies. type: str choices: drop, trap-to-host
- ipv6_ihl_err - Invalid IPv6 packet length anomalies. type: str choices: drop, trap-to-host
- ipv6_plen_zero - Invalid IPv6 packet payload length zero anomalies. type: str choices: drop, trap-to-host
- ipv6_ver_err - Invalid IPv6 packet version anomalies. type: str choices: drop, trap-to-host
- tcp_csum_err - Invalid IPv4 TCP packet checksum anomalies. type: str choices: drop, trap-to-host
- tcp_hlen_err - Invalid IPv4 TCP header length anomalies. type: str choices: drop, trap-to-host
- tcp_plen_err - Invalid IPv4 TCP packet length anomalies. type: str choices: drop, trap-to-host
- udp_csum_err - Invalid IPv4 UDP packet checksum anomalies. type: str choices: drop, trap-to-host
- udp_hlen_err - Invalid IPv4 UDP packet header length anomalies. type: str choices: drop, trap-to-host
- udp_len_err - Invalid IPv4 UDP packet length anomalies. type: str choices: drop, trap-to-host
- udp_plen_err - Invalid IPv4 UDP packet minimum length anomalies. type: str choices: drop, trap-to-host
- udplite_cover_err - Invalid IPv4 UDP-Lite packet coverage anomalies. type: str choices: drop, trap-to-host
- udplite_csum_err - Invalid IPv4 UDP-Lite packet checksum anomalies. type: str choices: drop, trap-to-host
- unknproto_minlen_err - Invalid IPv4 L4 unknown protocol short packet anomalies. type: str choices: drop, trap-to-host
- iph_rsvd_re_cksum - Enable/disable IP checksum re-calculation for packets with iph.reserved bit set. type: str choices: enable, disable
- per_session_accounting - Enable/disable per-session accounting. type: str choices: disable, traffic-log-only, enable
Examples¶
- 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"
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 fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate 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
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3