fortinet.fortimanager.fmgr_firewall_gtp module – Configure GTP.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

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.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_gtp.

New in fortinet.fortimanager 2.0.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

firewall_gtp

dictionary

The top level parameters set.

addr-notify

string

Deprecated, please rename it to addr_notify. Overbilling notify address

apn

list / elements=dictionary

Apn.

action

string

Action.

Choices:

  • "allow"

  • "deny"

apnmember

any

(list or str) APN member.

id

integer

ID.

selection-mode

list / elements=string

Deprecated, please rename it to selection_mode. APN selection mode.

Choices:

  • "ms"

  • "net"

  • "vrf"

apn-filter

string

Deprecated, please rename it to apn_filter. Apn filter

Choices:

  • "disable"

  • "enable"

authorized-ggsns

string

Deprecated, please rename it to authorized_ggsns. Authorized GGSN group

authorized-ggsns6

string

Deprecated, please rename it to authorized_ggsns6. Authorized GGSN/PGW IPv6 group.

authorized-sgsns

string

Deprecated, please rename it to authorized_sgsns. Authorized SGSN group

authorized-sgsns6

string

Deprecated, please rename it to authorized_sgsns6. Authorized SGSN/SGW IPv6 group.

comment

string

Comment.

context-id

integer

Deprecated, please rename it to context_id. Overbilling context.

control-plane-message-rate-limit

integer

Deprecated, please rename it to control_plane_message_rate_limit. Control plane message rate limit

default-apn-action

string

Deprecated, please rename it to default_apn_action. Default apn action

Choices:

  • "allow"

  • "deny"

default-imsi-action

string

Deprecated, please rename it to default_imsi_action. Default imsi action

Choices:

  • "allow"

  • "deny"

default-ip-action

string

Deprecated, please rename it to default_ip_action. Default action for encapsulated IP traffic

Choices:

  • "allow"

  • "deny"

default-noip-action

string

Deprecated, please rename it to default_noip_action. Default action for encapsulated non-IP traffic

Choices:

  • "allow"

  • "deny"

default-policy-action

string

Deprecated, please rename it to default_policy_action. Default advanced policy action

Choices:

  • "allow"

  • "deny"

denied-log

string

Deprecated, please rename it to denied_log. Log denied

Choices:

  • "disable"

  • "enable"

echo-request-interval

integer

Deprecated, please rename it to echo_request_interval. Echo request interval

extension-log

string

Deprecated, please rename it to extension_log. Log in extension format

Choices:

  • "disable"

  • "enable"

forwarded-log

string

Deprecated, please rename it to forwarded_log. Log forwarded

Choices:

  • "disable"

  • "enable"

global-tunnel-limit

string

Deprecated, please rename it to global_tunnel_limit. Global tunnel limit.

gtp-in-gtp

string

Deprecated, please rename it to gtp_in_gtp. Gtp in gtp

Choices:

  • "allow"

  • "deny"

gtpu-denied-log

string

Deprecated, please rename it to gtpu_denied_log. Enable/disable logging of denied GTP-U packets.

Choices:

  • "disable"

  • "enable"

gtpu-forwarded-log

string

Deprecated, please rename it to gtpu_forwarded_log. Enable/disable logging of forwarded GTP-U packets.

Choices:

  • "disable"

  • "enable"

gtpu-log-freq

integer

Deprecated, please rename it to gtpu_log_freq. Logging of frequency of GTP-U packets.

half-close-timeout

integer

Deprecated, please rename it to half_close_timeout. Half-close tunnel timeout

half-open-timeout

integer

Deprecated, please rename it to half_open_timeout. Half-open tunnel timeout

handover-group

string

Deprecated, please rename it to handover_group. Handover SGSN group

handover-group6

string

Deprecated, please rename it to handover_group6. Handover SGSN/SGW IPv6 group.

ie-allow-list-v0v1

string

Deprecated, please rename it to ie_allow_list_v0v1. IE allow list.

ie-allow-list-v2

string

Deprecated, please rename it to ie_allow_list_v2. IE allow list.

ie-remove-policy

list / elements=dictionary

Deprecated, please rename it to ie_remove_policy. Ie-Remove-Policy.

