fmgr_firewall_gtp – Configure GTP.¶

New in version 2.10.

Synopsis
Requirements
FortiManager Version Compatibility
Parameters
Notes
Examples
Return Values
Status
Authors

Synopsis ¶

This module is able to configure a FortiManager device.
Examples include all parameters and values need to be adjusted to data sources before usage.

Requirements ¶

The below requirements are needed on the host that executes this module.

ansible>=2.9.0

FortiManager Version Compatibility ¶

	`6.0.0`	`6.2.1`	`6.2.3`	`6.2.5`	`6.4.0`	`6.4.2`	`6.4.5`	`7.0.0`	`7.2.0`
firewall_gtp	yes	yes	yes	yes	yes	yes	yes	yes	yes

Parameters ¶

enable_log - Enable/Disable logging for task type: bool required: false default: False
forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: false
proposed_method - The overridden method for the underlying Json RPC request type: str required: false choices: set, update, add
bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
state - The directive to create, update or delete an object type: str required: true choices: present, absent
adom - The parameter in requested url type: str required: true
firewall_gtp - no description type: dict

addr-notify - overbilling notify address type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

addr-notify True True True True True True True True True
apn - Apn. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

apn True True True True True True True True True
- action - Action. type: str choices: [allow, deny] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  action True True True True True True True True True
- apnmember - APN member. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  apnmember True True True True True True True True True
- id - ID. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True
- selection-mode - APN selection mode. type: array choices: [ms, net, vrf] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  selection-mode True True True True True True True True True
apn-filter - apn filter type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

apn-filter True True True True True True True True True
authorized-ggsns - Authorized GGSN group type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

authorized-ggsns True True True True True True True True True
authorized-sgsns - Authorized SGSN group type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

authorized-sgsns True True True True True True True True True
comment - Comment. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

comment True True True True True True True True True
context-id - Overbilling context. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

context-id True True True True True True True True True
control-plane-message-rate-limit - control plane message rate limit type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

control-plane-message-rate-limit True True True True True True True True True
default-apn-action - default apn action type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

default-apn-action True True True True True True True True True
default-imsi-action - default imsi action type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

default-imsi-action True True True True True True True True True
default-ip-action - default action for encapsulated IP traffic type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

default-ip-action True True True True True True True True True
default-noip-action - default action for encapsulated non-IP traffic type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

default-noip-action True True True True True True True True True
default-policy-action - default advanced policy action type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

default-policy-action True True True True True True True True True
denied-log - log denied type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

denied-log True True True True True True True True True
echo-request-interval - echo request interval (in seconds) type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

echo-request-interval True True True True True True True True True
extension-log - log in extension format type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

extension-log True True True True True True True True True
forwarded-log - log forwarded type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

forwarded-log True True True True True True True True True
global-tunnel-limit - Global tunnel limit. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

global-tunnel-limit True True True True True True True True True
gtp-in-gtp - gtp in gtp type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

gtp-in-gtp True True True True True True True True True
gtpu-denied-log - Enable/disable logging of denied GTP-U packets. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

gtpu-denied-log True True True True True True True True True
gtpu-forwarded-log - Enable/disable logging of forwarded GTP-U packets. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

gtpu-forwarded-log True True True True True True True True True
gtpu-log-freq - Logging of frequency of GTP-U packets. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

gtpu-log-freq True True True True True True True True True
half-close-timeout - Half-close tunnel timeout (in seconds). type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

half-close-timeout True True True True True True True True True
half-open-timeout - Half-open tunnel timeout (in seconds). type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

half-open-timeout True True True True True True True True True
handover-group - Handover SGSN group type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

handover-group True True True True True True True True True
ie-remove-policy - Ie-Remove-Policy. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ie-remove-policy True True True True True True True True True
- id - ID. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True
- remove-ies - GTP IEs to be removed. type: array choices: [apn-restriction, rat-type, rai, uli, imei] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  remove-ies True True True True True True True True True
- sgsn-addr - SGSN address name. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  sgsn-addr True True True True True True True True True
- sgsn-addr6 - SGSN IPv6 address name. type: str more...
  
  6.4.2 6.4.5 7.0.0 7.2.0
  
  sgsn-addr6 True True True True
ie-remover - IE removal policy. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ie-remover True True True True True True True True True
ie-white-list-v0v1 - IE white list. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ie-white-list-v0v1 True True True True True True True False False
ie-white-list-v2 - IE white list. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ie-white-list-v2 True True True True True True True False False
imsi - Imsi. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

