Skip to content

Latest commit

 

History

History
268 lines (224 loc) · 12.2 KB

fortios_firewall_ipv6_eh_filter.rst

File metadata and controls

268 lines (224 loc) · 12.2 KB
Raw
source:fortios_firewall_ipv6_eh_filter.py
orphan:

fortios_firewall_ipv6_eh_filter -- Configure IPv6 extension header filter in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ipv6_eh_filter category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_firewall_ipv6_eh_filter v6.0.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • firewall_ipv6_eh_filter - Configure IPv6 extension header filter. type: dict more...
    Supported Version Ranges
    firewall_ipv6_eh_filter v6.0.0 -> latest
    • auth - Enable/disable blocking packets with the Authentication header . type: str choices: enable, disable more...
      Supported Version Ranges
      auth v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • dest_opt - Enable/disable blocking packets with Destination Options headers . type: str choices: enable, disable more...
      Supported Version Ranges
      dest_opt v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • fragment - Enable/disable blocking packets with the Fragment header . type: str choices: enable, disable more...
      Supported Version Ranges
      fragment v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • hdopt_type - Block specific Hop-by-Hop and/or Destination Option types (max. 7 types, each between 0 and 255). type: list
    • hop_opt - Enable/disable blocking packets with the Hop-by-Hop Options header . type: str choices: enable, disable more...
      Supported Version Ranges
      hop_opt v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • no_next - Enable/disable blocking packets with the No Next header . type: str choices: enable, disable more...
      Supported Version Ranges
      no_next v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • routing - Enable/disable blocking packets with Routing headers . type: str choices: enable, disable more...
      Supported Version Ranges
      routing v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • routing_type - Block specific Routing header types (max. 7 types, each between 0 and 255). type: list

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure IPv6 extension header filter.
  fortinet.fortios.fortios_firewall_ipv6_eh_filter:
      vdom: "{{ vdom }}"
      firewall_ipv6_eh_filter:
          auth: "enable"
          dest_opt: "enable"
          fragment: "enable"
          hdopt_type: "<your_own_value>"
          hop_opt: "enable"
          no_next: "enable"
          routing: "enable"
          routing_type: "<your_own_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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

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