fortinet.fortios.fortios_gtp_message_filter_v2 – Message filter for GTPv2 messages in Fortinet’s FortiOS and FortiGate.
Note
This plugin is part of the fortinet.fortios collection (version 2.1.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.
To use it in a playbook, specify: fortinet.fortios.fortios_gtp_message_filter_v2.
New in version 2.10: of fortinet.fortios
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.0
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| access_token
string
|
Token-based authentication. Generated from GUI of Fortigate.
|
|||
| enable_log
boolean
|
|
Enable/Disable logging for task.
|
||
| gtp_message_filter_v2
dictionary
|
Message filter for GTPv2 messages.
|
|||
| bearer_resource_cmd_fail
string
|
|
Bearer resource (command 68, failure indication 69).
|
||
| change_notification
string
|
|
Change notification (req 38, resp 39).
|
||
| create_bearer
string
|
|
Create bearer (req 95, resp 96).
|
||
| create_session
string
|
|
Create session (req 32, resp 33).
|
||
| delete_bearer_cmd_fail
string
|
|
Delete bearer (command 66, failure indication 67).
|
||
| delete_bearer_req_resp
string
|
|
Delete bearer (req 99, resp 100).
|
||
| delete_pdn_connection_set
string
|
|
Delete PDN connection set (req 101, resp 102).
|
||
| delete_session
string
|
|
Delete session (req 36, resp 37).
|
||
| echo
string
|
|
Echo (req 1, resp 2).
|
||
| modify_bearer_cmd_fail
string
|
|
Modify bearer (command 64 , failure indication 65).
|
||
| modify_bearer_req_resp
string
|
|
Modify bearer (req 34, resp 35).
|
||
| name
string / required
|
Message filter name.
|
|||
| resume
string
|
|
Resume (notify 164 , ack 165).
|
||
| suspend
string
|
|
Suspend (notify 162, ack 163).
|
||
| trace_session
string
|
|
Trace session (activation 71, deactivation 72).
|
||
| unknown_message
string
|
|
Allow or Deny unknown messages.
|
||
| unknown_message_white_list
list / elements=string
|
White list (to allow) of unknown messages.
|
|||
| id
integer / required
|
Message IDs.
|
|||
| update_bearer
string
|
|
Update bearer (req 97, resp 98).
|
||
| update_pdn_connection_set
string
|
|
Update PDN connection set (req 200, resp 201).
|
||
| version_not_support
string
|
|
Version not supported (3).
|
||
| state
string / required
|
|
Indicates whether to create or remove the object.
|
||
| vdom
string
|
Default:
"root"
|
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.
|
||
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"
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"
modify_bearer_cmd_fail: "allow"
modify_bearer_req_resp: "allow"
name: "default_name_14"
resume: "allow"
suspend: "allow"
trace_session: "allow"
unknown_message: "allow"
unknown_message_white_list:
-
id: "20"
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 | Returned | Description |
|---|---|---|
| build
string
|
always |
Build number of the fortigate image
Sample:
1547
|
| http_method
string
|
always |
Last method used to provision the content into FortiGate
Sample:
PUT
|
| http_status
string
|
always |
Last result given by FortiGate on last operation applied
Sample:
200
|
| mkey
string
|
success |
Master key (id) used in the last call to FortiGate
Sample:
id
|
| name
string
|
always |
Name of the table used to fulfill the request
Sample:
urlfilter
|
| path
string
|
always |
Path of the table used to fulfill the request
Sample:
webfilter
|
| revision
string
|
always |
Internal revision number
Sample:
17.0.2.10658
|
| serial
string
|
always |
Serial number of the unit
Sample:
FGVMEVYYQT3AB5352
|
| status
string
|
always |
Indication of the operation's result
Sample:
success
|
| vdom
string
|
always |
Virtual domain used
Sample:
root
|
| version
string
|
always |
Version of the FortiGate
Sample:
v5.6.3
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_gtp_message_filter_v2_module.html