id

integer

ID.

remove-ies

list / elements=string

Deprecated, please rename it to remove_ies. GTP IEs to be removed.

Choices:

  • "apn-restriction"

  • "rat-type"

  • "rai"

  • "uli"

  • "imei"

sgsn-addr

string

Deprecated, please rename it to sgsn_addr. SGSN address name.

sgsn-addr6

string

Deprecated, please rename it to sgsn_addr6. SGSN IPv6 address name.

ie-remover

string

Deprecated, please rename it to ie_remover. IE removal policy.

Choices:

  • "disable"

  • "enable"

ie-validation

dictionary

Deprecated, please rename it to ie_validation.

apn-restriction

string

Deprecated, please rename it to apn_restriction. Validate APN restriction.

Choices:

  • "disable"

  • "enable"

charging-gateway-addr

string

Deprecated, please rename it to charging_gateway_addr. Validate charging gateway address.

Choices:

  • "disable"

  • "enable"

charging-ID

string

Deprecated, please rename it to charging_ID. Validate charging ID.

Choices:

  • "disable"

  • "enable"

end-user-addr

string

Deprecated, please rename it to end_user_addr. Validate end user address.

Choices:

  • "disable"

  • "enable"

gsn-addr

string

Deprecated, please rename it to gsn_addr. Validate GSN address.

Choices:

  • "disable"

  • "enable"

imei

string

Validate IMEI

Choices:

  • "disable"

  • "enable"

imsi

string

Validate IMSI.

Choices:

  • "disable"

  • "enable"

mm-context

string

Deprecated, please rename it to mm_context. Validate MM context.

Choices:

  • "disable"

  • "enable"

ms-tzone

string

Deprecated, please rename it to ms_tzone. Validate MS time zone.

Choices:

  • "disable"

  • "enable"

ms-validated

string

Deprecated, please rename it to ms_validated. Validate MS validated.

Choices:

  • "disable"

  • "enable"

msisdn

string

Validate MSISDN.

Choices:

  • "disable"

  • "enable"

nsapi

string

Validate NSAPI.

Choices:

  • "disable"

  • "enable"

pdp-context

string

Deprecated, please rename it to pdp_context. Validate PDP context.

Choices:

  • "disable"

  • "enable"

qos-profile

string

Deprecated, please rename it to qos_profile. Validate Quality of Service

Choices:

  • "disable"

  • "enable"

rai

string

Validate RAI.

Choices:

  • "disable"

  • "enable"

rat-type

string

Deprecated, please rename it to rat_type. Validate RAT type.

Choices:

  • "disable"

  • "enable"

reordering-required

string

Deprecated, please rename it to reordering_required. Validate re-ordering required.

Choices:

  • "disable"

  • "enable"

selection-mode

string

Deprecated, please rename it to selection_mode. Validate selection mode.

Choices:

  • "disable"

  • "enable"

uli

string

Validate user location information.

Choices:

  • "disable"

  • "enable"

ie-white-list-v0v1

string

Deprecated, please rename it to ie_white_list_v0v1. IE white list.

ie-white-list-v2

string

Deprecated, please rename it to ie_white_list_v2. IE white list.

imsi

list / elements=dictionary

Imsi.

action

string

Action.

Choices:

  • "allow"

  • "deny"

apnmember

any

(list or str) APN member.

id

integer

ID.

mcc-mnc

string

Deprecated, please rename it to mcc_mnc. MCC MNC.

msisdn-prefix

string

Deprecated, please rename it to msisdn_prefix. MSISDN prefix.

selection-mode

list / elements=string

Deprecated, please rename it to selection_mode. APN selection mode.

Choices:

  • "ms"

  • "net"

  • "vrf"

imsi-filter

string

Deprecated, please rename it to imsi_filter. Imsi filter

Choices:

  • "disable"

  • "enable"

interface-notify

string

Deprecated, please rename it to interface_notify. Overbilling interface

invalid-reserved-field

string

Deprecated, please rename it to invalid_reserved_field. Invalid reserved field in GTP header

Choices:

  • "allow"

  • "deny"

invalid-sgsns-to-log

string

Deprecated, please rename it to invalid_sgsns_to_log. Invalid SGSN group to be logged

