fmgr_pkg_firewall_dospolicy6 – Configure IPv6 DoS policies.

New in version 2.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 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
True
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 6.2.11
True True True True True True True True True True True
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 6.4.12
True True True True True True True True 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 7.0.8
True True True True True True True True True
7.2.0 7.2.1 7.2.2 7.2.3
True 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • pkg - The parameter in requested url type: str required: true
  • pkg_firewall_dospolicy6 - Configure IPv6 DoS policies. type: dict
    • anomaly - Anomaly. type: array more...
      • action - Action taken when the threshold is reached. type: str choices: [pass, block, proxy] more...
      • log - Enable/disable logging for this anomaly. type: str choices: [disable, enable] more...
      • name - Anomaly name. type: str more...
      • quarantine - Quarantine method. type: str choices: [none, attacker, both, interface] more...
      • quarantine-expiry - Duration of quarantine, from 1 minute to 364 days, 23 hours, and 59 minutes from now. type: str more...
      • quarantine-log - Enable/disable quarantine logging. type: str choices: [disable, enable] more...
      • status - Enable/disable the active status of this anomaly sensor. type: str choices: [disable, enable] more...
      • threshold - Number of detected instances per minute which triggers action (1 - 2147483647, default = 1000). type: int more...
      • threshold(default) - Threshold(Default). type: int more...
      • synproxy_tos - Determine TCP differentiated services code point value (type of service). type: str choices: [0, 10, 12, 14, 18, 20, 22, 26, 28, 30, 34, 36, 38, 40, 46, 255] more...
      • synproxy_ttl - Determine Time to live (TTL) value for packets replied by syn proxy module. type: str choices: [32, 64, 128, 255] more...
      • synproxy_tcp_sack - enable/disable TCP selective acknowledage (SACK) for packets replied by syn proxy module. type: str choices: [disable, enable] more...
      • synproxy_tcp_window - Determine TCP Window size for packets replied by syn proxy module. type: str choices: [4096, 8192, 16384, 32768] more...
      • synproxy_tcp_timestamp - enable/disable TCP timestamp option for packets replied by syn proxy module. type: str choices: [disable, enable] more...
      • synproxy_tcp_mss - Determine TCP maximum segment size (MSS) value for packets replied by syn proxy module. type: str choices: [0, 256, 512, 1024, 1300, 1360, 1460, 1500] more...
      • synproxy_tcp_windowscale - Determine TCP window scale option value for packets replied by syn proxy module. type: str choices: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14] more...
      • synproxy-tos - Determine TCP differentiated services code point value (type of service). type: str choices: [0, 10, 12, 14, 18, 20, 22, 26, 28, 30, 34, 36, 38, 40, 46, 255] more...
      • synproxy-tcp-window - Determine TCP Window size for packets replied by syn proxy module. type: str choices: [4096, 8192, 16384, 32768] more...
      • synproxy-tcp-windowscale - Determine TCP window scale option value for packets replied by syn proxy module. type: str choices: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14] more...
      • synproxy-tcp-timestamp - enable/disable TCP timestamp option for packets replied by syn proxy module. type: str choices: [disable, enable] more...
      • synproxy-ttl - Determine Time to live (TTL) value for packets replied by syn proxy module. type: str choices: [32, 64, 128, 255] more...
      • synproxy-tcp-mss - Determine TCP maximum segment size (MSS) value for packets replied by syn proxy module. type: str choices: [0, 256, 512, 1024, 1300, 1360, 1460, 1500] more...
      • synproxy-tcp-sack - enable/disable TCP selective acknowledage (SACK) for packets replied by syn proxy module. type: str choices: [disable, enable] more...
    • comments - Comment. type: str more...
    • dstaddr - Destination address name from available addresses. type: str more...
    • interface - Incoming interface name from available interfaces. type: str more...
    • policyid - Policy ID. type: int more...
    • service - Service object from available options. type: str more...
    • srcaddr - Source address name from available addresses. type: str more...
    • status - Enable/disable this policy. type: str choices: [disable, enable] more...
    • uuid - Universally Unique Identifier (UUID; automatically assigned but can be manually reset). type: str more...
    • name - Policy name. type: str 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: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure IPv6 DoS policies.
     fmgr_pkg_firewall_dospolicy6:
        bypass_validation: False
        adom: ansible
        pkg: ansible # package name
        state: present
        pkg_firewall_dospolicy6:
           comments: 'ansible-comment'
           interface: 'sslvpn_tun_intf'
           policyid: 1
           status: enable

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the IPv6 DoS policies
     fmgr_fact:
       facts:
           selector: 'pkg_firewall_dospolicy6'
           params:
               adom: 'ansible'
               pkg: 'ansible' # package name
               DoS-policy6: 'your_value'

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

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)

Hint

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