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