:source: fmgd_system_np6.py
:orphan:
.. _fmgd_system_np6:
fmgd_system_np6 -- Configure NP6 attributes.
++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
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
----------------------------------
.. raw:: html
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
----------
.. raw:: html
- 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
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- 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
- system_np6 - Configure NP6 attributes. type: dict
- fastpath Enable/disable np6 offloading (also called fast path). type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- fp_anomaly (Alias name: fp-anomaly) Fp anomaly. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- icmp_csum_err (Alias name: icmp-csum-err) Invalid ipv4 icmp checksum anomalies. type: str choices: [drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- icmp_land (Alias name: icmp-land) Icmp land anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv4_csum_err (Alias name: ipv4-csum-err) Invalid ipv4 ip checksum anomalies. type: str choices: [drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv4_land (Alias name: ipv4-land) Land anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv4_optlsrr (Alias name: ipv4-optlsrr) Loose source record route option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv4_optrr (Alias name: ipv4-optrr) Record route option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv4_optsecurity (Alias name: ipv4-optsecurity) Security option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv4_optssrr (Alias name: ipv4-optssrr) Strict source record route option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv4_optstream (Alias name: ipv4-optstream) Stream option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv4_opttimestamp (Alias name: ipv4-opttimestamp) Timestamp option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv4_proto_err (Alias name: ipv4-proto-err) Invalid layer 4 protocol anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv4_unknopt (Alias name: ipv4-unknopt) Unknown option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_land (Alias name: ipv6-land) Land anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_optendpid (Alias name: ipv6-optendpid) End point identification anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_opthomeaddr (Alias name: ipv6-opthomeaddr) Home address option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_optinvld (Alias name: ipv6-optinvld) Invalid option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_optjumbo (Alias name: ipv6-optjumbo) Jumbo options anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_optnsap (Alias name: ipv6-optnsap) Network service access point address option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_optralert (Alias name: ipv6-optralert) Router alert option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_opttunnel (Alias name: ipv6-opttunnel) Tunnel encapsulation limit option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_proto_err (Alias name: ipv6-proto-err) Layer 4 invalid protocol anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_saddr_err (Alias name: ipv6-saddr-err) Source address as multicast anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipv6_unknopt (Alias name: ipv6-unknopt) Unknown option anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tcp_csum_err (Alias name: tcp-csum-err) Invalid ipv4 tcp checksum anomalies. type: str choices: [drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tcp_land (Alias name: tcp-land) Tcp land anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tcp_syn_data (Alias name: tcp-syn-data) Tcp syn flood packets with data anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- 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...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tcp_winnuke (Alias name: tcp-winnuke) Tcp winnuke anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- udp_csum_err (Alias name: udp-csum-err) Invalid ipv4 udp checksum anomalies. type: str choices: [drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- udp_land (Alias name: udp-land) Udp land anomalies. type: str choices: [allow, drop, trap-to-host]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- garbage_session_collector (Alias name: garbage-session-collector) Enable/disable garbage session collector. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- hpe Hpe. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- arp_max (Alias name: arp-max) Maximum arp packet rate (1k - 1g pps, default = 200k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- enable_shaper (Alias name: enable-shaper) Enable/disable npu host protection engine(hpe) for packet type shaper. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- esp_max (Alias name: esp-max) Maximum esp packet rate (1k - 1g pps, default = 200k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- icmp_max (Alias name: icmp-max) Maximum icmp packet rate (1k - 1g pps, default = 200k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip_frag_max (Alias name: ip-frag-max) Maximum fragmented ip packet rate (1k - 1g pps, default = 200k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ip_others_max (Alias name: ip-others-max) Maximum ip packet rate for other packets (packet types that cannot be set with other options) (1k - 1g pps, default = 200k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- l2_others_max (Alias name: l2-others-max) Maximum l2 packet rate for l2 packets that are not arp packets (1k - 1g pps, default = 200k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- pri_type_max (Alias name: pri-type-max) Maximum overflow rate of priority type traffic (1k - 1g pps, default = 200k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sctp_max (Alias name: sctp-max) Maximum sctp packet rate (1k - 1g pps, default = 200k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tcp_max (Alias name: tcp-max) Maximum tcp packet rate (1k - 1g pps, default = 600k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tcpfin_rst_max (Alias name: tcpfin-rst-max) Maximum tcp carries fin or rst flags packet rate (1k - 1g pps, default = 60k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tcpsyn_ack_max (Alias name: tcpsyn-ack-max) Maximum tcp carries syn and ack flags packet rate (1k - 1g pps, default = 600k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- tcpsyn_max (Alias name: tcpsyn-max) Maximum tcp syn packet rate (1k - 1g pps, default = 600k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- udp_max (Alias name: udp-max) Maximum udp packet rate (1k - 1g pps, default = 600k pps). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipsec_ob_hash_function (Alias name: ipsec-ob-hash-function) Set hash function for ipsec outbound. type: str choices: [global-hash, round-robin-global, switch-group-hash, global-hash-weighted, round-robin-switch-group]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipsec_outbound_hash (Alias name: ipsec-outbound-hash) Enable/disable hash function for ipsec outbound traffic. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- low_latency_mode (Alias name: low-latency-mode) Enable/disable low latency mode. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- name Device name. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- per_session_accounting (Alias name: per-session-accounting) Enable/disable per-session accounting. type: str choices: [enable, disable, enable-by-log, all-enable, traffic-log-only]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- session_collector_interval (Alias name: session-collector-interval) Set garbage session collection cleanup interval (1 - 100 sec, default 64). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- session_timeout_fixed (Alias name: session-timeout-fixed) {disable | enable} toggle between using fixed or random timeouts for refreshing np6 sessions. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- session_timeout_interval (Alias name: session-timeout-interval) Set the fixed timeout for refreshing np6 sessions (0 - 1000 sec, default 40 sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- session_timeout_random_range (Alias name: session-timeout-random-range) Set the random timeout range for refreshing np6 sessions (0 - 1000 sec, default 8 sec). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
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
--------
.. code-block:: yaml+jinja
- 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: Configure NP6 attributes.
fortinet.fmgdevice.fmgd_system_np6:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
state: present #
system_np6:
name: "your value" # Required variable, string
# fastpath:
# fp_anomaly:
# icmp_csum_err:
# icmp_frag:
# icmp_land:
# ipv4_csum_err:
# ipv4_land:
# ipv4_optlsrr:
# ipv4_optrr:
# ipv4_optsecurity:
# ipv4_optssrr:
# ipv4_optstream:
# ipv4_opttimestamp:
# ipv4_proto_err:
# ipv4_unknopt:
# ipv6_daddr_err:
# ipv6_land:
# ipv6_optendpid:
# ipv6_opthomeaddr:
# ipv6_optinvld:
# ipv6_optjumbo:
# ipv6_optnsap:
# ipv6_optralert:
# ipv6_opttunnel:
# ipv6_proto_err:
# ipv6_saddr_err:
# ipv6_unknopt:
# tcp_csum_err:
# tcp_fin_noack:
# tcp_fin_only:
# tcp_land:
# tcp_no_flag:
# tcp_syn_data:
# tcp_syn_fin:
# tcp_winnuke:
# udp_csum_err:
# udp_land:
# garbage_session_collector:
# hpe:
# arp_max:
# enable_shaper:
# esp_max:
# icmp_max:
# ip_frag_max:
# ip_others_max:
# l2_others_max:
# pri_type_max:
# sctp_max:
# tcp_max:
# tcpfin_rst_max:
# tcpsyn_ack_max:
# tcpsyn_max:
# udp_max:
# ipsec_ob_hash_function:
# ipsec_outbound_hash:
# low_latency_mode:
# per_session_accounting:
# session_collector_interval:
# session_timeout_fixed:
# session_timeout_interval:
# session_timeout_random_range:
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:
.. raw:: html
- 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.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)