fortinet.fortimanager.fmgr_system_npu_fpanomaly module – NP6Lite anomaly protection

Note

This module is part of the fortinet.fortimanager collection (version 2.8.2).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_system_npu_fpanomaly.

New in fortinet.fortimanager 2.1.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

system_npu_fpanomaly

dictionary

The top level parameters set.

capwap_minlen_err

aliases: capwap-minlen-err

string

Capwap minlen err.

Choices:

  • "drop"

  • "trap-to-host"

esp_minlen_err

aliases: esp-minlen-err

string

Invalid IPv4 ESP short packet anomalies.

Choices:

  • "drop"

  • "trap-to-host"

gre_csum_err

aliases: gre-csum-err

string

Gre csum err.

Choices:

  • "drop"

  • "trap-to-host"

gtpu_plen_err

aliases: gtpu-plen-err

string

Gtpu plen err.

Choices:

  • "drop"

  • "trap-to-host"

icmp_csum_err

aliases: icmp-csum-err

string

Invalid IPv4 ICMP packet checksum anomalies.

Choices:

  • "drop"

  • "trap-to-host"

icmp_frag

aliases: icmp-frag

string

Layer 3 fragmented packets that could be part of layer 4 ICMP anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

icmp_land

aliases: icmp-land

string

ICMP land anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

icmp_minlen_err

aliases: icmp-minlen-err

string

Invalid IPv4 ICMP short packet anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv4_csum_err

aliases: ipv4-csum-err

string

Invalid IPv4 packet checksum anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv4_ihl_err

aliases: ipv4-ihl-err

string

Invalid IPv4 header length anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv4_land

aliases: ipv4-land

string

Land anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv4_len_err

aliases: ipv4-len-err

string

Invalid IPv4 packet length anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv4_opt_err

aliases: ipv4-opt-err

string

Invalid IPv4 option parsing anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv4_optlsrr

aliases: ipv4-optlsrr

string

Loose source record route option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv4_optrr

aliases: ipv4-optrr

string

Record route option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv4_optsecurity

aliases: ipv4-optsecurity

string

Security option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv4_optssrr

aliases: ipv4-optssrr

string

Strict source record route option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv4_optstream

aliases: ipv4-optstream

string

Stream option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv4_opttimestamp

aliases: ipv4-opttimestamp

string

Timestamp option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv4_proto_err

aliases: ipv4-proto-err

string

Invalid layer 4 protocol anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv4_ttlzero_err

aliases: ipv4-ttlzero-err

string

Invalid IPv4 TTL field zero anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv4_unknopt

aliases: ipv4-unknopt

string

Unknown option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv4_ver_err

aliases: ipv4-ver-err

string

Invalid IPv4 header version anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv6_daddr_err

aliases: ipv6-daddr-err

string

Destination address as unspecified or loopback address anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_exthdr_len_err

aliases: ipv6-exthdr-len-err

string

Invalid IPv6 packet chain extension header total length anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv6_exthdr_order_err

aliases: ipv6-exthdr-order-err

string

Invalid IPv6 packet extension header ordering anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv6_ihl_err

aliases: ipv6-ihl-err

string

Invalid IPv6 packet length anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv6_land

aliases: ipv6-land

string

Land anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_optendpid

aliases: ipv6-optendpid

string

End point identification anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_opthomeaddr

aliases: ipv6-opthomeaddr

string

Home address option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_optinvld

aliases: ipv6-optinvld

string

Invalid option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_optjumbo

aliases: ipv6-optjumbo

string

Jumbo options anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_optnsap

aliases: ipv6-optnsap

string

Network service access point address option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_optralert

aliases: ipv6-optralert

string

Router alert option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_opttunnel

aliases: ipv6-opttunnel

string

Tunnel encapsulation limit option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_plen_zero

aliases: ipv6-plen-zero

string

Invalid IPv6 packet payload length zero anomalies.

Choices:

  • "drop"

  • "trap-to-host"

ipv6_proto_err

aliases: ipv6-proto-err

string

Layer 4 invalid protocol anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_saddr_err

aliases: ipv6-saddr-err

string

Source address as multicast anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_unknopt

aliases: ipv6-unknopt

string

Unknown option anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

ipv6_ver_err

aliases: ipv6-ver-err

string

Invalid IPv6 packet version anomalies.

Choices:

  • "drop"

  • "trap-to-host"

