Try SpotterConfigure GTP.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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"
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
firewall_gtp:
description: The top level parameters set.
required: false
suboptions:
addr-notify:
description: Deprecated, please rename it to addr_notify. Overbilling notify address
type: str
apn:
description: Apn.
elements: dict
suboptions:
action:
choices:
- allow
- deny
description: Action.
type: str
apnmember:
description: (list or str) APN member.
type: raw
id:
description: ID.
type: int
selection-mode:
choices:
- ms
- net
- vrf
description: Deprecated, please rename it to selection_mode. APN selection
mode.
elements: str
type: list
type: list
apn-filter:
choices:
- disable
- enable
description: Deprecated, please rename it to apn_filter. Apn filter
type: str
authorized-ggsns:
description: Deprecated, please rename it to authorized_ggsns. Authorized GGSN
group
type: str
authorized-ggsns6:
description: Deprecated, please rename it to authorized_ggsns6. Authorized GGSN/PGW
IPv6 group.
type: str
authorized-sgsns:
description: Deprecated, please rename it to authorized_sgsns. Authorized SGSN
group
type: str
authorized-sgsns6:
description: Deprecated, please rename it to authorized_sgsns6. Authorized SGSN/SGW
IPv6 group.
type: str
comment:
description: Comment.
type: str
context-id:
description: Deprecated, please rename it to context_id. Overbilling context.
type: int
control-plane-message-rate-limit:
description: Deprecated, please rename it to control_plane_message_rate_limit.
Control plane message rate limit
type: int
default-apn-action:
choices:
- allow
- deny
description: Deprecated, please rename it to default_apn_action. Default apn action
type: str
default-imsi-action:
choices:
- allow
- deny
description: Deprecated, please rename it to default_imsi_action. Default imsi
action
type: str
default-ip-action:
choices:
- allow
- deny
description: Deprecated, please rename it to default_ip_action. Default action
for encapsulated IP traffic
type: str
default-noip-action:
choices:
- allow
- deny
description: Deprecated, please rename it to default_noip_action. Default action
for encapsulated non-IP traffic
type: str
default-policy-action:
choices:
- allow
- deny
description: Deprecated, please rename it to default_policy_action. Default advanced
policy action
type: str
denied-log:
choices:
- disable
- enable
description: Deprecated, please rename it to denied_log. Log denied
type: str
echo-request-interval:
description: Deprecated, please rename it to echo_request_interval. Echo request
interval
type: int
extension-log:
choices:
- disable
- enable
description: Deprecated, please rename it to extension_log. Log in extension format
type: str
forwarded-log:
choices:
- disable
- enable
description: Deprecated, please rename it to forwarded_log. Log forwarded
type: str
global-tunnel-limit:
description: Deprecated, please rename it to global_tunnel_limit. Global tunnel
limit.
type: str
gtp-in-gtp:
choices:
- allow
- deny
description: Deprecated, please rename it to gtp_in_gtp. Gtp in gtp
type: str
gtpu-denied-log:
choices:
- disable
- enable
description: Deprecated, please rename it to gtpu_denied_log. Enable/disable logging
of denied GTP-U packets.
type: str
gtpu-forwarded-log:
choices:
- disable
- enable
description: Deprecated, please rename it to gtpu_forwarded_log. Enable/disable
logging of forwarded GTP-U packets.
type: str
gtpu-log-freq:
description: Deprecated, please rename it to gtpu_log_freq. Logging of frequency
of GTP-U packets.
type: int
half-close-timeout:
description: Deprecated, please rename it to half_close_timeout. Half-close tunnel
timeout
type: int
half-open-timeout:
description: Deprecated, please rename it to half_open_timeout. Half-open tunnel
timeout
type: int
handover-group:
description: Deprecated, please rename it to handover_group. Handover SGSN group
type: str
handover-group6:
description: Deprecated, please rename it to handover_group6. Handover SGSN/SGW
IPv6 group.
type: str
ie-allow-list-v0v1:
description: Deprecated, please rename it to ie_allow_list_v0v1. IE allow list.
type: str
ie-allow-list-v2:
description: Deprecated, please rename it to ie_allow_list_v2. IE allow list.
type: str
ie-remove-policy:
description: Deprecated, please rename it to ie_remove_policy. Ie-Remove-Policy.
elements: dict
suboptions:
id:
description: ID.
type: int
remove-ies:
choices:
- apn-restriction
- rat-type
- rai
- uli
- imei
description: Deprecated, please rename it to remove_ies. GTP IEs to be removed.
elements: str
type: list
sgsn-addr:
description: Deprecated, please rename it to sgsn_addr. SGSN address name.
type: str
sgsn-addr6:
description: Deprecated, please rename it to sgsn_addr6. SGSN IPv6 address
name.
type: str
type: list
ie-remover:
choices:
- disable
- enable
description: Deprecated, please rename it to ie_remover. IE removal policy.
type: str
ie-validation:
description: Deprecated, please rename it to ie_validation.
suboptions:
apn-restriction:
choices:
- disable
- enable
description: Deprecated, please rename it to apn_restriction. Validate APN
restriction.
type: str
charging-ID:
choices:
- disable
- enable
description: Deprecated, please rename it to charging_ID. Validate charging
ID.
type: str
charging-gateway-addr:
choices:
- disable
- enable
description: Deprecated, please rename it to charging_gateway_addr. Validate
charging gateway address.
type: str
end-user-addr:
choices:
- disable
- enable
description: Deprecated, please rename it to end_user_addr. Validate end user
address.
type: str
gsn-addr:
choices:
- disable
- enable
description: Deprecated, please rename it to gsn_addr. Validate GSN address.
type: str
imei:
choices:
- disable
- enable
description: Validate IMEI
type: str
imsi:
choices:
- disable
- enable
description: Validate IMSI.
type: str
mm-context:
choices:
- disable
- enable
description: Deprecated, please rename it to mm_context. Validate MM context.
type: str
ms-tzone:
choices:
- disable
- enable
description: Deprecated, please rename it to ms_tzone. Validate MS time zone.
type: str
ms-validated:
choices:
- disable
- enable
description: Deprecated, please rename it to ms_validated. Validate MS validated.
type: str
msisdn:
choices:
- disable
- enable
description: Validate MSISDN.
type: str
nsapi:
choices:
- disable
- enable
description: Validate NSAPI.
type: str
pdp-context:
choices:
- disable
- enable
description: Deprecated, please rename it to pdp_context. Validate PDP context.
type: str
qos-profile:
choices:
- disable
- enable
description: Deprecated, please rename it to qos_profile. Validate Quality
of Service
type: str
rai:
choices:
- disable
- enable
description: Validate RAI.
type: str
rat-type:
choices:
- disable
- enable
description: Deprecated, please rename it to rat_type. Validate RAT type.
type: str
reordering-required:
choices:
- disable
- enable
description: Deprecated, please rename it to reordering_required. Validate
re-ordering required.
type: str
selection-mode:
choices:
- disable
- enable
description: Deprecated, please rename it to selection_mode. Validate selection
mode.
type: str
uli:
choices:
- disable
- enable
description: Validate user location information.
type: str
type: dict
ie-white-list-v0v1:
description: Deprecated, please rename it to ie_white_list_v0v1. IE white list.
type: str
ie-white-list-v2:
description: Deprecated, please rename it to ie_white_list_v2. IE white list.
type: str
imsi:
description: Imsi.
elements: dict
suboptions:
action:
choices:
- allow
- deny
description: Action.
type: str
apnmember:
description: (list or str) APN member.
type: raw
id:
description: ID.
type: int
mcc-mnc:
description: Deprecated, please rename it to mcc_mnc. MCC MNC.
type: str
msisdn-prefix:
description: Deprecated, please rename it to msisdn_prefix. MSISDN prefix.
type: str
selection-mode:
choices:
- ms
- net
- vrf
description: Deprecated, please rename it to selection_mode. APN selection
mode.
elements: str
type: list
type: list
imsi-filter:
choices:
- disable
- enable
description: Deprecated, please rename it to imsi_filter. Imsi filter
type: str
interface-notify:
description: Deprecated, please rename it to interface_notify. Overbilling interface
type: str
invalid-reserved-field:
choices:
- allow
- deny
description: Deprecated, please rename it to invalid_reserved_field. Invalid reserved
field in GTP header
type: str
invalid-sgsns-to-log:
description: Deprecated, please rename it to invalid_sgsns_to_log. Invalid SGSN
group to be logged
type: str
invalid-sgsns6-to-log:
description: Deprecated, please rename it to invalid_sgsns6_to_log. Invalid SGSN
IPv6 group to be logged.
type: str
ip-filter:
choices:
- disable
- enable
description: Deprecated, please rename it to ip_filter. IP filter for encapsulted
traffic
type: str
ip-policy:
description: Deprecated, please rename it to ip_policy. Ip-Policy.
elements: dict
suboptions:
action:
choices:
- allow
- deny
description: Action.
type: str
dstaddr:
description: Destination address name.
type: str
dstaddr6:
description: Destination IPv6 address name.
type: str
id:
description: ID.
type: int
srcaddr:
description: Source address name.
type: str
srcaddr6:
description: Source IPv6 address name.
type: str
type: list
log-freq:
description: Deprecated, please rename it to log_freq. Logging of frequency of
GTP-C packets.
type: int
log-gtpu-limit:
description: Deprecated, please rename it to log_gtpu_limit. The user data log
limit
type: int
log-imsi-prefix:
description: Deprecated, please rename it to log_imsi_prefix. IMSI prefix for
selective logging.
type: str
log-msisdn-prefix:
description: Deprecated, please rename it to log_msisdn_prefix. The msisdn prefix
for selective logging
type: str
max-message-length:
description: Deprecated, please rename it to max_message_length. Max message length
type: int
message-filter:
description: Deprecated, please rename it to message_filter.
suboptions:
create-aa-pdp:
choices:
- allow
- deny
description: Deprecated, please rename it to create_aa_pdp. Create AA PDP.
type: str
create-mbms:
choices:
- allow
- deny
description: Deprecated, please rename it to create_mbms. Create MBMS.
type: str
create-pdp:
choices:
- allow
- deny
description: Deprecated, please rename it to create_pdp. Create PDP.
type: str
data-record:
choices:
- allow
- deny
description: Deprecated, please rename it to data_record. Data record.
type: str
delete-aa-pdp:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_aa_pdp. Delete AA PDP.
type: str
delete-mbms:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_mbms. Delete MBMS.
type: str
delete-pdp:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_pdp. Delete PDP.
type: str
echo:
choices:
- allow
- deny
description: Echo.
type: str
error-indication:
choices:
- allow
- deny
description: Deprecated, please rename it to error_indication. Error indication.
type: str
failure-report:
choices:
- allow
- deny
description: Deprecated, please rename it to failure_report. Failure report.
type: str
fwd-relocation:
choices:
- allow
- deny
description: Deprecated, please rename it to fwd_relocation. Forward relocation.
type: str
fwd-srns-context:
choices:
- allow
- deny
description: Deprecated, please rename it to fwd_srns_context. Forward SRNS
context.
type: str
gtp-pdu:
choices:
- allow
- deny
description: Deprecated, please rename it to gtp_pdu. GTP PDU.
type: str
identification:
choices:
- allow
- deny
description: Identification.
type: str
mbms-notification:
choices:
- allow
- deny
description: Deprecated, please rename it to mbms_notification. MBMS notification.
type: str
node-alive:
choices:
- allow
- deny
description: Deprecated, please rename it to node_alive. Node alive.
type: str
note-ms-present:
choices:
- allow
- deny
description: Deprecated, please rename it to note_ms_present. Note MS present.
type: str
pdu-notification:
choices:
- allow
- deny
description: Deprecated, please rename it to pdu_notification. PDU notification.
type: str
ran-info:
choices:
- allow
- deny
description: Deprecated, please rename it to ran_info. Ran info.
type: str
redirection:
choices:
- allow
- deny
description: Redirection.
type: str
relocation-cancel:
choices:
- allow
- deny
description: Deprecated, please rename it to relocation_cancel. Relocation
cancel.
type: str
send-route:
choices:
- allow
- deny
description: Deprecated, please rename it to send_route. Send route.
type: str
sgsn-context:
choices:
- allow
- deny
description: Deprecated, please rename it to sgsn_context. SGSN context.
type: str
support-extension:
choices:
- allow
- deny
description: Deprecated, please rename it to support_extension. Support extension.
type: str
unknown-message-action:
choices:
- allow
- deny
description: Deprecated, please rename it to unknown_message_action. Unknown
message action.
type: str
update-mbms:
choices:
- allow
- deny
description: Deprecated, please rename it to update_mbms. Update MBMS.
type: str
update-pdp:
choices:
- allow
- deny
description: Deprecated, please rename it to update_pdp. Update PDP.
type: str
version-not-support:
choices:
- allow
- deny
description: Deprecated, please rename it to version_not_support. Version
not supported.
type: str
type: dict
message-filter-v0v1:
description: Deprecated, please rename it to message_filter_v0v1. Message filter.
type: str
message-filter-v2:
description: Deprecated, please rename it to message_filter_v2. Message filter.
type: str
message-rate-limit:
description: Deprecated, please rename it to message_rate_limit.
suboptions:
create-aa-pdp-request:
description: Deprecated, please rename it to create_aa_pdp_request. Rate limit
for create AA PDP context request
type: int
create-aa-pdp-response:
description: Deprecated, please rename it to create_aa_pdp_response. Rate
limit for create AA PDP context response
type: int
create-mbms-request:
description: Deprecated, please rename it to create_mbms_request. Rate limit
for create MBMS context request
type: int
create-mbms-response:
description: Deprecated, please rename it to create_mbms_response. Rate limit
for create MBMS context response
type: int
create-pdp-request:
description: Deprecated, please rename it to create_pdp_request. Rate limit
for create PDP context request
type: int
create-pdp-response:
description: Deprecated, please rename it to create_pdp_response. Rate limit
for create PDP context response
type: int
delete-aa-pdp-request:
description: Deprecated, please rename it to delete_aa_pdp_request. Rate limit
for delete AA PDP context request
type: int
delete-aa-pdp-response:
description: Deprecated, please rename it to delete_aa_pdp_response. Rate
limit for delete AA PDP context response
type: int
delete-mbms-request:
description: Deprecated, please rename it to delete_mbms_request. Rate limit
for delete MBMS context request
type: int
delete-mbms-response:
description: Deprecated, please rename it to delete_mbms_response. Rate limit
for delete MBMS context response
type: int
delete-pdp-request:
description: Deprecated, please rename it to delete_pdp_request. Rate limit
for delete PDP context request
type: int
delete-pdp-response:
description: Deprecated, please rename it to delete_pdp_response. Rate limit
for delete PDP context response
type: int
echo-reponse:
description: Deprecated, please rename it to echo_reponse. Rate limit for
echo response
type: int
echo-request:
description: Deprecated, please rename it to echo_request. Rate limit for
echo requests
type: int
error-indication:
description: Deprecated, please rename it to error_indication. Rate limit
for error indication
type: int
failure-report-request:
description: Deprecated, please rename it to failure_report_request. Rate
limit for failure report request
type: int
failure-report-response:
description: Deprecated, please rename it to failure_report_response. Rate
limit for failure report response
type: int
fwd-reloc-complete-ack:
description: Deprecated, please rename it to fwd_reloc_complete_ack. Rate
limit for forward relocation complete acknowledge
type: int
fwd-relocation-complete:
description: Deprecated, please rename it to fwd_relocation_complete. Rate
limit for forward relocation complete
type: int
fwd-relocation-request:
description: Deprecated, please rename it to fwd_relocation_request. Rate
limit for forward relocation request
type: int
fwd-relocation-response:
description: Deprecated, please rename it to fwd_relocation_response. Rate
limit for forward relocation response
type: int
fwd-srns-context:
description: Deprecated, please rename it to fwd_srns_context. Rate limit
for forward SRNS context
type: int
fwd-srns-context-ack:
description: Deprecated, please rename it to fwd_srns_context_ack. Rate limit
for forward SRNS context acknowledge
type: int
g-pdu:
description: Deprecated, please rename it to g_pdu. Rate limit for G-PDU
type: int
identification-request:
description: Deprecated, please rename it to identification_request. Rate
limit for identification request
type: int
identification-response:
description: Deprecated, please rename it to identification_response. Rate
limit for identification response
type: int
mbms-de-reg-request:
description: Deprecated, please rename it to mbms_de_reg_request. Rate limit
for MBMS de-registration request
type: int
mbms-de-reg-response:
description: Deprecated, please rename it to mbms_de_reg_response. Rate limit
for MBMS de-registration response
type: int
mbms-notify-rej-request:
description: Deprecated, please rename it to mbms_notify_rej_request. Rate
limit for MBMS notification reject request
type: int
mbms-notify-rej-response:
description: Deprecated, please rename it to mbms_notify_rej_response. Rate
limit for MBMS notification reject response
type: int
mbms-notify-request:
description: Deprecated, please rename it to mbms_notify_request. Rate limit
for MBMS notification request
type: int
mbms-notify-response:
description: Deprecated, please rename it to mbms_notify_response. Rate limit
for MBMS notification response
type: int
mbms-reg-request:
description: Deprecated, please rename it to mbms_reg_request. Rate limit
for MBMS registration request
type: int
mbms-reg-response:
description: Deprecated, please rename it to mbms_reg_response. Rate limit
for MBMS registration response
type: int
mbms-ses-start-request:
description: Deprecated, please rename it to mbms_ses_start_request. Rate
limit for MBMS session start request
type: int
mbms-ses-start-response:
description: Deprecated, please rename it to mbms_ses_start_response. Rate
limit for MBMS session start response
type: int
mbms-ses-stop-request:
description: Deprecated, please rename it to mbms_ses_stop_request. Rate limit
for MBMS session stop request
type: int
mbms-ses-stop-response:
description: Deprecated, please rename it to mbms_ses_stop_response. Rate
limit for MBMS session stop response
type: int
note-ms-request:
description: Deprecated, please rename it to note_ms_request. Rate limit for
note MS GPRS present request
type: int
note-ms-response:
description: Deprecated, please rename it to note_ms_response. Rate limit
for note MS GPRS present response
type: int
pdu-notify-rej-request:
description: Deprecated, please rename it to pdu_notify_rej_request. Rate
limit for PDU notify reject request
type: int
pdu-notify-rej-response:
description: Deprecated, please rename it to pdu_notify_rej_response. Rate
limit for PDU notify reject response
type: int
pdu-notify-request:
description: Deprecated, please rename it to pdu_notify_request. Rate limit
for PDU notify request
type: int
pdu-notify-response:
description: Deprecated, please rename it to pdu_notify_response. Rate limit
for PDU notify response
type: int
ran-info:
description: Deprecated, please rename it to ran_info. Rate limit for RAN
information relay
type: int
relocation-cancel-request:
description: Deprecated, please rename it to relocation_cancel_request. Rate
limit for relocation cancel request
type: int
relocation-cancel-response:
description: Deprecated, please rename it to relocation_cancel_response. Rate
limit for relocation cancel response
type: int
send-route-request:
description: Deprecated, please rename it to send_route_request. Rate limit
for send routing information for GPRS request
type: int
send-route-response:
description: Deprecated, please rename it to send_route_response. Rate limit
for send routing information for GPRS response
type: int
sgsn-context-ack:
description: Deprecated, please rename it to sgsn_context_ack. Rate limit
for SGSN context acknowledgement
type: int
sgsn-context-request:
description: Deprecated, please rename it to sgsn_context_request. Rate limit
for SGSN context request
type: int
sgsn-context-response:
description: Deprecated, please rename it to sgsn_context_response. Rate limit
for SGSN context response
type: int
support-ext-hdr-notify:
description: Deprecated, please rename it to support_ext_hdr_notify. Rate
limit for support extension headers notification
type: int
update-mbms-request:
description: Deprecated, please rename it to update_mbms_request. Rate limit
for update MBMS context request
type: int
update-mbms-response:
description: Deprecated, please rename it to update_mbms_response. Rate limit
for update MBMS context response
type: int
update-pdp-request:
description: Deprecated, please rename it to update_pdp_request. Rate limit
for update PDP context request
type: int
update-pdp-response:
description: Deprecated, please rename it to update_pdp_response. Rate limit
for update PDP context response
type: int
version-not-support:
description: Deprecated, please rename it to version_not_support. Rate limit
for version not supported
type: int
type: dict
message-rate-limit-v0:
description: Deprecated, please rename it to message_rate_limit_v0.
suboptions:
create-pdp-request:
description: Deprecated, please rename it to create_pdp_request. Rate limit
type: int
delete-pdp-request:
description: Deprecated, please rename it to delete_pdp_request. Rate limit
type: int
echo-request:
description: Deprecated, please rename it to echo_request. Rate limit
type: int
type: dict
message-rate-limit-v1:
description: Deprecated, please rename it to message_rate_limit_v1.
suboptions:
create-pdp-request:
description: Deprecated, please rename it to create_pdp_request. Rate limit
type: int
delete-pdp-request:
description: Deprecated, please rename it to delete_pdp_request. Rate limit
type: int
echo-request:
description: Deprecated, please rename it to echo_request. Rate limit
type: int
type: dict
message-rate-limit-v2:
description: Deprecated, please rename it to message_rate_limit_v2.
suboptions:
create-session-request:
description: Deprecated, please rename it to create_session_request. Rate
limit
type: int
delete-session-request:
description: Deprecated, please rename it to delete_session_request. Rate
limit
type: int
echo-request:
description: Deprecated, please rename it to echo_request. Rate limit
type: int
type: dict
min-message-length:
description: Deprecated, please rename it to min_message_length. Min message length
type: int
miss-must-ie:
choices:
- allow
- deny
description: Deprecated, please rename it to miss_must_ie. Missing mandatory information
element
type: str
monitor-mode:
choices:
- disable
- enable
- vdom
description: Deprecated, please rename it to monitor_mode. GTP monitor mode
type: str
name:
description: Profile name.
required: true
type: str
noip-filter:
choices:
- disable
- enable
description: Deprecated, please rename it to noip_filter. Non-IP filter for encapsulted
traffic
type: str
noip-policy:
description: Deprecated, please rename it to noip_policy. Noip-Policy.
elements: dict
suboptions:
action:
choices:
- allow
- deny
description: Action.
type: str
end:
description: End of protocol range
type: int
id:
description: ID.
type: int
start:
description: Start of protocol range
type: int
type:
choices:
- etsi
- ietf
description: Protocol field type.
type: str
type: list
out-of-state-ie:
choices:
- allow
- deny
description: Deprecated, please rename it to out_of_state_ie. Out of state information
element.
type: str
out-of-state-message:
choices:
- allow
- deny
description: Deprecated, please rename it to out_of_state_message. Out of state
GTP message
type: str
per-apn-shaper:
description: Deprecated, please rename it to per_apn_shaper. Per-Apn-Shaper.
elements: dict
suboptions:
apn:
description: APN name.
type: str
id:
description: ID.
type: int
rate-limit:
description: Deprecated, please rename it to rate_limit. Rate limit
type: int
version:
description: GTP version number
type: int
type: list
policy:
description: Policy.
elements: dict
suboptions:
action:
choices:
- allow
- deny
description: Action.
type: str
apn:
description: APN subfix.
type: str
apn-sel-mode:
choices:
- ms
- net
- vrf
description: Deprecated, please rename it to apn_sel_mode. APN selection mode.
elements: str
type: list
apnmember:
description: (list or str) APN member.
type: raw
id:
description: ID.
type: int
imei:
description: IMEI
type: str
imsi:
description: IMSI prefix.
type: str
imsi-prefix:
description: Deprecated, please rename it to imsi_prefix. IMSI prefix.
type: str
max-apn-restriction:
choices:
- all
- public-1
- public-2
- private-1
- private-2
description: Deprecated, please rename it to max_apn_restriction. Maximum
APN restriction value.
type: str
messages:
choices:
- create-req
- create-res
- update-req
- update-res
description: GTP messages.
elements: str
type: list
msisdn:
description: MSISDN prefix.
type: str
msisdn-prefix:
description: Deprecated, please rename it to msisdn_prefix. MSISDN prefix.
type: str
rai:
description: RAI pattern.
type: str
rat-type:
choices:
- any
- utran
- geran
- wlan
- gan
- hspa
- eutran
- virtual
- nbiot
description: Deprecated, please rename it to rat_type. RAT Type.
elements: str
type: list
uli:
description: ULI pattern.
type: str
type: list
policy-filter:
choices:
- disable
- enable
description: Deprecated, please rename it to policy_filter. Advanced policy filter
type: str
policy-v2:
description: Deprecated, please rename it to policy_v2. Policy-V2.
elements: dict
suboptions:
action:
choices:
- deny
- allow
description: Action.
type: str
apn-sel-mode:
choices:
- ms
- net
- vrf
description: Deprecated, please rename it to apn_sel_mode. APN selection mode.
elements: str
type: list
apnmember:
description: (list or str) APN member.
type: raw
id:
description: ID.
type: int
imsi-prefix:
description: Deprecated, please rename it to imsi_prefix. IMSI prefix.
type: str
max-apn-restriction:
choices:
- all
- public-1
- public-2
- private-1
- private-2
description: Deprecated, please rename it to max_apn_restriction. Maximum
APN restriction value.
type: str
mei:
description: MEI pattern.
type: str
messages:
choices:
- create-ses-req
- create-ses-res
- modify-bearer-req
- modify-bearer-res
description: GTP messages.
elements: str
type: list
msisdn-prefix:
description: Deprecated, please rename it to msisdn_prefix. MSISDN prefix.
type: str
rat-type:
choices:
- any
- utran
- geran
- wlan
- gan
- hspa
- eutran
- virtual
- nbiot
- ltem
- nr
description: Deprecated, please rename it to rat_type. RAT Type.
elements: str
type: list
uli:
description: (list) GTPv2 ULI patterns
type: raw
type: list
port-notify:
description: Deprecated, please rename it to port_notify. Overbilling notify port
type: int
rat-timeout-profile:
description: Deprecated, please rename it to rat_timeout_profile. RAT timeout
profile.
type: str
rate-limit-mode:
choices:
- per-profile
- per-stream
- per-apn
description: Deprecated, please rename it to rate_limit_mode. GTP rate limit mode.
type: str
rate-limited-log:
choices:
- disable
- enable
description: Deprecated, please rename it to rate_limited_log. Log rate limited
type: str
rate-sampling-interval:
description: Deprecated, please rename it to rate_sampling_interval. Rate sampling
interval
type: int
remove-if-echo-expires:
choices:
- disable
- enable
description: Deprecated, please rename it to remove_if_echo_expires. Remove if
echo response expires
type: str
remove-if-recovery-differ:
choices:
- disable
- enable
description: Deprecated, please rename it to remove_if_recovery_differ. Remove
upon different Recovery IE
type: str
reserved-ie:
choices:
- allow
- deny
description: Deprecated, please rename it to reserved_ie. Reserved information
element
type: str
send-delete-when-timeout:
choices:
- disable
- enable
description: Deprecated, please rename it to send_delete_when_timeout. Send DELETE
request to path endpoints when GTPv0/v1 tunnel timeout.
type: str
send-delete-when-timeout-v2:
choices:
- disable
- enable
description: Deprecated, please rename it to send_delete_when_timeout_v2. Send
DELETE request to path endpoints when GTPv2 tunnel timeout.
type: str
spoof-src-addr:
choices:
- allow
- deny
description: Deprecated, please rename it to spoof_src_addr. Spoofed source address
for Mobile Station.
type: str
state-invalid-log:
choices:
- disable
- enable
description: Deprecated, please rename it to state_invalid_log. Log state invalid
type: str
sub-second-interval:
choices:
- '0.1'
- '0.25'
- '0.5'
description: Deprecated, please rename it to sub_second_interval. Sub-second interval
type: str
sub-second-sampling:
choices:
- disable
- enable
description: Deprecated, please rename it to sub_second_sampling. Enable/disable
sub-second sampling.
type: str
traffic-count-log:
choices:
- disable
- enable
description: Deprecated, please rename it to traffic_count_log. Log tunnel traffic
counter
type: str
tunnel-limit:
description: Deprecated, please rename it to tunnel_limit. Tunnel limit
type: int
tunnel-limit-log:
choices:
- disable
- enable
description: Deprecated, please rename it to tunnel_limit_log. Tunnel limit
type: str
tunnel-timeout:
description: Deprecated, please rename it to tunnel_timeout. Established tunnel
timeout
type: int
unknown-version-action:
choices:
- allow
- deny
description: Deprecated, please rename it to unknown_version_action. Action for
unknown gtp version
type: str
user-plane-message-rate-limit:
description: Deprecated, please rename it to user_plane_message_rate_limit. User
plane message rate limit
type: int
warning-threshold:
description: Deprecated, please rename it to warning_threshold. Warning threshold
for rate limiting
type: int
type: dict
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list