invalid-sgsns6-to-log

string

Deprecated, please rename it to invalid_sgsns6_to_log. Invalid SGSN IPv6 group to be logged.

ip-filter

string

Deprecated, please rename it to ip_filter. IP filter for encapsulted traffic

Choices:

  • "disable"

  • "enable"

ip-policy

list / elements=dictionary

Deprecated, please rename it to ip_policy. Ip-Policy.

action

string

Action.

Choices:

  • "allow"

  • "deny"

dstaddr

string

Destination address name.

dstaddr6

string

Destination IPv6 address name.

id

integer

ID.

srcaddr

string

Source address name.

srcaddr6

string

Source IPv6 address name.

log-freq

integer

Deprecated, please rename it to log_freq. Logging of frequency of GTP-C packets.

log-gtpu-limit

integer

Deprecated, please rename it to log_gtpu_limit. The user data log limit

log-imsi-prefix

string

Deprecated, please rename it to log_imsi_prefix. IMSI prefix for selective logging.

log-msisdn-prefix

string

Deprecated, please rename it to log_msisdn_prefix. The msisdn prefix for selective logging

max-message-length

integer

Deprecated, please rename it to max_message_length. Max message length

message-filter

dictionary

Deprecated, please rename it to message_filter.

create-aa-pdp

string

Deprecated, please rename it to create_aa_pdp. Create AA PDP.

Choices:

  • "allow"

  • "deny"

create-mbms

string

Deprecated, please rename it to create_mbms. Create MBMS.

Choices:

  • "allow"

  • "deny"

create-pdp

string

Deprecated, please rename it to create_pdp. Create PDP.

Choices:

  • "allow"

  • "deny"

data-record

string

Deprecated, please rename it to data_record. Data record.

Choices:

  • "allow"

  • "deny"

delete-aa-pdp

string

Deprecated, please rename it to delete_aa_pdp. Delete AA PDP.

Choices:

  • "allow"

  • "deny"

delete-mbms

string

Deprecated, please rename it to delete_mbms. Delete MBMS.

Choices:

  • "allow"

  • "deny"

delete-pdp

string

Deprecated, please rename it to delete_pdp. Delete PDP.

Choices:

  • "allow"

  • "deny"

echo

string

Echo.

Choices:

  • "allow"

  • "deny"

error-indication

string

Deprecated, please rename it to error_indication. Error indication.

Choices:

  • "allow"

  • "deny"

failure-report

string

Deprecated, please rename it to failure_report. Failure report.

Choices:

  • "allow"

  • "deny"

fwd-relocation

string

Deprecated, please rename it to fwd_relocation. Forward relocation.

Choices:

  • "allow"

  • "deny"

fwd-srns-context

string

Deprecated, please rename it to fwd_srns_context. Forward SRNS context.

Choices:

  • "allow"

  • "deny"

gtp-pdu

string

Deprecated, please rename it to gtp_pdu. GTP PDU.

Choices:

  • "allow"

  • "deny"

identification

string

Identification.

Choices:

  • "allow"

  • "deny"

mbms-notification

string

Deprecated, please rename it to mbms_notification. MBMS notification.

Choices:

  • "allow"

  • "deny"

node-alive

string

Deprecated, please rename it to node_alive. Node alive.

Choices:

  • "allow"

  • "deny"

note-ms-present

string

Deprecated, please rename it to note_ms_present. Note MS present.

Choices:

  • "allow"

  • "deny"

pdu-notification

string

Deprecated, please rename it to pdu_notification. PDU notification.

Choices:

  • "allow"

  • "deny"

ran-info

string

Deprecated, please rename it to ran_info. Ran info.

Choices:

  • "allow"

  • "deny"

redirection

string

Redirection.

Choices:

  • "allow"

  • "deny"

relocation-cancel

string

Deprecated, please rename it to relocation_cancel. Relocation cancel.

Choices:

  • "allow"

  • "deny"

send-route

string

Deprecated, please rename it to send_route. Send route.

Choices:

  • "allow"

  • "deny"

sgsn-context

string

Deprecated, please rename it to sgsn_context. SGSN context.

Choices:

  • "allow"

  • "deny"

