fortios_gtp_message_filter_v2 – Message filter for GTPv2 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_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.15
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> v7.0.8 , v7.2.0 -> v7.2.4 , v7.4.3 -> 7.4.3
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_v2 - Message filter for GTPv2 messages. type: dict more...
- alert_mme_notif_ack - Alert MME notification/acknowledge (notif 153, ack 154). type: str choices: allow, deny more...
- bearer_resource_cmd_fail - Bearer resource (command 68, failure indication 69). type: str choices: allow, deny more...
- change_notification - Change notification (req 38, resp 39). type: str choices: allow, deny more...
- configuration_transfer_tunnel - Configuration transfer tunnel (141). type: str choices: allow, deny more...
- context_req_res_ack - Context request/response/acknowledge (req 130, resp 131, ack 132). type: str choices: allow, deny more...
- create_bearer - Create bearer (req 95, resp 96). type: str choices: allow, deny more...
- create_forwarding_tunnel_req_resp - Create forwarding tunnel request/response (req 160, resp 161). type: str choices: allow, deny more...
- create_indirect_forwarding_tunnel_req_resp - Create indirect data forwarding tunnel request/response (req 166, resp 167). type: str choices: allow, deny more...
- create_session - Create session (req 32, resp 33). type: str choices: allow, deny more...
- cs_paging - CS paging indication (151) type: str choices: allow, deny more...
- delete_bearer_cmd_fail - Delete bearer (command 66, failure indication 67). type: str choices: allow, deny more...
- delete_bearer_req_resp - Delete bearer (req 99, resp 100). type: str choices: allow, deny more...
- delete_indirect_forwarding_tunnel_req_resp - Delete indirect data forwarding tunnel request/response (req 168, resp 169). type: str choices: allow, deny more...
- delete_pdn_connection_set - Delete PDN connection set (req 101, resp 102). type: str choices: allow, deny more...
- delete_session - Delete session (req 36, resp 37). type: str choices: allow, deny more...
- detach_notif_ack - Detach notification/acknowledge (notif 149, ack 150). type: str choices: allow, deny more...
- dlink_data_notif_ack - Downlink data notification/acknowledge (notif 176, ack 177). type: str choices: allow, deny more...
- dlink_notif_failure - Downlink data notification failure indication (70). type: str choices: allow, deny more...
- echo - Echo (req 1, resp 2). type: str choices: allow, deny more...
- forward_access_notif_ack - Forward access context notification/acknowledge (notif 137, ack 138). type: str choices: allow, deny more...
- forward_relocation_cmp_notif_ack - Forward relocation complete notification/acknowledge (notif 135, ack 136). type: str choices: allow, deny more...
- forward_relocation_req_res - Forward relocation request/response (req 133, resp 134). type: str choices: allow, deny more...
- identification_req_resp - Identification request/response (req 128, resp 129). type: str choices: allow, deny more...
- isr_status - ISR status indication (157). type: str choices: allow, deny more...
- mbms_session_start_req_resp - MBMS session start request/response (req 231, resp 232). type: str choices: allow, deny more...
- mbms_session_stop_req_resp - MBMS session stop request/response (req 235, resp 236). type: str choices: allow, deny more...
- mbms_session_update_req_resp - MBMS session update request/response (req 233, resp 234). type: str choices: allow, deny more...
- modify_access_req_resp - Modify access bearers request/response (req 211, resp 212). type: str choices: allow, deny more...
- modify_bearer_cmd_fail - Modify bearer (command 64 , failure indication 65). type: str choices: allow, deny more...
- modify_bearer_req_resp - Modify bearer (req 34, resp 35). type: str choices: allow, deny more...
- name - Message filter name. type: str required: true more...
- pgw_dlink_notif_ack - PGW downlink triggering notification/acknowledge (notif 103, ack 104). type: str choices: allow, deny more...
- pgw_restart_notif_ack - PGW restart notification/acknowledge (notif 179, ack 180). type: str choices: allow, deny more...
- ran_info_relay - RAN information relay (152). type: str choices: allow, deny more...
- release_access_bearer_req_resp - Release access bearers request/response (req 170, resp 171). type: str choices: allow, deny more...
- relocation_cancel_req_resp - Relocation cancel request/response (req 139, resp 140). type: str choices: allow, deny more...
- remote_ue_report_notif_ack - Remote UE report notification/acknowledge (notif 40, ack 41). type: str choices: allow, deny more...
- reserved_for_earlier_version - Reserved for earlier version of the GTP specification (178). type: str choices: allow, deny more...
- resume - Resume (notify 164 , ack 165). type: str choices: allow, deny more...
- stop_paging_indication - Stop Paging Indication (73). type: str choices: allow, deny more...
- suspend - Suspend (notify 162, ack 163). type: str choices: allow, deny more...
- trace_session - Trace session (activation 71, deactivation 72). type: str choices: allow, deny more...
- ue_activity_notif_ack - UE activity notification/acknowledge (notif 155, ack 156). type: str choices: allow, deny more...
- ue_registration_query_req_resp - UE registration query request/response (req 158, resp 159). 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...
- update_bearer - Update bearer (req 97, resp 98). type: str choices: allow, deny more...
- update_pdn_connection_set - Update PDN connection set (req 200, resp 201). type: str choices: allow, deny more...
- version_not_support - Version not supported (3). type: str choices: allow, deny more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Message filter for GTPv2 messages.
fortinet.fortios.fortios_gtp_message_filter_v2:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
gtp_message_filter_v2:
alert_mme_notif_ack: "allow"
bearer_resource_cmd_fail: "allow"
change_notification: "allow"
configuration_transfer_tunnel: "allow"
context_req_res_ack: "allow"
create_bearer: "allow"
create_forwarding_tunnel_req_resp: "allow"
create_indirect_forwarding_tunnel_req_resp: "allow"
create_session: "allow"
cs_paging: "allow"
delete_bearer_cmd_fail: "allow"
delete_bearer_req_resp: "allow"
delete_indirect_forwarding_tunnel_req_resp: "allow"
delete_pdn_connection_set: "allow"
delete_session: "allow"
detach_notif_ack: "allow"
dlink_data_notif_ack: "allow"
dlink_notif_failure: "allow"
echo: "allow"
forward_access_notif_ack: "allow"
forward_relocation_cmp_notif_ack: "allow"
forward_relocation_req_res: "allow"
identification_req_resp: "allow"
isr_status: "allow"
mbms_session_start_req_resp: "allow"
mbms_session_stop_req_resp: "allow"
mbms_session_update_req_resp: "allow"
modify_access_req_resp: "allow"
modify_bearer_cmd_fail: "allow"
modify_bearer_req_resp: "allow"
name: "default_name_33"
pgw_dlink_notif_ack: "allow"
pgw_restart_notif_ack: "allow"
ran_info_relay: "allow"
release_access_bearer_req_resp: "allow"
relocation_cancel_req_resp: "allow"
remote_ue_report_notif_ack: "allow"
reserved_for_earlier_version: "allow"
resume: "allow"
stop_paging_indication: "allow"
suspend: "allow"
trace_session: "allow"
ue_activity_notif_ack: "allow"
ue_registration_query_req_resp: "allow"
unknown_message: "allow"
unknown_message_white_list:
-
id: "49"
update_bearer: "allow"
update_pdn_connection_set: "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
Status
This module is not guaranteed to have a backwards compatible interface.