fortios_pfcp_message_filter – Message filter for PFCP messages in Fortinet’s FortiOS and FortiGate.¶
New in version 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
FortiOS Version Compatibility¶
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.2.0 |
v7.2.4 |
|
fortios_pfcp_message_filter | yes | yes | yes | yes | yes | yes | yes |
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...
- association_release - Allow or deny PFCP association release request (9) and PFCP association release response (10). type: str choices: allow, deny more...
- association_setup - Allow or deny PFCP association setup request (5) and PFCP association setup response (6). type: str choices: allow, deny more...
- association_update - Allow or deny PFCP association update request (7) and PFCP association update response (8). type: str choices: allow, deny more...
- heartbeat - Allow or deny PFCP heartbeat request (1) and PFCP heartbeat response (2). type: str choices: allow, deny more...
- name - Message filter name. type: str required: true more...
- node_report - Allow or deny PFCP node report request (12) and PFCP node report response (13). type: str choices: allow, deny more...
- pfd_management - Allow or deny PFCP PFD management request (3) and PFCP PFD management response (4). type: str choices: allow, deny more...
- session_deletion - Allow or deny PFCP session deletion request (54) and PFCP session deletion response (55). type: str choices: allow, deny more...
- session_establish - Allow or deny PFCP session establishment request (50) and PFCP session establishment response (51). type: str choices: allow, deny more...
- session_modification - Allow or deny PFCP session modification request (52) and PFCP session modification response (53). type: str choices: allow, deny more...
- session_report - Allow or deny PFCP session report request (56) and PFCP session report response (57). type: str choices: allow, deny more...
- 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...
- unknown_message - Allow or deny unknown messages. type: str choices: allow, deny more...
- unknown_message_allow_list - Allow list of unknown messages. type: list member_path: unknown_message_allow_list:id more...
- id - Message IDs (range from 1 to 255). type: int required: true more...
- version_not_support - Allow or deny PFCP version not supported response (11). type: str choices: allow, deny more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Message filter for PFCP messages.
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