support-extension

string

Deprecated, please rename it to support_extension. Support extension.

Choices:

  • "allow"

  • "deny"

unknown-message-action

string

Deprecated, please rename it to unknown_message_action. Unknown message action.

Choices:

  • "allow"

  • "deny"

update-mbms

string

Deprecated, please rename it to update_mbms. Update MBMS.

Choices:

  • "allow"

  • "deny"

update-pdp

string

Deprecated, please rename it to update_pdp. Update PDP.

Choices:

  • "allow"

  • "deny"

version-not-support

string

Deprecated, please rename it to version_not_support. Version not supported.

Choices:

  • "allow"

  • "deny"

message-filter-v0v1

string

Deprecated, please rename it to message_filter_v0v1. Message filter.

message-filter-v2

string

Deprecated, please rename it to message_filter_v2. Message filter.

message-rate-limit

dictionary

Deprecated, please rename it to message_rate_limit.

create-aa-pdp-request

integer

Deprecated, please rename it to create_aa_pdp_request. Rate limit for create AA PDP context request

create-aa-pdp-response

integer

Deprecated, please rename it to create_aa_pdp_response. Rate limit for create AA PDP context response

create-mbms-request

integer

Deprecated, please rename it to create_mbms_request. Rate limit for create MBMS context request

create-mbms-response

integer

Deprecated, please rename it to create_mbms_response. Rate limit for create MBMS context response

create-pdp-request

integer

Deprecated, please rename it to create_pdp_request. Rate limit for create PDP context request

create-pdp-response

integer

Deprecated, please rename it to create_pdp_response. Rate limit for create PDP context response

delete-aa-pdp-request

integer

Deprecated, please rename it to delete_aa_pdp_request. Rate limit for delete AA PDP context request

delete-aa-pdp-response

integer

Deprecated, please rename it to delete_aa_pdp_response. Rate limit for delete AA PDP context response

delete-mbms-request

integer

Deprecated, please rename it to delete_mbms_request. Rate limit for delete MBMS context request

delete-mbms-response

integer

Deprecated, please rename it to delete_mbms_response. Rate limit for delete MBMS context response

delete-pdp-request

integer

Deprecated, please rename it to delete_pdp_request. Rate limit for delete PDP context request

delete-pdp-response

integer

Deprecated, please rename it to delete_pdp_response. Rate limit for delete PDP context response

echo-reponse

integer

Deprecated, please rename it to echo_reponse. Rate limit for echo response

echo-request

integer

Deprecated, please rename it to echo_request. Rate limit for echo requests

error-indication

integer

Deprecated, please rename it to error_indication. Rate limit for error indication

failure-report-request

integer

Deprecated, please rename it to failure_report_request. Rate limit for failure report request

failure-report-response

integer

Deprecated, please rename it to failure_report_response. Rate limit for failure report response

fwd-reloc-complete-ack

integer

Deprecated, please rename it to fwd_reloc_complete_ack. Rate limit for forward relocation complete acknowledge

fwd-relocation-complete

integer

Deprecated, please rename it to fwd_relocation_complete. Rate limit for forward relocation complete

fwd-relocation-request

integer

Deprecated, please rename it to fwd_relocation_request. Rate limit for forward relocation request

fwd-relocation-response

integer

Deprecated, please rename it to fwd_relocation_response. Rate limit for forward relocation response

fwd-srns-context

integer

Deprecated, please rename it to fwd_srns_context. Rate limit for forward SRNS context

fwd-srns-context-ack

integer

Deprecated, please rename it to fwd_srns_context_ack. Rate limit for forward SRNS context acknowledge

g-pdu

integer

Deprecated, please rename it to g_pdu. Rate limit for G-PDU

identification-request

integer

Deprecated, please rename it to identification_request. Rate limit for identification request

identification-response

integer

Deprecated, please rename it to identification_response. Rate limit for identification response

mbms-de-reg-request

integer

Deprecated, please rename it to mbms_de_reg_request. Rate limit for MBMS de-registration request

mbms-de-reg-response

integer

Deprecated, please rename it to mbms_de_reg_response. Rate limit for MBMS de-registration response

mbms-notify-rej-request

