:source: fortios_firewall_gtp.py :orphan: .. fortios_firewall_gtp: fortios_firewall_gtp -- Configure GTP in Fortinet's FortiOS and FortiGate. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and gtp 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 -> v7.6.6 Parameters ---------- .. raw:: html Notes ----- .. note:: - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks - The module supports check_mode. Examples -------- .. code-block:: yaml+jinja - name: Configure GTP. fortinet.fortios.fortios_firewall_gtp: vdom: "{{ vdom }}" state: "present" access_token: "" firewall_gtp: addr_notify: "" apn: - action: "allow" apnmember: - name: "default_name_7 (source gtp.apn.name gtp.apngrp.name)" id: "8" selection_mode: "ms" apn_filter: "enable" authorized_ggsns: " (source firewall.address.name firewall.addrgrp.name)" authorized_ggsns6: " (source firewall.address6.name firewall.addrgrp6.name)" authorized_sgsns: " (source firewall.address.name firewall.addrgrp.name)" authorized_sgsns6: " (source firewall.address6.name firewall.addrgrp6.name)" comment: "Comment." context_id: "696" control_plane_message_rate_limit: "0" default_apn_action: "allow" default_imsi_action: "allow" default_ip_action: "allow" default_noip_action: "allow" default_policy_action: "allow" denied_log: "enable" echo_request_interval: "0" echo_requires_path_in_use: "enable" extension_log: "enable" forwarded_log: "enable" global_tunnel_limit: " (source gtp.tunnel-limit.name)" gtp_in_gtp: "allow" gtpu_denied_log: "enable" gtpu_forwarded_log: "enable" gtpu_log_freq: "0" gtpv0: "allow" half_close_timeout: "10" half_open_timeout: "300" handover_group: " (source firewall.address.name firewall.addrgrp.name)" handover_group6: " (source firewall.address6.name firewall.addrgrp6.name)" ie_allow_list_v0v1: " (source gtp.ie-allow-list.name)" ie_allow_list_v2: " (source gtp.ie-allow-list.name)" ie_remove_policy: - id: "41" remove_ies: "apn-restriction" sgsn_addr: " (source firewall.address.name firewall.addrgrp.name)" sgsn_addr6: " (source firewall.address6.name firewall.addrgrp6.name)" ie_remover: "enable" ie_validation: apn_restriction: "enable" charging_gateway_addr: "enable" charging_ID: "enable" end_user_addr: "enable" gsn_addr: "enable" imei: "enable" imsi: "enable" mm_context: "enable" ms_tzone: "enable" ms_validated: "enable" msisdn: "enable" nsapi: "enable" pdp_context: "enable" qos_profile: "enable" rai: "enable" rat_type: "enable" reordering_required: "enable" selection_mode: "enable" uli: "enable" ie_white_list_v0v1: " (source gtp.ie-white-list.name)" ie_white_list_v2: " (source gtp.ie-white-list.name)" imsi: - action: "allow" apnmember: - name: "default_name_71 (source gtp.apn.name gtp.apngrp.name)" id: "72" mcc_mnc: "" msisdn_prefix: "" selection_mode: "ms" imsi_filter: "enable" interface_notify: " (source system.interface.name)" invalid_reserved_field: "allow" invalid_sgsns_to_log: " (source firewall.address.name firewall.addrgrp.name)" invalid_sgsns6_to_log: " (source firewall.address6.name firewall.addrgrp6.name)" ip_filter: "enable" ip_policy: - action: "allow" dstaddr: " (source firewall.address.name firewall.addrgrp.name)" dstaddr6: " (source firewall.address6.name firewall.addrgrp6.name)" id: "86" srcaddr: " (source firewall.address.name firewall.addrgrp.name)" srcaddr6: " (source firewall.address6.name firewall.addrgrp6.name)" log_freq: "0" log_gtpu_limit: "0" log_imsi_prefix: "" log_msisdn_prefix: "" max_message_length: "1452" message_filter_v0v1: " (source gtp.message-filter-v0v1.name)" message_filter_v2: " (source gtp.message-filter-v2.name)" message_rate_limit: create_aa_pdp_request: "0" create_aa_pdp_response: "0" create_mbms_request: "0" create_mbms_response: "0" create_pdp_request: "0" create_pdp_response: "0" delete_aa_pdp_request: "0" delete_aa_pdp_response: "0" delete_mbms_request: "0" delete_mbms_response: "0" delete_pdp_request: "0" delete_pdp_response: "0" echo_reponse: "0" echo_request: "0" echo_response: "0" error_indication: "0" failure_report_request: "0" failure_report_response: "0" fwd_reloc_complete_ack: "0" fwd_relocation_complete: "0" fwd_relocation_request: "0" fwd_relocation_response: "0" fwd_srns_context: "0" fwd_srns_context_ack: "0" g_pdu: "0" identification_request: "0" identification_response: "0" mbms_de_reg_request: "0" mbms_de_reg_response: "0" mbms_notify_rej_request: "0" mbms_notify_rej_response: "0" mbms_notify_request: "0" mbms_notify_response: "0" mbms_reg_request: "0" mbms_reg_response: "0" mbms_ses_start_request: "0" mbms_ses_start_response: "0" mbms_ses_stop_request: "0" mbms_ses_stop_response: "0" note_ms_request: "0" note_ms_response: "0" pdu_notify_rej_request: "0" pdu_notify_rej_response: "0" pdu_notify_request: "0" pdu_notify_response: "0" ran_info: "0" relocation_cancel_request: "0" relocation_cancel_response: "0" send_route_request: "0" send_route_response: "0" sgsn_context_ack: "0" sgsn_context_request: "0" sgsn_context_response: "0" support_ext_hdr_notify: "0" update_mbms_request: "0" update_mbms_response: "0" update_pdp_request: "0" update_pdp_response: "0" version_not_support: "0" message_rate_limit_v0: create_pdp_request: "0" delete_pdp_request: "0" echo_request: "0" message_rate_limit_v1: create_pdp_request: "0" delete_pdp_request: "0" echo_request: "0" message_rate_limit_v2: create_session_request: "0" delete_session_request: "0" echo_request: "0" min_message_length: "0" miss_must_ie: "allow" monitor_mode: "enable" name: "default_name_171" noip_filter: "enable" noip_policy: - action: "allow" end: "0" id: "176" start: "0" type: "etsi" out_of_state_ie: "allow" out_of_state_message: "allow" per_apn_shaper: - apn: " (source gtp.apn.name)" id: "183" rate_limit: "0" version: "1" policy: - action: "allow" apn_sel_mode: "ms" apnmember: - name: "default_name_190 (source gtp.apn.name gtp.apngrp.name)" id: "191" imei: "" imsi: "" imsi_prefix: "" max_apn_restriction: "all" messages: "create-req" msisdn: "" msisdn_prefix: "" rai: "" rat_type: "any" uli: "" policy_filter: "enable" policy_v2: - action: "allow" apn_sel_mode: "ms" apnmember: - name: "default_name_207 (source gtp.apn.name gtp.apngrp.name)" id: "208" imsi_prefix: "" max_apn_restriction: "all" mei: "" messages: "create-ses-req" msisdn_prefix: "" rat_type: "any" uli: "" port_notify: "21123" rat_timeout_profile: " (source gtp.rat-timeout-profile.name)" rate_limit_mode: "per-profile" rate_limited_log: "enable" rate_sampling_interval: "1" remove_if_echo_expires: "enable" remove_if_recovery_differ: "enable" reserved_ie: "allow" send_delete_when_timeout: "enable" send_delete_when_timeout_v2: "enable" spoof_src_addr: "allow" state_invalid_log: "enable" sub_second_interval: "0.5" sub_second_sampling: "enable" traffic_count_log: "enable" tunnel_limit: "0" tunnel_limit_log: "enable" tunnel_timeout: "86400" unknown_version_action: "allow" user_plane_message_rate_limit: "0" warning_threshold: "0" 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: .. raw:: html
  • 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. Authors ------- - Link Zheng (@chillancezen) - Jie Xue (@JieX19) - Hongbin Lu (@fgtdev-hblu) - Frank Shen (@frankshen01) - Miguel Angel Munoz (@mamunozgonzalez) - Nicolas Thomas (@thomnico) .. hint:: If you notice any issues in this documentation, you can create a pull request to improve it.