fortinet.fortios.fortios_gtp_message_filter_v2 module – Message filter for GTPv2 messages in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.2.2).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install fortinet.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_gtp_message_filter_v2
.
New in fortinet.fortios 2.0.0
Synopsis
This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify gtp feature and message_filter_v2 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.9
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Message filter for GTPv2 messages. |
|
Bearer resource (command 68, failure indication 69). Choices:
|
|
Change notification (req 38, resp 39). Choices:
|
|
Context request/response/acknowledge (req 130, resp 131, ack 132). Choices:
|
|
Create bearer (req 95, resp 96). Choices:
|
|
Create session (req 32, resp 33). Choices:
|
|
Delete bearer (command 66, failure indication 67). Choices:
|
|
Delete bearer (req 99, resp 100). Choices:
|
|
Delete PDN connection set (req 101, resp 102). Choices:
|
|
Delete session (req 36, resp 37). Choices:
|
|
Echo (req 1, resp 2). Choices:
|
|
Forward relocation complete notification/acknowledge (notif 135, ack 136). Choices:
|
|
Forward relocation request/response (req 133, resp 134). Choices:
|
|
Modify bearer (command 64 , failure indication 65). Choices:
|
|
Modify bearer (req 34, resp 35). Choices:
|
|
Message filter name. |
|
Resume (notify 164 , ack 165). Choices:
|
|
Suspend (notify 162, ack 163). Choices:
|
|
Trace session (activation 71, deactivation 72). Choices:
|
|
Allow or Deny unknown messages. Choices:
|
|
White list (to allow) of unknown messages. |
|
Message IDs. |
|
Update bearer (req 97, resp 98). Choices:
|
|
Update PDN connection set (req 200, resp 201). Choices:
|
|
Version not supported (3). Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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 GTPv2 messages.
fortios_gtp_message_filter_v2:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
gtp_message_filter_v2:
bearer_resource_cmd_fail: "allow"
change_notification: "allow"
context_req_res_ack: "allow"
create_bearer: "allow"
create_session: "allow"
delete_bearer_cmd_fail: "allow"
delete_bearer_req_resp: "allow"
delete_pdn_connection_set: "allow"
delete_session: "allow"
echo: "allow"
forward_relocation_cmp_notif_ack: "allow"
forward_relocation_req_res: "allow"
modify_bearer_cmd_fail: "allow"
modify_bearer_req_resp: "allow"
name: "default_name_17"
resume: "allow"
suspend: "allow"
trace_session: "allow"
unknown_message: "allow"
unknown_message_white_list:
-
id: "23"
update_bearer: "allow"
update_pdn_connection_set: "allow"
version_not_support: "allow"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |