fmgr_system_npu_fpanomaly – NP6Lite anomaly protection (packet drop or send trap to host).

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


7.2.0
system_npu_fpanomaly yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
  • adom - The parameter in requested url type: str required: true
  • system_npu_fpanomaly - no description type: dict
    • esp-minlen-err - Invalid IPv4 ESP short packet anomalies. type: str choices: [drop, trap-to-host] more...
    • icmp-csum-err - Invalid IPv4 ICMP packet checksum anomalies. type: str choices: [drop, trap-to-host] more...
    • icmp-minlen-err - Invalid IPv4 ICMP short packet anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv4-csum-err - Invalid IPv4 packet checksum anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv4-ihl-err - Invalid IPv4 header length anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv4-len-err - Invalid IPv4 packet length anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv4-opt-err - Invalid IPv4 option parsing anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv4-ttlzero-err - Invalid IPv4 TTL field zero anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv4-ver-err - Invalid IPv4 header version anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv6-exthdr-len-err - Invalid IPv6 packet chain extension header total length anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv6-exthdr-order-err - Invalid IPv6 packet extension header ordering anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv6-ihl-err - Invalid IPv6 packet length anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv6-plen-zero - Invalid IPv6 packet payload length zero anomalies. type: str choices: [drop, trap-to-host] more...
    • ipv6-ver-err - Invalid IPv6 packet version anomalies. type: str choices: [drop, trap-to-host] more...
    • tcp-csum-err - Invalid IPv4 TCP packet checksum anomalies. type: str choices: [drop, trap-to-host] more...
    • tcp-hlen-err - Invalid IPv4 TCP header length anomalies. type: str choices: [drop, trap-to-host] more...
    • tcp-plen-err - Invalid IPv4 TCP packet length anomalies. type: str choices: [drop, trap-to-host] more...
    • udp-csum-err - Invalid IPv4 UDP packet checksum anomalies. type: str choices: [drop, trap-to-host] more...
    • udp-hlen-err - Invalid IPv4 UDP packet header length anomalies. type: str choices: [drop, trap-to-host] more...
    • udp-len-err - Invalid IPv4 UDP packet length anomalies. type: str choices: [drop, trap-to-host] more...
    • udp-plen-err - Invalid IPv4 UDP packet minimum length anomalies. type: str choices: [drop, trap-to-host] more...
    • udplite-cover-err - Invalid IPv4 UDP-Lite packet coverage anomalies. type: str choices: [drop, trap-to-host] more...
    • udplite-csum-err - Invalid IPv4 UDP-Lite packet checksum anomalies. type: str choices: [drop, trap-to-host] more...
    • unknproto-minlen-err - Invalid IPv4 L4 unknown protocol short packet anomalies. type: str choices: [drop, trap-to-host] more...

Notes

Note

  • 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.
  • To create or update an object, use state: present directive.
  • To delete an object, use state: absent directive
  • 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

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     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]>

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:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.