Steampunk Ansible Documentation - fortinet.fortios.fortios_pfcp_message_filter (2.3.6) - module - Message filter for PFCP messages in Fortinet's FortiOS and FortiGate.

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

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

ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

- 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"

Inputs

vdom:
default: root
description:
- 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

state:
choices:
- present
- absent
description:
- Indicates whether to create or remove the object.
required: true
type: str

enable_log:
default: false
description:
- Enable/Disable logging for task.
required: false
type: bool

member_path:
description:
- Member attribute path to operate on.
- Delimited by a slash character if there are more than one attribute.
- Parameter marked with member_path is legitimate for doing member operation.
type: str

access_token:
description:
- Token-based authentication. Generated from GUI of Fortigate.
required: false
type: str

member_state:
choices:
- present
- absent
description:
- Add or delete a member under specified attribute path.
- When member_state is specified, the state option is ignored.
type: str

pfcp_message_filter:
default: null
description:
- Message filter for PFCP messages.
suboptions:
association_release:
choices:
- allow
- deny
description:
- Allow or deny PFCP association release request (9) and PFCP association release
response (10).
type: str
association_setup:
choices:
- allow
- deny
description:
- Allow or deny PFCP association setup request (5) and PFCP association setup
response (6).
type: str
association_update:
choices:
- allow
- deny
description:
- Allow or deny PFCP association update request (7) and PFCP association update
response (8).
type: str
heartbeat:
choices:
- allow
- deny
description:
- Allow or deny PFCP heartbeat request (1) and PFCP heartbeat response (2).
type: str
name:
description:
- Message filter name.
required: true
type: str
node_report:
choices:
- allow
- deny
description:
- Allow or deny PFCP node report request (12) and PFCP node report response (13).
type: str
pfd_management:
choices:
- allow
- deny
description:
- Allow or deny PFCP PFD management request (3) and PFCP PFD management response
(4).
type: str
session_deletion:
choices:
- allow
- deny
description:
- Allow or deny PFCP session deletion request (54) and PFCP session deletion response
(55).
type: str
session_establish:
choices:
- allow
- deny
description:
- Allow or deny PFCP session establishment request (50) and PFCP session establishment
response (51).
type: str
session_modification:
choices:
- allow
- deny
description:
- Allow or deny PFCP session modification request (52) and PFCP session modification
response (53).
type: str
session_report:
choices:
- allow
- deny
description:
- Allow or deny PFCP session report request (56) and PFCP session report response
(57).
type: str
session_set_deletion:
choices:
- allow
- deny
description:
- Allow or deny PFCP session set deletion request (14) and PFCP session set deletion
response (15).
type: str
unknown_message:
choices:
- allow
- deny
description:
- Allow or deny unknown messages.
type: str
unknown_message_allow_list:
description:
- Allow list of unknown messages.
elements: dict
suboptions:
id:
description:
- Message IDs (range from 1 to 255). see <a href='#notes'>Notes</a>.
required: true
type: int
type: list
version_not_support:
choices:
- allow
- deny
description:
- Allow or deny PFCP version not supported response (11).
type: str
type: dict

Outputs

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