You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortimanager.fmgr_firewall_gtp_messageratelimit module – Message rate limiting.

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

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

New in version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis 

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

Parameters 

Parameter	Comments
adom string / required	the parameter (adom) in requested url
bypass_validation boolean	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices: no ← (default) yes
enable_log boolean	Enable/Disable logging for task Choices: no ← (default) yes
firewall_gtp_messageratelimit dictionary	the top level parameters set
create-aa-pdp-request integer	Rate limit for create AA PDP context request (packets per second).
create-aa-pdp-response integer	Rate limit for create AA PDP context response (packets per second).
create-mbms-request integer	Rate limit for create MBMS context request (packets per second).
create-mbms-response integer	Rate limit for create MBMS context response (packets per second).
create-pdp-request integer	Rate limit for create PDP context request (packets per second).
create-pdp-response integer	Rate limit for create PDP context response (packets per second).
delete-aa-pdp-request integer	Rate limit for delete AA PDP context request (packets per second).
delete-aa-pdp-response integer	Rate limit for delete AA PDP context response (packets per second).
delete-mbms-request integer	Rate limit for delete MBMS context request (packets per second).
delete-mbms-response integer	Rate limit for delete MBMS context response (packets per second).
delete-pdp-request integer	Rate limit for delete PDP context request (packets per second).
delete-pdp-response integer	Rate limit for delete PDP context response (packets per second).
echo-reponse integer	Rate limit for echo response (packets per second).
echo-request integer	Rate limit for echo requests (packets per second).
error-indication integer	Rate limit for error indication (packets per second).
failure-report-request integer	Rate limit for failure report request (packets per second).
failure-report-response integer	Rate limit for failure report response (packets per second).
fwd-reloc-complete-ack integer	Rate limit for forward relocation complete acknowledge (packets per second).
fwd-relocation-complete integer	Rate limit for forward relocation complete (packets per second).
fwd-relocation-request integer	Rate limit for forward relocation request (packets per second).
fwd-relocation-response integer	Rate limit for forward relocation response (packets per second).
fwd-srns-context integer	Rate limit for forward SRNS context (packets per second).
fwd-srns-context-ack integer	Rate limit for forward SRNS context acknowledge (packets per second).
g-pdu integer	Rate limit for G-PDU (packets per second).
identification-request integer	Rate limit for identification request (packets per second).
identification-response integer	Rate limit for identification response (packets per second).
mbms-de-reg-request integer	Rate limit for MBMS de-registration request (packets per second).
mbms-de-reg-response integer	Rate limit for MBMS de-registration response (packets per second).
mbms-notify-rej-request integer	Rate limit for MBMS notification reject request (packets per second).
mbms-notify-rej-response integer	Rate limit for MBMS notification reject response (packets per second).
mbms-notify-request integer	Rate limit for MBMS notification request (packets per second).
mbms-notify-response integer	Rate limit for MBMS notification response (packets per second).
mbms-reg-request integer	Rate limit for MBMS registration request (packets per second).
mbms-reg-response integer	Rate limit for MBMS registration response (packets per second).
mbms-ses-start-request integer	Rate limit for MBMS session start request (packets per second).
mbms-ses-start-response integer	Rate limit for MBMS session start response (packets per second).
mbms-ses-stop-request integer	Rate limit for MBMS session stop request (packets per second).
mbms-ses-stop-response integer	Rate limit for MBMS session stop response (packets per second).
note-ms-request integer	Rate limit for note MS GPRS present request (packets per second).
note-ms-response integer	Rate limit for note MS GPRS present response (packets per second).
pdu-notify-rej-request integer	Rate limit for PDU notify reject request (packets per second).
pdu-notify-rej-response integer	Rate limit for PDU notify reject response (packets per second).
pdu-notify-request integer	Rate limit for PDU notify request (packets per second).
pdu-notify-response integer	Rate limit for PDU notify response (packets per second).
ran-info integer	Rate limit for RAN information relay (packets per second).
relocation-cancel-request integer	Rate limit for relocation cancel request (packets per second).
relocation-cancel-response integer	Rate limit for relocation cancel response (packets per second).
send-route-request integer	Rate limit for send routing information for GPRS request (packets per second).
send-route-response integer	Rate limit for send routing information for GPRS response (packets per second).
sgsn-context-ack integer	Rate limit for SGSN context acknowledgement (packets per second).
sgsn-context-request integer	Rate limit for SGSN context request (packets per second).
sgsn-context-response integer	Rate limit for SGSN context response (packets per second).
support-ext-hdr-notify integer	Rate limit for support extension headers notification (packets per second).
update-mbms-request integer	Rate limit for update MBMS context request (packets per second).
update-mbms-response integer	Rate limit for update MBMS context response (packets per second).
update-pdp-request integer	Rate limit for update PDP context request (packets per second).
update-pdp-response integer	Rate limit for update PDP context response (packets per second).
version-not-support integer	Rate limit for version not supported (packets per second).
gtp string / required	the parameter (gtp) in requested url
proposed_method string	The overridden method for the underlying Json RPC request Choices: update set add
rc_failed list / elements=string	the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string	the rc codes list with which the conditions to succeed will be overriden
state string / required	the directive to create, update or delete an object Choices: present absent
workspace_locking_adom string	the adom to lock for FortiManager running in workspace mode, the value can be global and others including root
workspace_locking_timeout integer	the maximum time in seconds to wait for other user to release the workspace lock Default: 300

Notes 

Note

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: Message rate limiting.
     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 here, the following are the fields unique to this module:

Key	Description
request_url string	The full url requested Returned: always Sample: “/sys/login/user”
response_code integer	The status of api request Returned: always Sample: 0
response_message string	The descriptive message of the api response Returned: always Sample: “OK.”

Authors

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

Collection links

Issue Tracker Homepage Repository (Sources)

fortinet.fortimanager.fmgr_firewall_gtp_messageratelimit module – Message rate limiting.

Synopsis

Parameters

Notes

Examples

Return Values