fmgr_firewall_gtp_messageratelimit – Message rate limiting.¶

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_messageratelimit	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
adom - The parameter in requested url type: str required: true
gtp - The parameter in requested url type: str required: true
firewall_gtp_messageratelimit - no description type: dict

create-aa-pdp-request - Rate limit for create AA PDP context request (packets per second). 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

create-aa-pdp-request True True True True True True True True True
create-aa-pdp-response - Rate limit for create AA PDP context response (packets per second). 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

create-aa-pdp-response True True True True True True True True True
create-mbms-request - Rate limit for create MBMS context request (packets per second). 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

create-mbms-request True True True True True True True True True
create-mbms-response - Rate limit for create MBMS context response (packets per second). 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

create-mbms-response True True True True True True True True True
create-pdp-request - Rate limit for create PDP context request (packets per second). 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

create-pdp-request True True True True True True True True True
create-pdp-response - Rate limit for create PDP context response (packets per second). 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

create-pdp-response True True True True True True True True True
delete-aa-pdp-request - Rate limit for delete AA PDP context request (packets per second). 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

delete-aa-pdp-request True True True True True True True True True
delete-aa-pdp-response - Rate limit for delete AA PDP context response (packets per second). 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

delete-aa-pdp-response True True True True True True True True True
delete-mbms-request - Rate limit for delete MBMS context request (packets per second). 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

delete-mbms-request True True True True True True True True True
delete-mbms-response - Rate limit for delete MBMS context response (packets per second). 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

delete-mbms-response True True True True True True True True True
delete-pdp-request - Rate limit for delete PDP context request (packets per second). 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

delete-pdp-request True True True True True True True True True
delete-pdp-response - Rate limit for delete PDP context response (packets per second). 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

delete-pdp-response True True True True True True True True True
echo-reponse - Rate limit for echo response (packets per second). 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-reponse True True True True True True True True True
echo-request - Rate limit for echo requests (packets per second). 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 True True True True True True True True True
error-indication - Rate limit for error indication (packets per second). 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

error-indication True True True True True True True True True
failure-report-request - Rate limit for failure report request (packets per second). 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

failure-report-request True True True True True True True True True
failure-report-response - Rate limit for failure report response (packets per second). 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

failure-report-response True True True True True True True True True
fwd-reloc-complete-ack - Rate limit for forward relocation complete acknowledge (packets per second). 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

fwd-reloc-complete-ack True True True True True True True True True
fwd-relocation-complete - Rate limit for forward relocation complete (packets per second). 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

fwd-relocation-complete True True True True True True True True True
fwd-relocation-request - Rate limit for forward relocation request (packets per second). 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

fwd-relocation-request True True True True True True True True True
fwd-relocation-response - Rate limit for forward relocation response (packets per second). 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

fwd-relocation-response True True True True True True True True True
fwd-srns-context - Rate limit for forward SRNS context (packets per second). 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

fwd-srns-context True True True True True True True True True
fwd-srns-context-ack - Rate limit for forward SRNS context acknowledge (packets per second). 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

fwd-srns-context-ack True True True True True True True True True
g-pdu - Rate limit for G-PDU (packets per second). 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

g-pdu True True True True True True True True True
identification-request - Rate limit for identification request (packets per second). 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

identification-request True True True True True True True True True
identification-response - Rate limit for identification response (packets per second). 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

identification-response True True True True True True True True True
mbms-de-reg-request - Rate limit for MBMS de-registration request (packets per second). 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

mbms-de-reg-request True True True True True True True True True
mbms-de-reg-response - Rate limit for MBMS de-registration response (packets per second). 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

mbms-de-reg-response True True True True True True True True True
mbms-notify-rej-request - Rate limit for MBMS notification reject request (packets per second). 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

mbms-notify-rej-request True True True True True True True True True
mbms-notify-rej-response - Rate limit for MBMS notification reject response (packets per second). 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

mbms-notify-rej-response True True True True True True True True True
mbms-notify-request - Rate limit for MBMS notification request (packets per second). 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

mbms-notify-request True True True True True True True True True
mbms-notify-response - Rate limit for MBMS notification response (packets per second). 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

mbms-notify-response True True True True True True True True True
mbms-reg-request - Rate limit for MBMS registration request (packets per second). 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

mbms-reg-request True True True True True True True True True
mbms-reg-response - Rate limit for MBMS registration response (packets per second). 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

mbms-reg-response True True True True True True True True True
mbms-ses-start-request - Rate limit for MBMS session start request (packets per second). 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

mbms-ses-start-request True True True True True True True True True
mbms-ses-start-response - Rate limit for MBMS session start response (packets per second). 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

mbms-ses-start-response True True True True True True True True True
mbms-ses-stop-request - Rate limit for MBMS session stop request (packets per second). 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

mbms-ses-stop-request True True True True True True True True True
mbms-ses-stop-response - Rate limit for MBMS session stop response (packets per second). 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

mbms-ses-stop-response True True True True True True True True True
note-ms-request - Rate limit for note MS GPRS present request (packets per second). 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

