fmgd_system_np6xlite_fpanomaly – NP6XLITE IPv4 anomaly protection.
Added in version 1.0.0.
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 v7.x.
Requirements
The below requirements are needed on the host that executes this module.
ansible-core>=2.16.0
FortiManager Version Compatibility
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
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
- device - The parameter in requested url type: str required: true
- np6xlite - The parameter in requested url type: str required: true
- system_np6xlite_fpanomaly - NP6XLITE IPv4 anomaly protection. type: dict
- icmp_csum_err (Alias name: icmp-csum-err) Invalid ipv4 icmp checksum anomalies. type: str choices: [drop, trap-to-host] more...
- icmp_frag (Alias name: icmp-frag) Layer 3 fragmented packets that could be part of layer 4 icmp anomalies. type: str choices: [allow, drop, trap-to-host] more...
- icmp_land (Alias name: icmp-land) Icmp land anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4_csum_err (Alias name: ipv4-csum-err) Invalid ipv4 ip checksum anomalies. type: str choices: [drop, trap-to-host] more...
- ipv4_land (Alias name: ipv4-land) Land anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4_optlsrr (Alias name: ipv4-optlsrr) Loose source record route option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4_optrr (Alias name: ipv4-optrr) Record route option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4_optsecurity (Alias name: ipv4-optsecurity) Security option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4_optssrr (Alias name: ipv4-optssrr) Strict source record route option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4_optstream (Alias name: ipv4-optstream) Stream option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4_opttimestamp (Alias name: ipv4-opttimestamp) Timestamp option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4_proto_err (Alias name: ipv4-proto-err) Invalid layer 4 protocol anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv4_unknopt (Alias name: ipv4-unknopt) Unknown option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_daddr_err (Alias name: ipv6-daddr-err) Destination address as unspecified or loopback address anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_land (Alias name: ipv6-land) Land anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_optendpid (Alias name: ipv6-optendpid) End point identification anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_opthomeaddr (Alias name: ipv6-opthomeaddr) Home address option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_optinvld (Alias name: ipv6-optinvld) Invalid option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_optjumbo (Alias name: ipv6-optjumbo) Jumbo options anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_optnsap (Alias name: ipv6-optnsap) Network service access point address option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_optralert (Alias name: ipv6-optralert) Router alert option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_opttunnel (Alias name: ipv6-opttunnel) Tunnel encapsulation limit option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_proto_err (Alias name: ipv6-proto-err) Layer 4 invalid protocol anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_saddr_err (Alias name: ipv6-saddr-err) Source address as multicast anomalies. type: str choices: [allow, drop, trap-to-host] more...
- ipv6_unknopt (Alias name: ipv6-unknopt) Unknown option anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp_csum_err (Alias name: tcp-csum-err) Invalid ipv4 tcp checksum anomalies. type: str choices: [drop, trap-to-host] more...
- tcp_fin_noack (Alias name: tcp-fin-noack) Tcp syn flood with fin flag set without ack setting anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp_fin_only (Alias name: tcp-fin-only) Tcp syn flood with only fin flag set anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp_land (Alias name: tcp-land) Tcp land anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp_no_flag (Alias name: tcp-no-flag) Tcp syn flood with no flag set anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp_syn_data (Alias name: tcp-syn-data) Tcp syn flood packets with data anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp_syn_fin (Alias name: tcp-syn-fin) Tcp syn flood syn/fin flag set anomalies. type: str choices: [allow, drop, trap-to-host] more...
- tcp_winnuke (Alias name: tcp-winnuke) Tcp winnuke anomalies. type: str choices: [allow, drop, trap-to-host] more...
- udp_csum_err (Alias name: udp-csum-err) Invalid ipv4 udp checksum anomalies. type: str choices: [drop, trap-to-host] more...
- udp_land (Alias name: udp-land) Udp land anomalies. type: str choices: [allow, 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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: NP6XLITE IPv4 anomaly protection.
fortinet.fmgdevice.fmgd_system_np6xlite_fpanomaly:
# bypass_validation: false
# workspace_locking_adom: <global or your adom name>
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device: <your own value>
np6xlite: <your own value>
system_np6xlite_fpanomaly:
# icmp_csum_err: <value in [drop, trap-to-host]>
# icmp_frag: <value in [allow, drop, trap-to-host]>
# icmp_land: <value in [allow, drop, trap-to-host]>
# ipv4_csum_err: <value in [drop, trap-to-host]>
# ipv4_land: <value in [allow, drop, trap-to-host]>
# ipv4_optlsrr: <value in [allow, drop, trap-to-host]>
# ipv4_optrr: <value in [allow, drop, trap-to-host]>
# ipv4_optsecurity: <value in [allow, drop, trap-to-host]>
# ipv4_optssrr: <value in [allow, drop, trap-to-host]>
# ipv4_optstream: <value in [allow, drop, trap-to-host]>
# ipv4_opttimestamp: <value in [allow, drop, trap-to-host]>
# ipv4_proto_err: <value in [allow, drop, trap-to-host]>
# ipv4_unknopt: <value in [allow, drop, trap-to-host]>
# ipv6_daddr_err: <value in [allow, drop, trap-to-host]>
# ipv6_land: <value in [allow, drop, trap-to-host]>
# ipv6_optendpid: <value in [allow, drop, trap-to-host]>
# ipv6_opthomeaddr: <value in [allow, drop, trap-to-host]>
# ipv6_optinvld: <value in [allow, drop, trap-to-host]>
# ipv6_optjumbo: <value in [allow, drop, trap-to-host]>
# ipv6_optnsap: <value in [allow, drop, trap-to-host]>
# ipv6_optralert: <value in [allow, drop, trap-to-host]>
# ipv6_opttunnel: <value in [allow, drop, trap-to-host]>
# ipv6_proto_err: <value in [allow, drop, trap-to-host]>
# ipv6_saddr_err: <value in [allow, drop, trap-to-host]>
# ipv6_unknopt: <value in [allow, drop, trap-to-host]>
# tcp_csum_err: <value in [drop, trap-to-host]>
# tcp_fin_noack: <value in [allow, drop, trap-to-host]>
# tcp_fin_only: <value in [allow, drop, trap-to-host]>
# tcp_land: <value in [allow, drop, trap-to-host]>
# tcp_no_flag: <value in [allow, drop, trap-to-host]>
# tcp_syn_data: <value in [allow, drop, trap-to-host]>
# tcp_syn_fin: <value in [allow, drop, trap-to-host]>
# tcp_winnuke: <value in [allow, drop, trap-to-host]>
# udp_csum_err: <value in [drop, trap-to-host]>
# udp_land: <value in [allow, 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 sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
This module is not guaranteed to have a backwards compatible interface.