nvgre_minlen_err

aliases: nvgre-minlen-err

string

Nvgre minlen err.

Choices:

  • "drop"

  • "trap-to-host"

sctp_clen_err

aliases: sctp-clen-err

string

Sctp clen err.

Choices:

  • "drop"

  • "trap-to-host"

sctp_crc_err

aliases: sctp-crc-err

string

Sctp crc err.

Choices:

  • "drop"

  • "trap-to-host"

sctp_csum_err

aliases: sctp-csum-err

string

Invalid IPv4 SCTP checksum anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

sctp_l4len_err

aliases: sctp-l4len-err

string

Sctp l4len err.

Choices:

  • "drop"

  • "trap-to-host"

tcp_csum_err

aliases: tcp-csum-err

string

Invalid IPv4 TCP packet checksum anomalies.

Choices:

  • "drop"

  • "trap-to-host"

tcp_fin_noack

aliases: tcp-fin-noack

string

TCP SYN flood with FIN flag set without ACK setting anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

tcp_fin_only

aliases: tcp-fin-only

string

TCP SYN flood with only FIN flag set anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

tcp_hlen_err

aliases: tcp-hlen-err

string

Invalid IPv4 TCP header length anomalies.

Choices:

  • "drop"

  • "trap-to-host"

tcp_hlenvsl4len_err

aliases: tcp-hlenvsl4len-err

string

Tcp hlenvsl4len err.

Choices:

  • "drop"

  • "trap-to-host"

tcp_land

aliases: tcp-land

string

TCP land anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

tcp_no_flag

aliases: tcp-no-flag

string

TCP SYN flood with no flag set anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

tcp_plen_err

aliases: tcp-plen-err

string

Invalid IPv4 TCP packet length anomalies.

Choices:

  • "drop"

  • "trap-to-host"

tcp_syn_data

aliases: tcp-syn-data

string

TCP SYN flood packets with data anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

tcp_syn_fin

aliases: tcp-syn-fin

string

TCP SYN flood SYN/FIN flag set anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

tcp_winnuke

aliases: tcp-winnuke

string

TCP WinNuke anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

udp_csum_err

aliases: udp-csum-err

string

Invalid IPv4 UDP packet checksum anomalies.

Choices:

  • "drop"

  • "trap-to-host"

udp_hlen_err

aliases: udp-hlen-err

string

Invalid IPv4 UDP packet header length anomalies.

Choices:

  • "drop"

  • "trap-to-host"

udp_land

aliases: udp-land

string

UDP land anomalies.

Choices:

  • "allow"

  • "drop"

  • "trap-to-host"

udp_len_err

aliases: udp-len-err

string

Invalid IPv4 UDP packet length anomalies.

Choices:

  • "drop"

  • "trap-to-host"

udp_plen_err

aliases: udp-plen-err

string

Invalid IPv4 UDP packet minimum length anomalies.

Choices:

  • "drop"

  • "trap-to-host"

udplite_cover_err

aliases: udplite-cover-err

string

Invalid IPv4 UDP-Lite packet coverage anomalies.

Choices:

  • "drop"

  • "trap-to-host"

udplite_csum_err

aliases: udplite-csum-err

string

Invalid IPv4 UDP-Lite packet checksum anomalies.

Choices:

  • "drop"

  • "trap-to-host"

uesp_minlen_err

aliases: uesp-minlen-err

string

Uesp minlen err.

Choices:

  • "drop"

  • "trap-to-host"

unknproto_minlen_err

aliases: unknproto-minlen-err

string

Invalid IPv4 L4 unknown protocol short packet anomalies.

Choices:

  • "drop"

  • "trap-to-host"

vxlan_minlen_err

aliases: vxlan-minlen-err

string

Vxlan minlen err.