integer

Deprecated, please rename it to mbms_notify_rej_request. Rate limit for MBMS notification reject request

mbms-notify-rej-response

integer

Deprecated, please rename it to mbms_notify_rej_response. Rate limit for MBMS notification reject response

mbms-notify-request

integer

Deprecated, please rename it to mbms_notify_request. Rate limit for MBMS notification request

mbms-notify-response

integer

Deprecated, please rename it to mbms_notify_response. Rate limit for MBMS notification response

mbms-reg-request

integer

Deprecated, please rename it to mbms_reg_request. Rate limit for MBMS registration request

mbms-reg-response

integer

Deprecated, please rename it to mbms_reg_response. Rate limit for MBMS registration response

mbms-ses-start-request

integer

Deprecated, please rename it to mbms_ses_start_request. Rate limit for MBMS session start request

mbms-ses-start-response

integer

Deprecated, please rename it to mbms_ses_start_response. Rate limit for MBMS session start response

mbms-ses-stop-request

integer

Deprecated, please rename it to mbms_ses_stop_request. Rate limit for MBMS session stop request

mbms-ses-stop-response

integer

Deprecated, please rename it to mbms_ses_stop_response. Rate limit for MBMS session stop response

note-ms-request

integer

Deprecated, please rename it to note_ms_request. Rate limit for note MS GPRS present request

note-ms-response

integer

Deprecated, please rename it to note_ms_response. Rate limit for note MS GPRS present response

pdu-notify-rej-request

integer

Deprecated, please rename it to pdu_notify_rej_request. Rate limit for PDU notify reject request

pdu-notify-rej-response

integer

Deprecated, please rename it to pdu_notify_rej_response. Rate limit for PDU notify reject response

pdu-notify-request

integer

Deprecated, please rename it to pdu_notify_request. Rate limit for PDU notify request

pdu-notify-response

integer

Deprecated, please rename it to pdu_notify_response. Rate limit for PDU notify response

ran-info

integer

Deprecated, please rename it to ran_info. Rate limit for RAN information relay

relocation-cancel-request

integer

Deprecated, please rename it to relocation_cancel_request. Rate limit for relocation cancel request

relocation-cancel-response

integer

Deprecated, please rename it to relocation_cancel_response. Rate limit for relocation cancel response

send-route-request

integer

Deprecated, please rename it to send_route_request. Rate limit for send routing information for GPRS request

send-route-response

integer

Deprecated, please rename it to send_route_response. Rate limit for send routing information for GPRS response

sgsn-context-ack

integer

Deprecated, please rename it to sgsn_context_ack. Rate limit for SGSN context acknowledgement

sgsn-context-request

integer

Deprecated, please rename it to sgsn_context_request. Rate limit for SGSN context request

sgsn-context-response

integer

Deprecated, please rename it to sgsn_context_response. Rate limit for SGSN context response

support-ext-hdr-notify

integer

Deprecated, please rename it to support_ext_hdr_notify. Rate limit for support extension headers notification

update-mbms-request

integer

Deprecated, please rename it to update_mbms_request. Rate limit for update MBMS context request

update-mbms-response

integer

Deprecated, please rename it to update_mbms_response. Rate limit for update MBMS context response

update-pdp-request

integer

Deprecated, please rename it to update_pdp_request. Rate limit for update PDP context request

update-pdp-response

integer

Deprecated, please rename it to update_pdp_response. Rate limit for update PDP context response

version-not-support

integer

Deprecated, please rename it to version_not_support. Rate limit for version not supported

message-rate-limit-v0

dictionary

Deprecated, please rename it to message_rate_limit_v0.

create-pdp-request

integer

Deprecated, please rename it to create_pdp_request. Rate limit

delete-pdp-request

integer

Deprecated, please rename it to delete_pdp_request. Rate limit

echo-request

integer

Deprecated, please rename it to echo_request. Rate limit

message-rate-limit-v1

dictionary

Deprecated, please rename it to message_rate_limit_v1.

create-pdp-request

integer

Deprecated, please rename it to create_pdp_request. Rate limit

delete-pdp-request

integer

Deprecated, please rename it to delete_pdp_request. Rate limit

echo-request

