fortios_gtp_message_filter_v0v1 – Message filter for GTPv0/v1 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 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
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.2.0 |
v7.2.4 |
|
fortios_gtp_message_filter_v0v1 | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | 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
- gtp_message_filter_v0v1 - Message filter for GTPv0/v1 messages. type: dict more...
- create_mbms - GTPv1 create MBMS context (req 100, resp 101). type: str choices: allow, deny more...
- create_pdp - Create PDP context (req 16, resp 17). type: str choices: allow, deny more...
- data_record - Data record transfer (req 240, resp 241). type: str choices: allow, deny more...
- delete_aa_pdp - GTPv0 delete AA PDP context (req 24, resp 25). type: str choices: allow, deny more...
- delete_mbms - GTPv1 delete MBMS context (req 104, resp 105). type: str choices: allow, deny more...
- delete_pdp - Delete PDP context (req 20, resp 21). type: str choices: allow, deny more...
- echo - Echo (req 1, resp 2). type: str choices: allow, deny more...
- end_marker - GTPv1 End marker (254). type: str choices: allow, deny more...
- error_indication - Error indication (26). type: str choices: allow, deny more...
- failure_report - Failure report (req 34, resp 35). type: str choices: allow, deny more...
- fwd_relocation - GTPv1 forward relocation (req 53, resp 54, complete 55, complete ack 59). type: str choices: allow, deny more...
- fwd_srns_context - GTPv1 forward SRNS (context 58, context ack 60). type: str choices: allow, deny more...
- gtp_pdu - PDU (255). type: str choices: allow, deny more...
- identification - Identification (req 48, resp 49). type: str choices: allow, deny more...
- mbms_de_registration - GTPv1 MBMS de-registration (req 114, resp 115). type: str choices: allow, deny more...
- mbms_notification - GTPv1 MBMS notification (req 96, resp 97, reject req 98. reject resp 99). type: str choices: allow, deny more...
- mbms_registration - GTPv1 MBMS registration (req 112, resp 113). type: str choices: allow, deny more...
- mbms_session_start - GTPv1 MBMS session start (req 116, resp 117). type: str choices: allow, deny more...
- mbms_session_stop - GTPv1 MBMS session stop (req 118, resp 119). type: str choices: allow, deny more...
- mbms_session_update - GTPv1 MBMS session update (req 120, resp 121). type: str choices: allow, deny more...
- ms_info_change_notif - GTPv1 MS info change notification (req 128, resp 129). type: str choices: allow, deny more...
- name - Message filter name. type: str required: true more...
- node_alive - Node alive (req 4, resp 5). type: str choices: allow, deny more...
- note_ms_present - Note MS GPRS present (req 36, resp 37). type: str choices: allow, deny more...
- pdu_notification - PDU notification (req 27, resp 28, reject req 29, reject resp 30). type: str choices: allow, deny more...
- ran_info - GTPv1 RAN information relay (70). type: str choices: allow, deny more...
- redirection - Redirection (req 6, resp 7). type: str choices: allow, deny more...
- relocation_cancel - GTPv1 relocation cancel (req 56, resp 57). type: str choices: allow, deny more...
- send_route - Send routing information for GPRS (req 32, resp 33). type: str choices: allow, deny more...
- sgsn_context - SGSN context (req 50, resp 51, ack 52). type: str choices: allow, deny more...
- support_extension - GTPv1 supported extension headers notify (31). type: str choices: allow, deny more...
- ue_registration_query - UE Registration Query (req 61, resp ack 62). type: str choices: allow, deny more...
- unknown_message - Allow or Deny unknown messages. type: str choices: allow, deny more...
- unknown_message_white_list - White list (to allow) of unknown messages. type: list member_path: unknown_message_white_list:id more...
- id - Message IDs. type: int required: true more...
- update_mbms - GTPv1 update MBMS context (req 102, resp 103). type: str choices: allow, deny more...
- update_pdp - Update PDP context (req 18, resp 19). type: str choices: allow, deny more...
- v0_create_aa_pdp__v1_init_pdp_ctx - GTPv0 create AA PDP context (req 22, resp 23); Or GTPv1 initiate PDP context (req 22, resp 23). type: str choices: allow, deny more...
- version_not_support - Version not supported (3). 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 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"
ue_registration_query: "allow"
unknown_message: "allow"
unknown_message_white_list:
-
id: "37"
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: 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