imsi True True True True True True True True True
- action - Action. type: str choices: [allow, deny] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  action True True True True True True True True True
- apnmember - APN member. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  apnmember True True True True True True True True True
- id - ID. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True
- mcc-mnc - MCC MNC. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  mcc-mnc True True True True True True True True True
- msisdn-prefix - MSISDN prefix. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  msisdn-prefix True True True True True True True True True
- selection-mode - APN selection mode. type: array choices: [ms, net, vrf] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  selection-mode True True True True True True True True True
imsi-filter - imsi filter type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

imsi-filter True True True True True True True True True
interface-notify - overbilling interface type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

interface-notify True True True True True True True True True
invalid-reserved-field - Invalid reserved field in GTP header type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

invalid-reserved-field True True True True True True True True True
invalid-sgsns-to-log - Invalid SGSN group to be logged type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

invalid-sgsns-to-log True True True True True True True True True
ip-filter - IP filter for encapsulted traffic type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ip-filter True True True True True True True True True
ip-policy - Ip-Policy. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

ip-policy True True True True True True True True True
- action - Action. type: str choices: [allow, deny] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  action True True True True True True True True True
- dstaddr - Destination address name. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  dstaddr True True True True True True True True True
- id - ID. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True
- srcaddr - Source address name. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  srcaddr True True True True True True True True True
- dstaddr6 - Destination IPv6 address name. type: str more...
  
  6.4.2 6.4.5 7.0.0 7.2.0
  
  dstaddr6 True True True True
- srcaddr6 - Source IPv6 address name. type: str more...
  
  6.4.2 6.4.5 7.0.0 7.2.0
  
  srcaddr6 True True True True
log-freq - Logging of frequency of GTP-C packets. type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

log-freq True True True True True True True True True
log-gtpu-limit - the user data log limit (0-512 bytes) type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

log-gtpu-limit True True True True True True True True True
log-imsi-prefix - IMSI prefix for selective logging. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

log-imsi-prefix True True True True True True True True True
log-msisdn-prefix - the msisdn prefix for selective logging type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

log-msisdn-prefix True True True True True True True True True
max-message-length - max message length type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

max-message-length True True True True True True True True True
message-filter-v0v1 - Message filter. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

message-filter-v0v1 True True True True True True True True True
message-filter-v2 - Message filter. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

message-filter-v2 True True True True True True True True True
min-message-length - min message length type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

min-message-length True True True True True True True True True
miss-must-ie - Missing mandatory information element type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

miss-must-ie True True True True True True True True True
monitor-mode - GTP monitor mode type: str choices: [disable, enable, vdom] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

monitor-mode True True True True True True True True True
name - Profile name. type: str more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

name True True True True True True True True True
noip-filter - non-IP filter for encapsulted traffic type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

noip-filter True True True True True True True True True
noip-policy - Noip-Policy. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

noip-policy True True True True True True True True True
- action - Action. type: str choices: [allow, deny] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  action True True True True True True True True True
- end - End of protocol range (0 - 255). type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  end True True True True True True True True True
- id - ID. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True
- start - Start of protocol range (0 - 255). type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  start True True True True True True True True True
- type - Protocol field type. type: str choices: [etsi, ietf] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  type True True True True True True True True True
out-of-state-ie - Out of state information element. type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

out-of-state-ie True True True True True True True True True
out-of-state-message - Out of state GTP message type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

out-of-state-message True True True True True True True True True
per-apn-shaper - Per-Apn-Shaper. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

per-apn-shaper True True True True True True True True True
- apn - APN name. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  apn True True True True True True True True True
- id - ID. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True
- rate-limit - Rate limit (packets/s) for create PDP context request. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  rate-limit True True True True True True True True True
- version - GTP version number: 0 or 1. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  version True True True True True True True True True
policy - Policy. type: array more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

policy True True True True True True True True True
- action - Action. type: str choices: [allow, deny] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  action True True True True True True True True True
- apn-sel-mode - APN selection mode. type: array choices: [ms, net, vrf] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  apn-sel-mode True True True True True True True True True
- apnmember - APN member. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  apnmember True True True True True True True True True
- id - ID. type: int more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True True
- imei - IMEI(SV) pattern. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  imei True True True True True True True True True
- imsi - IMSI prefix. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  imsi True False False False False False False False False
- max-apn-restriction - Maximum APN restriction value. type: str choices: [all, public-1, public-2, private-1, private-2] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  max-apn-restriction True True True True True True True True True
- messages - GTP messages. type: array choices: [create-req, create-res, update-req, update-res] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  messages True True True True True True True True True
- msisdn - MSISDN prefix. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  msisdn True False False False False False False False False
- rai - RAI pattern. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  rai True True True True True True True True True
- rat-type - RAT Type. type: array choices: [any, utran, geran, wlan, gan, hspa, eutran, virtual, nbiot] more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  rat-type True True True True True True True True True
- uli - ULI pattern. type: str more...
  
  6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  uli True True True True True True True True True