integer

Deprecated, please rename it to echo_request. Rate limit

message-rate-limit-v2

dictionary

Deprecated, please rename it to message_rate_limit_v2.

create-session-request

integer

Deprecated, please rename it to create_session_request. Rate limit

delete-session-request

integer

Deprecated, please rename it to delete_session_request. Rate limit

echo-request

integer

Deprecated, please rename it to echo_request. Rate limit

min-message-length

integer

Deprecated, please rename it to min_message_length. Min message length

miss-must-ie

string

Deprecated, please rename it to miss_must_ie. Missing mandatory information element

Choices:

  • "allow"

  • "deny"

monitor-mode

string

Deprecated, please rename it to monitor_mode. GTP monitor mode

Choices:

  • "disable"

  • "enable"

  • "vdom"

name

string / required

Profile name.

noip-filter

string

Deprecated, please rename it to noip_filter. Non-IP filter for encapsulted traffic

Choices:

  • "disable"

  • "enable"

noip-policy

list / elements=dictionary

Deprecated, please rename it to noip_policy. Noip-Policy.

action

string

Action.

Choices:

  • "allow"

  • "deny"

end

integer

End of protocol range

id

integer

ID.

start

integer

Start of protocol range

type

string

Protocol field type.

Choices:

  • "etsi"

  • "ietf"

out-of-state-ie

string

Deprecated, please rename it to out_of_state_ie. Out of state information element.

Choices:

  • "allow"

  • "deny"

out-of-state-message

string

Deprecated, please rename it to out_of_state_message. Out of state GTP message

Choices:

  • "allow"

  • "deny"

per-apn-shaper

list / elements=dictionary

Deprecated, please rename it to per_apn_shaper. Per-Apn-Shaper.

apn

string

APN name.

id

integer

ID.

rate-limit

integer

Deprecated, please rename it to rate_limit. Rate limit

version

integer

GTP version number

policy

list / elements=dictionary

Policy.

action

string

Action.

Choices:

  • "allow"

  • "deny"

apn

string

APN subfix.

apn-sel-mode

list / elements=string

Deprecated, please rename it to apn_sel_mode. APN selection mode.

Choices:

  • "ms"

  • "net"

  • "vrf"

apnmember

any

(list or str) APN member.

id

integer

ID.

imei

string

IMEI

imsi

string

IMSI prefix.

imsi-prefix

string

Deprecated, please rename it to imsi_prefix. IMSI prefix.

max-apn-restriction

string

Deprecated, please rename it to max_apn_restriction. Maximum APN restriction value.

Choices:

  • "all"

  • "public-1"

  • "public-2"

  • "private-1"

  • "private-2"

messages

list / elements=string

GTP messages.

Choices:

  • "create-req"

  • "create-res"

  • "update-req"

  • "update-res"

msisdn

string

MSISDN prefix.

msisdn-prefix

string

Deprecated, please rename it to msisdn_prefix. MSISDN prefix.

rai

string

RAI pattern.

rat-type

list / elements=string

Deprecated, please rename it to rat_type. RAT Type.

Choices:

  • "any"

  • "utran"

  • "geran"

  • "wlan"

  • "gan"

  • "hspa"

  • "eutran"

  • "virtual"

  • "nbiot"

uli

string

ULI pattern.

policy-filter

string

Deprecated, please rename it to policy_filter. Advanced policy filter

Choices:

  • "disable"

  • "enable"

policy-v2

list / elements=dictionary

Deprecated, please rename it to policy_v2. Policy-V2.

action

string

Action.

Choices:

  • "deny"

  • "allow"

apn-sel-mode

list / elements=string

Deprecated, please rename it to apn_sel_mode. APN selection mode.

Choices:

  • "ms"

  • "net"

  • "vrf"

apnmember

any

(list or str) APN member.

id

integer

ID.

imsi-prefix

string

Deprecated, please rename it to imsi_prefix. IMSI prefix.

max-apn-restriction

string

Deprecated, please rename it to max_apn_restriction. Maximum APN restriction value.

Choices:

  • "all"

  • "public-1"

  • "public-2"

  • "private-1"

  • "private-2"

mei

string

MEI pattern.

