fmgd_system_np6xlite – Configure NP6XLITE attributes.

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
  • 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_np6xlite - Configure NP6XLITE attributes. type: dict
    • congestion_handling_mode (Alias name: congestion-handling-mode) Configure marvell switch packet congestion handling. type: str choices: [flow-control, head-of-line] more...
    • fastpath Enable/disable np6xlite offloading (also called fast path). type: str choices: [disable, enable] more...
    • fp_anomaly (Alias name: fp-anomaly) Fp anomaly. type: dict more...
      • 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...
    • garbage_session_collector (Alias name: garbage-session-collector) Enable/disable garbage session collector. type: str choices: [disable, enable] more...
    • hpe Hpe. type: dict more...
      • arp_max (Alias name: arp-max) Maximum arp packet rate (1k - 1g pps, default = 200k pps). type: int more...
      • enable_shaper (Alias name: enable-shaper) Enable/disable npu host protection engine (hpe) shaper. type: str choices: [disable, enable] more...
      • esp_max (Alias name: esp-max) Maximum esp packet rate (1k - 1g pps, default = 200k pps). type: int more...
      • icmp_max (Alias name: icmp-max) Maximum icmp packet rate (1k - 1g pps, default = 200k pps). type: int more...
      • ip_frag_max (Alias name: ip-frag-max) Maximum fragmented ip packet rate (1k - 1g pps, default = 200k pps). type: int more...
      • 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...
      • 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...
      • pri_type_max (Alias name: pri-type-max) Maximum overflow rate of priority type traffic (1k - 1g pps, default = 200k pps). type: int more...
      • sctp_max (Alias name: sctp-max) Maximum sctp packet rate (1k - 1g pps, default = 200k pps). type: int more...
      • tcp_max (Alias name: tcp-max) Maximum tcp packet rate (10k - 4g pps, default = 5m pps). type: int more...
      • tcp_others_max (Alias name: tcp-others-max) Maximum tcp packet rate for tcp packets that match none of the 3 types above (1k - 1g pps, default = 600k pps). type: int more...
      • tcpfin_rst_max (Alias name: tcpfin-rst-max) Maximum tcp carries fin or rst flags packet rate (1k - 1g pps, default = 600k pps). type: int more...
      • 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...
      • tcpsyn_max (Alias name: tcpsyn-max) Maximum tcp syn only packet rate (1k - 1g pps, default = 600k pps). type: int more...
      • udp_max (Alias name: udp-max) Maximum udp packet rate (1k - 1g pps, default = 600k pps). type: int more...
    • ipsec_inner_fragment (Alias name: ipsec-inner-fragment) Enable/disable np6xlite ipsec fragmentation type: inner. type: str choices: [disable, enable] more...
    • ipsec_sts_timeout (Alias name: ipsec-sts-timeout) Set np6xlite ipsec sts message timeout. type: str choices: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10] more...
    • ipsec_throughput_msg_frequency (Alias name: ipsec-throughput-msg-frequency) Set np6xlite ipsec throughput message frequency (0 = disable). type: str choices: [disable, 32KB, 32kb, 64KB, 64kb, 128KB, 128kb, 256KB, 256kb, 512KB, 512kb, 1MB, 1mb, 2MB, 2mb, 4MB, 4mb, 8MB, 8mb, 16MB, 16mb, 32MB, 32mb, 64MB, 64mb, 128MB, 128mb, 256MB, 256mb, 512MB, 512mb, 1GB, 1gb] more...
    • name Device name. type: str more...
    • per_session_accounting (Alias name: per-session-accounting) Enable/disable per-session accounting. type: str choices: [enable, disable, traffic-log-only] more...
    • session_collector_interval (Alias name: session-collector-interval) Set garbage session collection cleanup interval (1 - 100 sec, default 64). type: int more...
    • session_timeout_fixed (Alias name: session-timeout-fixed) Enable/disable fixed timeout interval mode. type: str choices: [disable, enable] more...
    • session_timeout_interval (Alias name: session-timeout-interval) Set session timeout interval (0 - 1000 sec, default 40 sec). type: int more...
    • session_timeout_random_range (Alias name: session-timeout-random-range) Set the randomization range (0 - 1000 sec, default 8 sec). type: int more...
    • asicdos Enable/disable np6xlite dos offloading. type: str choices: [disable, enable] 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: Configure NP6XLITE attributes.
      fortinet.fmgdevice.fmgd_system_np6xlite:
        # 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>
        state: present # <value in [present, absent]>
        system_np6xlite:
          name: "your value" # Required variable, string
          # congestion_handling_mode: <value in [flow-control, head-of-line]>
          # fastpath: <value in [disable, enable]>
          # fp_anomaly:
          #   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]>
          # garbage_session_collector: <value in [disable, enable]>
          # hpe:
          #   arp_max: <integer>
          #   enable_shaper: <value in [disable, enable]>
          #   esp_max: <integer>
          #   icmp_max: <integer>
          #   ip_frag_max: <integer>
          #   ip_others_max: <integer>
          #   l2_others_max: <integer>
          #   pri_type_max: <integer>
          #   sctp_max: <integer>
          #   tcp_max: <integer>
          #   tcp_others_max: <integer>
          #   tcpfin_rst_max: <integer>
          #   tcpsyn_ack_max: <integer>
          #   tcpsyn_max: <integer>
          #   udp_max: <integer>
          # ipsec_inner_fragment: <value in [disable, enable]>
          # ipsec_sts_timeout: <value in [1, 2, 3, ...]>
          # ipsec_throughput_msg_frequency: <value in [disable, 32KB, 32kb, ...]>
          # per_session_accounting: <value in [enable, disable, traffic-log-only]>
          # session_collector_interval: <integer>
          # session_timeout_fixed: <value in [disable, enable]>
          # session_timeout_interval: <integer>
          # session_timeout_random_range: <integer>
          # asicdos: <value in [disable, enable]>

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.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)