- imsi-prefix - IMSI prefix. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  imsi-prefix True True True True True True True True
- msisdn-prefix - MSISDN prefix. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  msisdn-prefix True True True True True True True True
policy-filter - Advanced policy filter type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

policy-filter True True True True True True True True True
port-notify - overbilling notify port type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

port-notify True True True True True True True True True
rate-limit-mode - GTP rate limit mode. type: str choices: [per-profile, per-stream, per-apn] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

rate-limit-mode True True True True True True True True True
rate-limited-log - log rate limited type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

rate-limited-log True True True True True True True True True
rate-sampling-interval - rate sampling interval (1-3600 seconds) type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

rate-sampling-interval True True True True True True True True True
remove-if-echo-expires - remove if echo response expires type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

remove-if-echo-expires True True True True True True True True True
remove-if-recovery-differ - remove upon different Recovery IE type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

remove-if-recovery-differ True True True True True True True True True
reserved-ie - reserved information element type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

reserved-ie True True True True True True True True True
send-delete-when-timeout - send DELETE request to path endpoints when GTPv0/v1 tunnel timeout. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

send-delete-when-timeout True True True True True True True True True
send-delete-when-timeout-v2 - send DELETE request to path endpoints when GTPv2 tunnel timeout. type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

send-delete-when-timeout-v2 True True True True True True True True True
spoof-src-addr - Spoofed source address for Mobile Station. type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

spoof-src-addr True True True True True True True True True
state-invalid-log - log state invalid type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

state-invalid-log True True True True True True True True True
traffic-count-log - log tunnel traffic counter type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

traffic-count-log True True True True True True True True True
tunnel-limit - tunnel limit type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

tunnel-limit True True True True True True True True True
tunnel-limit-log - tunnel limit type: str choices: [disable, enable] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

tunnel-limit-log True True True True True True True True True
tunnel-timeout - Established tunnel timeout (in seconds). type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

tunnel-timeout True True True True True True True True True
unknown-version-action - action for unknown gtp version type: str choices: [allow, deny] more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

unknown-version-action True True True True True True True True True
user-plane-message-rate-limit - user plane message rate limit type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

user-plane-message-rate-limit True True True True True True True True True
warning-threshold - Warning threshold for rate limiting (0 - 99 percent). type: int more...

6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

warning-threshold True True True True True True True True True
policy-v2 - Policy-V2. type: array more...

6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

policy-v2 True True True True True True True True
- action - Action. type: str choices: [deny, allow] more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  action True True True True True True True True
- apn-sel-mode - APN selection mode. type: array choices: [ms, net, vrf] more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  apn-sel-mode True True True True True True True True
- apnmember - APN member. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  apnmember True True True True True True True True
- id - ID. type: int more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  id True True True True True True True True
- imsi-prefix - IMSI prefix. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  imsi-prefix True True True True True True True True
- max-apn-restriction - Maximum APN restriction value. type: str choices: [all, public-1, public-2, private-1, private-2] more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  max-apn-restriction True True True True True True True True
- mei - MEI pattern. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  mei True True True True True True True True
- messages - GTP messages. type: array choices: [create-ses-req, create-ses-res, modify-bearer-req, modify-bearer-res] more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  messages True True True True True True True True
- msisdn-prefix - MSISDN prefix. type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  msisdn-prefix True True True True True True True True
- rat-type - RAT Type. type: array choices: [any, utran, geran, wlan, gan, hspa, eutran, virtual, nbiot, ltem, nr] more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  rat-type True True True True True True True True
- uli - GTPv2 ULI patterns (in order of CGI SAI RAI TAI ECGI LAI). type: str more...
  
  6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
  
  uli True True True True True True True True
