Skip to content

Latest commit

 

History

History
475 lines (431 loc) · 22.3 KB

fortios_pfcp_message_filter.rst

File metadata and controls

475 lines (431 loc) · 22.3 KB
Raw
source:fortios_pfcp_message_filter.py
orphan:

fortios_pfcp_message_filter -- Message filter for PFCP messages 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 pfcp feature and message_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_pfcp_message_filter 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
  • pfcp_message_filter - Message filter for PFCP messages. type: dict more...
    Supported Version Ranges
    pfcp_message_filter v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
    • association_release - Allow or deny PFCP association release request (9) and PFCP association release response (10). type: str choices: allow, deny more...
      Supported Version Ranges
      association_release v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • association_setup - Allow or deny PFCP association setup request (5) and PFCP association setup response (6). type: str choices: allow, deny more...
      Supported Version Ranges
      association_setup v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • association_update - Allow or deny PFCP association update request (7) and PFCP association update response (8). type: str choices: allow, deny more...
      Supported Version Ranges
      association_update v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • heartbeat - Allow or deny PFCP heartbeat request (1) and PFCP heartbeat response (2). type: str choices: allow, deny more...
      Supported Version Ranges
      heartbeat v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • name - Message filter name. type: str required: true more...
      Supported Version Ranges
      name v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
    • node_report - Allow or deny PFCP node report request (12) and PFCP node report response (13). type: str choices: allow, deny more...
      Supported Version Ranges
      node_report v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • pfd_management - Allow or deny PFCP PFD management request (3) and PFCP PFD management response (4). type: str choices: allow, deny more...
      Supported Version Ranges
      pfd_management v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • session_deletion - Allow or deny PFCP session deletion request (54) and PFCP session deletion response (55). type: str choices: allow, deny more...
      Supported Version Ranges
      session_deletion v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • session_establish - Allow or deny PFCP session establishment request (50) and PFCP session establishment response (51). type: str choices: allow, deny more...
      Supported Version Ranges
      session_establish v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • session_modification - Allow or deny PFCP session modification request (52) and PFCP session modification response (53). type: str choices: allow, deny more...
      Supported Version Ranges
      session_modification v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • session_report - Allow or deny PFCP session report request (56) and PFCP session report response (57). type: str choices: allow, deny more...
      Supported Version Ranges
      session_report v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • session_set_deletion - Allow or deny PFCP session set deletion request (14) and PFCP session set deletion response (15). type: str choices: allow, deny more...
      Supported Version Ranges
      session_set_deletion v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • unknown_message - Allow or deny unknown messages. type: str choices: allow, deny more...
      Supported Version Ranges
      unknown_message v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      [allow] v6.0.0 -> latest
      [deny] v6.0.0 -> latest
    • unknown_message_allow_list - Allow list of unknown messages. type: list member_path: unknown_message_allow_list:id more...
      Supported Version Ranges
      unknown_message_allow_list v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
      • id - Message IDs (range from 1 to 255). see Notes. type: int required: true more...
        Supported Version Ranges
        id v7.0.1 -> v7.0.8 v7.2.0 -> v7.2.4
    • version_not_support - Allow or deny PFCP version not supported response (11). type: str choices: allow, deny more...
      Supported Version Ranges
      version_not_support 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: Message filter for PFCP messages.
  fortinet.fortios.fortios_pfcp_message_filter:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      pfcp_message_filter:
          association_release: "allow"
          association_setup: "allow"
          association_update: "allow"
          heartbeat: "allow"
          name: "default_name_7"
          node_report: "allow"
          pfd_management: "allow"
          session_deletion: "allow"
          session_establish: "allow"
          session_modification: "allow"
          session_report: "allow"
          session_set_deletion: "allow"
          unknown_message: "allow"
          unknown_message_allow_list:
              -
                  id: "17"
          version_not_support: "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.