messages

list / elements=string

GTP messages.

Choices:

  • "create-ses-req"

  • "create-ses-res"

  • "modify-bearer-req"

  • "modify-bearer-res"

msisdn-prefix

string

Deprecated, please rename it to msisdn_prefix. MSISDN prefix.

rat-type

list / elements=string

Deprecated, please rename it to rat_type. RAT Type.

Choices:

  • "any"

  • "utran"

  • "geran"

  • "wlan"

  • "gan"

  • "hspa"

  • "eutran"

  • "virtual"

  • "nbiot"

  • "ltem"

  • "nr"

uli

any

(list) GTPv2 ULI patterns

port-notify

integer

Deprecated, please rename it to port_notify. Overbilling notify port

rat-timeout-profile

string

Deprecated, please rename it to rat_timeout_profile. RAT timeout profile.

rate-limit-mode

string

Deprecated, please rename it to rate_limit_mode. GTP rate limit mode.

Choices:

  • "per-profile"

  • "per-stream"

  • "per-apn"

rate-limited-log

string

Deprecated, please rename it to rate_limited_log. Log rate limited

Choices:

  • "disable"

  • "enable"

rate-sampling-interval

integer

Deprecated, please rename it to rate_sampling_interval. Rate sampling interval

remove-if-echo-expires

string

Deprecated, please rename it to remove_if_echo_expires. Remove if echo response expires

Choices:

  • "disable"

  • "enable"

remove-if-recovery-differ

string

Deprecated, please rename it to remove_if_recovery_differ. Remove upon different Recovery IE

Choices:

  • "disable"

  • "enable"

reserved-ie

string

Deprecated, please rename it to reserved_ie. Reserved information element

Choices:

  • "allow"

  • "deny"

send-delete-when-timeout

string

Deprecated, please rename it to send_delete_when_timeout. Send DELETE request to path endpoints when GTPv0/v1 tunnel timeout.

Choices:

  • "disable"

  • "enable"

send-delete-when-timeout-v2

string

Deprecated, please rename it to send_delete_when_timeout_v2. Send DELETE request to path endpoints when GTPv2 tunnel timeout.

Choices:

  • "disable"

  • "enable"

spoof-src-addr

string

Deprecated, please rename it to spoof_src_addr. Spoofed source address for Mobile Station.

Choices:

  • "allow"

  • "deny"

state-invalid-log

string

Deprecated, please rename it to state_invalid_log. Log state invalid

Choices:

  • "disable"

  • "enable"

sub-second-interval

string

Deprecated, please rename it to sub_second_interval. Sub-second interval

Choices:

  • "0.1"

  • "0.25"

  • "0.5"

sub-second-sampling

string

Deprecated, please rename it to sub_second_sampling. Enable/disable sub-second sampling.

Choices:

  • "disable"

  • "enable"

traffic-count-log

string

Deprecated, please rename it to traffic_count_log. Log tunnel traffic counter

Choices:

  • "disable"

  • "enable"

tunnel-limit

integer

Deprecated, please rename it to tunnel_limit. Tunnel limit

tunnel-limit-log

string

Deprecated, please rename it to tunnel_limit_log. Tunnel limit

Choices:

  • "disable"

  • "enable"

tunnel-timeout

integer

Deprecated, please rename it to tunnel_timeout. Established tunnel timeout

unknown-version-action

string

Deprecated, please rename it to unknown_version_action. Action for unknown gtp version

Choices:

  • "allow"

  • "deny"

user-plane-message-rate-limit

integer

Deprecated, please rename it to user_plane_message_rate_limit. User plane message rate limit

warning-threshold

integer

Deprecated, please rename it to warning_threshold. Warning threshold for rate limiting

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure GTP.
      fortinet.fortimanager.fmgr_firewall_gtp:
        bypass_validation: false
        adom: FortiCarrier # This is FOC-only object, need a FortiCarrier adom
        state: present
        firewall_gtp:
          monitor-mode: disable # <value in [disable, enable, vdom]>
          name: "ansible-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the GTPs
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_gtp"
          params:
            adom: "FortiCarrier" # This is FOC-only object, need a FortiCarrier adom
            gtp: "your_value"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)