Choices:

  • "drop"

  • "trap-to-host"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: NP6Lite anomaly protection
      fortinet.fortimanager.fmgr_system_npu_fpanomaly:
        # bypass_validation: false
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        adom: <your own value>
        system_npu_fpanomaly:
          esp_minlen_err: <value in [drop, trap-to-host]>
          icmp_csum_err: <value in [drop, trap-to-host]>
          icmp_minlen_err: <value in [drop, trap-to-host]>
          ipv4_csum_err: <value in [drop, trap-to-host]>
          ipv4_ihl_err: <value in [drop, trap-to-host]>
          ipv4_len_err: <value in [drop, trap-to-host]>
          ipv4_opt_err: <value in [drop, trap-to-host]>
          ipv4_ttlzero_err: <value in [drop, trap-to-host]>
          ipv4_ver_err: <value in [drop, trap-to-host]>
          ipv6_exthdr_len_err: <value in [drop, trap-to-host]>
          ipv6_exthdr_order_err: <value in [drop, trap-to-host]>
          ipv6_ihl_err: <value in [drop, trap-to-host]>
          ipv6_plen_zero: <value in [drop, trap-to-host]>
          ipv6_ver_err: <value in [drop, trap-to-host]>
          tcp_csum_err: <value in [drop, trap-to-host]>
          tcp_hlen_err: <value in [drop, trap-to-host]>
          tcp_plen_err: <value in [drop, trap-to-host]>
          udp_csum_err: <value in [drop, trap-to-host]>
          udp_hlen_err: <value in [drop, trap-to-host]>
          udp_len_err: <value in [drop, trap-to-host]>
          udp_plen_err: <value in [drop, trap-to-host]>
          udplite_cover_err: <value in [drop, trap-to-host]>
          udplite_csum_err: <value in [drop, trap-to-host]>
          unknproto_minlen_err: <value in [drop, trap-to-host]>
          tcp_fin_only: <value in [allow, drop, trap-to-host]>
          ipv4_optsecurity: <value in [allow, drop, trap-to-host]>
          ipv6_optralert: <value in [allow, drop, trap-to-host]>
          tcp_syn_fin: <value in [allow, drop, trap-to-host]>
          ipv4_proto_err: <value in [allow, drop, trap-to-host]>
          ipv6_saddr_err: <value in [allow, drop, trap-to-host]>
          icmp_frag: <value in [allow, drop, trap-to-host]>
          ipv4_optssrr: <value in [allow, drop, trap-to-host]>
          ipv6_opthomeaddr: <value in [allow, drop, trap-to-host]>
          udp_land: <value in [allow, drop, trap-to-host]>
          ipv6_optinvld: <value in [allow, drop, trap-to-host]>
          tcp_fin_noack: <value in [allow, drop, trap-to-host]>
          ipv6_proto_err: <value in [allow, drop, trap-to-host]>
          tcp_land: <value in [allow, drop, trap-to-host]>
          ipv4_unknopt: <value in [allow, drop, trap-to-host]>
          ipv4_optstream: <value in [allow, drop, trap-to-host]>
          ipv6_optjumbo: <value in [allow, drop, trap-to-host]>
          icmp_land: <value in [allow, drop, trap-to-host]>
          tcp_winnuke: <value in [allow, drop, trap-to-host]>
          ipv6_daddr_err: <value in [allow, drop, trap-to-host]>
          ipv4_land: <value in [allow, drop, trap-to-host]>
          ipv6_opttunnel: <value in [allow, drop, trap-to-host]>
          tcp_no_flag: <value in [allow, drop, trap-to-host]>
          ipv6_land: <value in [allow, drop, trap-to-host]>
          ipv4_optlsrr: <value in [allow, drop, trap-to-host]>
          ipv4_opttimestamp: <value in [allow, drop, trap-to-host]>
          ipv4_optrr: <value in [allow, drop, trap-to-host]>
          ipv6_optnsap: <value in [allow, drop, trap-to-host]>
          ipv6_unknopt: <value in [allow, drop, trap-to-host]>
          tcp_syn_data: <value in [allow, drop, trap-to-host]>
          ipv6_optendpid: <value in [allow, drop, trap-to-host]>
          gtpu_plen_err: <value in [drop, trap-to-host]>
          vxlan_minlen_err: <value in [drop, trap-to-host]>
          capwap_minlen_err: <value in [drop, trap-to-host]>
          gre_csum_err: <value in [drop, trap-to-host]>
          nvgre_minlen_err: <value in [drop, trap-to-host]>
          sctp_l4len_err: <value in [drop, trap-to-host]>
          tcp_hlenvsl4len_err: <value in [drop, trap-to-host]>
          sctp_crc_err: <value in [drop, trap-to-host]>
          sctp_clen_err: <value in [drop, trap-to-host]>
          uesp_minlen_err: <value in [drop, trap-to-host]>
          sctp_csum_err: <value in [allow, drop, trap-to-host]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)