fortinet.fortios.fortios_gtp_message_filter_v0v1 – Message filter for GTPv0/v1 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_v0v1.

New in version 2.10: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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_v0v1 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			Choices: no ← yes	Enable/Disable logging for task.
gtp_message_filter_v0v1 dictionary				Message filter for GTPv0/v1 messages.
	create_mbms string		Choices: allow deny	GTPv1 create MBMS context (req 100, resp 101).
	create_pdp string		Choices: allow deny	Create PDP context (req 16, resp 17).
	data_record string		Choices: allow deny	Data record transfer (req 240, resp 241).
	delete_aa_pdp string		Choices: allow deny	GTPv0 delete AA PDP context (req 24, resp 25).
	delete_mbms string		Choices: allow deny	GTPv1 delete MBMS context (req 104, resp 105).
	delete_pdp string		Choices: allow deny	Delete PDP context (req 20, resp 21).
	echo string		Choices: allow deny	Echo (req 1, resp 2).
	end_marker string		Choices: allow deny	GTPv1 End marker (254).
	error_indication string		Choices: allow deny	Error indication (26).
	failure_report string		Choices: allow deny	Failure report (req 34, resp 35).
	fwd_relocation string		Choices: allow deny	GTPv1 forward relocation (req 53, resp 54, complete 55, complete ack 59).
	fwd_srns_context string		Choices: allow deny	GTPv1 forward SRNS (context 58, context ack 60).
	gtp_pdu string		Choices: allow deny	PDU (255).
	identification string		Choices: allow deny	Identification (req 48, resp 49).
	mbms_de_registration string		Choices: allow deny	GTPv1 MBMS de-registration (req 114, resp 115).
	mbms_notification string		Choices: allow deny	GTPv1 MBMS notification (req 96, resp 97, reject req 98. reject resp 99).
	mbms_registration string		Choices: allow deny	GTPv1 MBMS registration (req 112, resp 113).
	mbms_session_start string		Choices: allow deny	GTPv1 MBMS session start (req 116, resp 117).
	mbms_session_stop string		Choices: allow deny	GTPv1 MBMS session stop (req 118, resp 119).
	mbms_session_update string		Choices: allow deny	GTPv1 MBMS session update (req 120, resp 121).
	ms_info_change_notif string		Choices: allow deny	GTPv1 MS info change notification (req 128, resp 129).
	name string / required			Message filter name.
	node_alive string		Choices: allow deny	Node alive (req 4, resp 5).
	note_ms_present string		Choices: allow deny	Note MS GPRS present (req 36, resp 37).
	pdu_notification string		Choices: allow deny	PDU notification (req 27, resp 28, reject req 29, reject resp 30).
	ran_info string		Choices: allow deny	GTPv1 RAN information relay (70).
	redirection string		Choices: allow deny	Redirection (req 6, resp 7).
	relocation_cancel string		Choices: allow deny	GTPv1 relocation cancel (req 56, resp 57).
	send_route string		Choices: allow deny	Send routing information for GPRS (req 32, resp 33).
	sgsn_context string		Choices: allow deny	SGSN context (req 50, resp 51, ack 52).
	support_extension string		Choices: allow deny	GTPv1 supported extension headers notify (31).
	unknown_message string		Choices: allow deny	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_mbms string		Choices: allow deny	GTPv1 update MBMS context (req 102, resp 103).
	update_pdp string		Choices: allow deny	Update PDP context (req 18, resp 19).
	v0_create_aa_pdp__v1_init_pdp_ctx string		Choices: allow deny	GTPv0 create AA PDP context (req 22, resp 23); Or GTPv1 initiate PDP context (req 22, resp 23).
	version_not_support string		Choices: allow deny	Version not supported (3).
state string / required			Choices: present absent	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 GTPv0/v1 messages.
    fortios_gtp_message_filter_v0v1:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      gtp_message_filter_v0v1:
        create_mbms: "allow"
        create_pdp: "allow"
        data_record: "allow"
        delete_aa_pdp: "allow"
        delete_mbms: "allow"
        delete_pdp: "allow"
        echo: "allow"
        end_marker: "allow"
        error_indication: "allow"
        failure_report: "allow"
        fwd_relocation: "allow"
        fwd_srns_context: "allow"
        gtp_pdu: "allow"
        identification: "allow"
        mbms_de_registration: "allow"
        mbms_notification: "allow"
        mbms_registration: "allow"
        mbms_session_start: "allow"
        mbms_session_stop: "allow"
        mbms_session_update: "allow"
        ms_info_change_notif: "allow"
        name: "default_name_24"
        node_alive: "allow"
        note_ms_present: "allow"
        pdu_notification: "allow"
        ran_info: "allow"
        redirection: "allow"
        relocation_cancel: "allow"
        send_route: "allow"
        sgsn_context: "allow"
        support_extension: "allow"
        unknown_message: "allow"
        unknown_message_white_list:
         -
            id:  "36"
        update_mbms: "allow"
        update_pdp: "allow"
        v0_create_aa_pdp__v1_init_pdp_ctx: "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_v0v1_module.html