note-ms-request True True True True True True True True True
note-ms-response - Rate limit for note MS GPRS present response (packets per second). 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

note-ms-response True True True True True True True True True
pdu-notify-rej-request - Rate limit for PDU notify reject request (packets per second). 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

pdu-notify-rej-request True True True True True True True True True
pdu-notify-rej-response - Rate limit for PDU notify reject response (packets per second). 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

pdu-notify-rej-response True True True True True True True True True
pdu-notify-request - Rate limit for PDU notify request (packets per second). 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

pdu-notify-request True True True True True True True True True
pdu-notify-response - Rate limit for PDU notify response (packets per second). 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

pdu-notify-response True True True True True True True True True
ran-info - Rate limit for RAN information relay (packets per second). 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

ran-info True True True True True True True True True
relocation-cancel-request - Rate limit for relocation cancel request (packets per second). 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

relocation-cancel-request True True True True True True True True True
relocation-cancel-response - Rate limit for relocation cancel response (packets per second). 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

relocation-cancel-response True True True True True True True True True
send-route-request - Rate limit for send routing information for GPRS request (packets per second). 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

send-route-request True True True True True True True True True
send-route-response - Rate limit for send routing information for GPRS response (packets per second). 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

send-route-response True True True True True True True True True
sgsn-context-ack - Rate limit for SGSN context acknowledgement (packets per second). 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

sgsn-context-ack True True True True True True True True True
sgsn-context-request - Rate limit for SGSN context request (packets per second). 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

sgsn-context-request True True True True True True True True True
sgsn-context-response - Rate limit for SGSN context response (packets per second). 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

sgsn-context-response True True True True True True True True True
support-ext-hdr-notify - Rate limit for support extension headers notification (packets per second). 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

support-ext-hdr-notify True True True True True True True True True
update-mbms-request - Rate limit for update MBMS context request (packets per second). 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

update-mbms-request True True True True True True True True True
update-mbms-response - Rate limit for update MBMS context response (packets per second). 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

update-mbms-response True True True True True True True True True
update-pdp-request - Rate limit for update PDP context request (packets per second). 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

update-pdp-request True True True True True True True True True
update-pdp-response - Rate limit for update PDP context response (packets per second). 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

update-pdp-response True True True True True True True True True
version-not-support - Rate limit for version not supported (packets per second). 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-not-support True True True True True True True True 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: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: no description
     fmgr_firewall_gtp_messageratelimit:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        gtp: <your own value>
        firewall_gtp_messageratelimit:
           create-aa-pdp-request: <value of integer>
           create-aa-pdp-response: <value of integer>
           create-mbms-request: <value of integer>
           create-mbms-response: <value of integer>
           create-pdp-request: <value of integer>
           create-pdp-response: <value of integer>
           delete-aa-pdp-request: <value of integer>
           delete-aa-pdp-response: <value of integer>
           delete-mbms-request: <value of integer>
           delete-mbms-response: <value of integer>
           delete-pdp-request: <value of integer>
           delete-pdp-response: <value of integer>
           echo-reponse: <value of integer>
           echo-request: <value of integer>
           error-indication: <value of integer>
           failure-report-request: <value of integer>
           failure-report-response: <value of integer>
           fwd-reloc-complete-ack: <value of integer>
           fwd-relocation-complete: <value of integer>
           fwd-relocation-request: <value of integer>
           fwd-relocation-response: <value of integer>
           fwd-srns-context: <value of integer>
           fwd-srns-context-ack: <value of integer>
           g-pdu: <value of integer>
           identification-request: <value of integer>
           identification-response: <value of integer>
           mbms-de-reg-request: <value of integer>
           mbms-de-reg-response: <value of integer>
           mbms-notify-rej-request: <value of integer>
           mbms-notify-rej-response: <value of integer>
           mbms-notify-request: <value of integer>
           mbms-notify-response: <value of integer>
           mbms-reg-request: <value of integer>
           mbms-reg-response: <value of integer>
           mbms-ses-start-request: <value of integer>
           mbms-ses-start-response: <value of integer>
           mbms-ses-stop-request: <value of integer>
           mbms-ses-stop-response: <value of integer>
           note-ms-request: <value of integer>
           note-ms-response: <value of integer>
           pdu-notify-rej-request: <value of integer>
           pdu-notify-rej-response: <value of integer>
           pdu-notify-request: <value of integer>
           pdu-notify-response: <value of integer>
           ran-info: <value of integer>
           relocation-cancel-request: <value of integer>
           relocation-cancel-response: <value of integer>
           send-route-request: <value of integer>
           send-route-response: <value of integer>
           sgsn-context-ack: <value of integer>
           sgsn-context-request: <value of integer>
           sgsn-context-response: <value of integer>
           support-ext-hdr-notify: <value of integer>
           update-mbms-request: <value of integer>
           update-mbms-response: <value of integer>
           update-pdp-request: <value of integer>
           update-pdp-response: <value of integer>
           version-not-support: <value of integer>

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.