Skip to content

Latest commit

 

History

History
379 lines (335 loc) · 16.9 KB

fortios_firewall_pfcp.rst

File metadata and controls

379 lines (335 loc) · 16.9 KB
Raw
source:fortios_firewall_pfcp.py
orphan:

fortios_firewall_pfcp -- Configure PFCP 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 pfcp 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_pfcp v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4

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
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • firewall_pfcp - Configure PFCP. type: dict more...
    Supported Version Ranges
    firewall_pfcp v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
    • denied_log - Enable/disable logging denied PFCP packets. type: str choices: enable, disable more...
      Supported Version Ranges
      denied_log v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • forwarded_log - Enable/disable logging forwarded PFCP packets. type: str choices: enable, disable more...
      Supported Version Ranges
      forwarded_log v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • invalid_reserved_field - Allow or deny invalid reserved field in PFCP header packets. type: str choices: allow, deny more...
      Supported Version Ranges
      invalid_reserved_field v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • log_freq - Logging frequency of PFCP packets. type: int more...
      Supported Version Ranges
      log_freq v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
    • max_message_length - Maximum message length. type: int more...
      Supported Version Ranges
      max_message_length v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
    • message_filter - PFCP message filter. Source pfcp.message-filter.name. type: str more...
      Supported Version Ranges
      message_filter v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
    • min_message_length - Minimum message length. type: int more...
      Supported Version Ranges
      min_message_length v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
    • monitor_mode - PFCP monitor mode. type: str choices: enable, disable, vdom more...
      Supported Version Ranges
      monitor_mode v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [vdom] v6.0.0 -> latest
    • name - PFCP profile name. type: str required: true more...
      Supported Version Ranges
      name v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
    • pfcp_timeout - Set PFCP timeout (in seconds). type: int more...
      Supported Version Ranges
      pfcp_timeout v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
    • traffic_count_log - Enable/disable logging session traffic counter. type: str choices: enable, disable more...
      Supported Version Ranges
      traffic_count_log v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • unknown_version - Allow or deny unknown version packets. type: str choices: allow, deny more...
      Supported Version Ranges
      unknown_version v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest

Notes

Note

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

Examples

- name: Configure PFCP.
  fortinet.fortios.fortios_firewall_pfcp:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_pfcp:
          denied_log: "enable"
          forwarded_log: "enable"
          invalid_reserved_field: "allow"
          log_freq: "0"
          max_message_length: "1452"
          message_filter: "<your_own_value> (source pfcp.message-filter.name)"
          min_message_length: "0"
          monitor_mode: "enable"
          name: "default_name_11"
          pfcp_timeout: "86400"
          traffic_count_log: "enable"
          unknown_version: "allow"

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.