sub-second-interval - Sub-second interval (0. type: str choices: [0.1, 0.25, 0.5] more...

6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

sub-second-interval True True True True True True True
sub-second-sampling - Enable/disable sub-second sampling. type: str choices: [disable, enable] more...

6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0

sub-second-sampling True True True True True True True
authorized-ggsns6 - Authorized GGSN/PGW IPv6 group. type: str more...

6.4.2 6.4.5 7.0.0 7.2.0

authorized-ggsns6 True True True True
authorized-sgsns6 - Authorized SGSN/SGW IPv6 group. type: str more...

6.4.2 6.4.5 7.0.0 7.2.0

authorized-sgsns6 True True True True
handover-group6 - Handover SGSN/SGW IPv6 group. type: str more...

6.4.2 6.4.5 7.0.0 7.2.0

handover-group6 True True True True
invalid-sgsns6-to-log - Invalid SGSN IPv6 group to be logged. type: str more...

6.4.2 6.4.5 7.0.0 7.2.0

invalid-sgsns6-to-log True True True True
ie-validation type: dict

apn-restriction - Validate APN restriction. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

apn-restriction True True True
charging-ID - Validate charging ID. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

charging-ID True True True
charging-gateway-addr - Validate charging gateway address. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

charging-gateway-addr True True True
end-user-addr - Validate end user address. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

end-user-addr True True True
gsn-addr - Validate GSN address. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

gsn-addr True True True
imei - Validate IMEI(SV). type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

imei True True True
imsi - Validate IMSI. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

imsi True True True
mm-context - Validate MM context. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

mm-context True True True
ms-tzone - Validate MS time zone. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ms-tzone True True True
ms-validated - Validate MS validated. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

ms-validated True True True
msisdn - Validate MSISDN. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

msisdn True True True
nsapi - Validate NSAPI. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

nsapi True True True
pdp-context - Validate PDP context. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

pdp-context True True True
qos-profile - Validate Quality of Service(QoS) profile. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

qos-profile True True True
rai - Validate RAI. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

rai True True True
rat-type - Validate RAT type. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

rat-type True True True
reordering-required - Validate re-ordering required. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

reordering-required True True True
selection-mode - Validate selection mode. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

selection-mode True True True
uli - Validate user location information. type: str choices: [disable, enable] more...

6.4.5 7.0.0 7.2.0

uli True True True

message-rate-limit type: dict

create-aa-pdp-request - Rate limit for create AA PDP context request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

create-aa-pdp-request True True True
create-aa-pdp-response - Rate limit for create AA PDP context response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

create-aa-pdp-response True True True
create-mbms-request - Rate limit for create MBMS context request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

create-mbms-request True True True
create-mbms-response - Rate limit for create MBMS context response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

create-mbms-response True True True
create-pdp-request - Rate limit for create PDP context request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

create-pdp-request True True True
create-pdp-response - Rate limit for create PDP context response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

create-pdp-response True True True
delete-aa-pdp-request - Rate limit for delete AA PDP context request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

delete-aa-pdp-request True True True
delete-aa-pdp-response - Rate limit for delete AA PDP context response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

delete-aa-pdp-response True True True
delete-mbms-request - Rate limit for delete MBMS context request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

delete-mbms-request True True True
delete-mbms-response - Rate limit for delete MBMS context response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

delete-mbms-response True True True
delete-pdp-request - Rate limit for delete PDP context request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

delete-pdp-request True True True
delete-pdp-response - Rate limit for delete PDP context response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

delete-pdp-response True True True
echo-reponse - Rate limit for echo response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

echo-reponse True True True
echo-request - Rate limit for echo requests (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

echo-request True True True
error-indication - Rate limit for error indication (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

error-indication True True True
failure-report-request - Rate limit for failure report request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

failure-report-request True True True
failure-report-response - Rate limit for failure report response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

failure-report-response True True True
fwd-reloc-complete-ack - Rate limit for forward relocation complete acknowledge (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

fwd-reloc-complete-ack True True True
fwd-relocation-complete - Rate limit for forward relocation complete (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

fwd-relocation-complete True True True
fwd-relocation-request - Rate limit for forward relocation request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

fwd-relocation-request True True True
fwd-relocation-response - Rate limit for forward relocation response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

fwd-relocation-response True True True
fwd-srns-context - Rate limit for forward SRNS context (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

fwd-srns-context True True True
fwd-srns-context-ack - Rate limit for forward SRNS context acknowledge (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

fwd-srns-context-ack True True True
g-pdu - Rate limit for G-PDU (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

g-pdu True True True
identification-request - Rate limit for identification request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

identification-request True True True
identification-response - Rate limit for identification response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

identification-response True True True
mbms-de-reg-request - Rate limit for MBMS de-registration request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-de-reg-request True True True
mbms-de-reg-response - Rate limit for MBMS de-registration response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-de-reg-response True True True
mbms-notify-rej-request - Rate limit for MBMS notification reject request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-notify-rej-request True True True
mbms-notify-rej-response - Rate limit for MBMS notification reject response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-notify-rej-response True True True
mbms-notify-request - Rate limit for MBMS notification request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-notify-request True True True
mbms-notify-response - Rate limit for MBMS notification response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-notify-response True True True
mbms-reg-request - Rate limit for MBMS registration request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-reg-request True True True
mbms-reg-response - Rate limit for MBMS registration response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-reg-response True True True
mbms-ses-start-request - Rate limit for MBMS session start request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-ses-start-request True True True
mbms-ses-start-response - Rate limit for MBMS session start response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-ses-start-response True True True
mbms-ses-stop-request - Rate limit for MBMS session stop request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-ses-stop-request True True True
mbms-ses-stop-response - Rate limit for MBMS session stop response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

mbms-ses-stop-response True True True
note-ms-request - Rate limit for note MS GPRS present request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

note-ms-request True True True
note-ms-response - Rate limit for note MS GPRS present response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

note-ms-response True True True
pdu-notify-rej-request - Rate limit for PDU notify reject request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

pdu-notify-rej-request True True True
pdu-notify-rej-response - Rate limit for PDU notify reject response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

pdu-notify-rej-response True True True
pdu-notify-request - Rate limit for PDU notify request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

pdu-notify-request True True True
pdu-notify-response - Rate limit for PDU notify response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

pdu-notify-response True True True
ran-info - Rate limit for RAN information relay (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

ran-info True True True
relocation-cancel-request - Rate limit for relocation cancel request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

relocation-cancel-request True True True
relocation-cancel-response - Rate limit for relocation cancel response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

relocation-cancel-response True True True
send-route-request - Rate limit for send routing information for GPRS request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

send-route-request True True True
send-route-response - Rate limit for send routing information for GPRS response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

send-route-response True True True
sgsn-context-ack - Rate limit for SGSN context acknowledgement (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

sgsn-context-ack True True True
sgsn-context-request - Rate limit for SGSN context request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

sgsn-context-request True True True
sgsn-context-response - Rate limit for SGSN context response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

sgsn-context-response True True True
support-ext-hdr-notify - Rate limit for support extension headers notification (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

support-ext-hdr-notify True True True
update-mbms-request - Rate limit for update MBMS context request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

update-mbms-request True True True
update-mbms-response - Rate limit for update MBMS context response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

update-mbms-response True True True
update-pdp-request - Rate limit for update PDP context request (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

update-pdp-request True True True
update-pdp-response - Rate limit for update PDP context response (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

update-pdp-response True True True
version-not-support - Rate limit for version not supported (packets per second). type: int more...

6.4.5 7.0.0 7.2.0

version-not-support True True True

message-rate-limit-v0 type: dict

create-pdp-request - Rate limit (packets/s) for create PDP context request. type: int more...

6.4.5 7.0.0 7.2.0

create-pdp-request True True True
delete-pdp-request - Rate limit (packets/s) for delete PDP context request. type: int more...

6.4.5 7.0.0 7.2.0

delete-pdp-request True True True
echo-request - Rate limit (packets/s) for echo request. type: int more...

6.4.5 7.0.0 7.2.0

echo-request True True True

message-rate-limit-v1 type: dict

create-pdp-request - Rate limit (packets/s) for create PDP context request. type: int more...

6.4.5 7.0.0 7.2.0

create-pdp-request True True True
delete-pdp-request - Rate limit (packets/s) for delete PDP context request. type: int more...

6.4.5 7.0.0 7.2.0

delete-pdp-request True True True
echo-request - Rate limit (packets/s) for echo request. type: int more...

6.4.5 7.0.0 7.2.0

echo-request True True True

message-rate-limit-v2 type: dict

create-session-request - Rate limit (packets/s) for create session request. type: int more...

6.4.5 7.0.0 7.2.0

create-session-request True True True
delete-session-request - Rate limit (packets/s) for delete session request. type: int more...

6.4.5 7.0.0 7.2.0

delete-session-request True True True
echo-request - Rate limit (packets/s) for echo request. type: int more...

6.4.5 7.0.0 7.2.0

echo-request True True True

ie-allow-list-v0v1 - IE allow list. type: str more...

7.0.0 7.2.0

ie-allow-list-v0v1 True True
ie-allow-list-v2 - IE allow list. type: str more...

7.0.0 7.2.0

ie-allow-list-v2 True True
rat-timeout-profile - RAT timeout profile. type: str more...

7.2.0

rat-timeout-profile True

Notes ¶

Note

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 ¶

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure GTP.
     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: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the GTPs
     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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

request_url - The full url requested returned: always type: str sample: /sys/login/user
response_code - The status of api request returned: always type: int sample: 0
response_message - The descriptive message of the api response returned: always type: str sample: OK
response_data - The data body of the api response returned: optional type: list or dict

Status ¶

This module is not guaranteed to have a backwards compatible interface.

Authors ¶

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.