fmgr_system_npu_fpanomaly – NP6Lite anomaly protection (packet drop or send trap to host).¶
New in version 2.1.6.
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.
- Tested with FortiManager v6.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
|||||||||||
| False | |||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
||
| False | False | False | False | False | False | False | False | False | False | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
| False | False | False | False | False | False | False | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
||||
| False | True | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
|||||||||
| True | True | True | |||||||||
7.4.0 |
|||||||||||
| True |
Parameters¶
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- system_npu_fpanomaly - NP6Lite anomaly protection 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...
- tcp-land - TCP land anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp-fin-noack - TCP SYN flood with FIN flag set without ACK setting anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp-syn-data - TCP SYN flood packets with data anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp-winnuke - TCP WinNuke anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4-optssrr - Strict source record route option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-proto-err - Layer 4 invalid protocol anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-land - Land anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp-no-flag - TCP SYN flood with no flag set anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4-land - Land anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4-optlsrr - Loose source record route option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- udp-land - UDP land anomalies. type: str choices: [allow, drop, trap-to-host] more...
- icmp-frag - Layer 3 fragmented packets that could be part of layer 4 ICMP anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-optendpid - End point identification anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4-opttimestamp - Timestamp option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4-optrr - Record route option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-unknopt - Unknown option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp-fin-only - TCP SYN flood with only FIN flag set anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp-syn-fin - TCP SYN flood SYN/FIN flag set anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-optinvld - Invalid option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-saddr-err - Source address as multicast anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4-proto-err - Invalid layer 4 protocol anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4-optstream - Stream option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-optnsap - Network service access point address option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- icmp-land - ICMP land anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-optjumbo - Jumbo options anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4-optsecurity - Security option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-optralert - Router alert option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-daddr-err - Destination address as unspecified or loopback address anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-opthomeaddr - Home address option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4-unknopt - Unknown option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6-opttunnel - Tunnel encapsulation limit option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- uesp-minlen-err - No description for the parameter type: str choices: [drop, trap-to-host] more...
- vxlan-minlen-err - No description for the parameter type: str choices: [drop, trap-to-host] more...
- sctp-crc-err - No description for the parameter type: str choices: [drop, trap-to-host] more...
- nvgre-minlen-err - No description for the parameter type: str choices: [drop, trap-to-host] more...
- sctp-l4len-err - No description for the parameter type: str choices: [drop, trap-to-host] more...
- sctp-clen-err - No description for the parameter type: str choices: [drop, trap-to-host] more...
- gtpu-plen-err - No description for the parameter type: str choices: [drop, trap-to-host] more...
- capwap-minlen-err - No description for the parameter type: str choices: [drop, trap-to-host] more...
- gre-csum-err - No description for the parameter type: str choices: [drop, trap-to-host] more...
- tcp-hlenvsl4len-err - No description for the parameter 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: NP6Lite anomaly protection
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-land: <value in [allow, drop, trap-to-host]>
tcp-fin-noack: <value in [allow, drop, trap-to-host]>
tcp-syn-data: <value in [allow, drop, trap-to-host]>
tcp-winnuke: <value in [allow, drop, trap-to-host]>
ipv4-optssrr: <value in [allow, drop, trap-to-host]>
ipv6-proto-err: <value in [allow, drop, trap-to-host]>
ipv6-land: <value in [allow, drop, trap-to-host]>
tcp-no-flag: <value in [allow, drop, trap-to-host]>
ipv4-land: <value in [allow, drop, trap-to-host]>
ipv4-optlsrr: <value in [allow, drop, trap-to-host]>
udp-land: <value in [allow, drop, trap-to-host]>
icmp-frag: <value in [allow, drop, trap-to-host]>
ipv6-optendpid: <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-unknopt: <value in [allow, drop, trap-to-host]>
tcp-fin-only: <value in [allow, drop, trap-to-host]>
tcp-syn-fin: <value in [allow, drop, trap-to-host]>
ipv6-optinvld: <value in [allow, drop, trap-to-host]>
ipv6-saddr-err: <value in [allow, drop, trap-to-host]>
ipv4-proto-err: <value in [allow, drop, trap-to-host]>
ipv4-optstream: <value in [allow, drop, trap-to-host]>
ipv6-optnsap: <value in [allow, drop, trap-to-host]>
icmp-land: <value in [allow, drop, trap-to-host]>
ipv6-optjumbo: <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]>
ipv6-daddr-err: <value in [allow, drop, trap-to-host]>
ipv6-opthomeaddr: <value in [allow, drop, trap-to-host]>
ipv4-unknopt: <value in [allow, drop, trap-to-host]>
ipv6-opttunnel: <value in [allow, drop, trap-to-host]>
uesp-minlen-err: <value in [drop, trap-to-host]>
vxlan-minlen-err: <value in [drop, trap-to-host]>
sctp-crc-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]>
sctp-clen-err: <value in [drop, trap-to-host]>
gtpu-plen-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]>
tcp-hlenvsl4len-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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0