fortinet.fortimanager.fmgr_firewall_gtp_messageratelimit module – Message rate limiting.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_gtp_messageratelimit.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Rate limit for create AA PDP context request |
|
Rate limit for create AA PDP context response |
|
Rate limit for create MBMS context request |
|
Rate limit for create MBMS context response |
|
Rate limit for create PDP context request |
|
Rate limit for create PDP context response |
|
Rate limit for delete AA PDP context request |
|
Rate limit for delete AA PDP context response |
|
Rate limit for delete MBMS context request |
|
Rate limit for delete MBMS context response |
|
Rate limit for delete PDP context request |
|
Rate limit for delete PDP context response |
|
Rate limit for echo response |
|
Rate limit for echo requests |
|
Rate limit for echo response |
|
Rate limit for error indication |
|
Rate limit for failure report request |
|
Rate limit for failure report response |
|
Rate limit for forward relocation complete acknowledge |
|
Rate limit for forward relocation complete |
|
Rate limit for forward relocation request |
|
Rate limit for forward relocation response |
|
Rate limit for forward SRNS context |
|
Rate limit for forward SRNS context acknowledge |
|
Rate limit for G-PDU |
|
Rate limit for identification request |
|
Rate limit for identification response |
|
Rate limit for MBMS de-registration request |
|
Rate limit for MBMS de-registration response |
|
Rate limit for MBMS notification reject request |
|
Rate limit for MBMS notification reject response |
|
Rate limit for MBMS notification request |
|
Rate limit for MBMS notification response |
|
Rate limit for MBMS registration request |
|
Rate limit for MBMS registration response |
|
Rate limit for MBMS session start request |
|
Rate limit for MBMS session start response |
|
Rate limit for MBMS session stop request |
|
Rate limit for MBMS session stop response |
|
Rate limit for note MS GPRS present request |
|
Rate limit for note MS GPRS present response |
|
Rate limit for PDU notify reject request |
|
Rate limit for PDU notify reject response |
|
Rate limit for PDU notify request |
|
Rate limit for PDU notify response |
|
Rate limit for RAN information relay |
|
Rate limit for relocation cancel request |
|
Rate limit for relocation cancel response |
|
Rate limit for send routing information for GPRS request |
|
Rate limit for send routing information for GPRS response |
|
Rate limit for SGSN context acknowledgement |
|
Rate limit for SGSN context request |
|
Rate limit for SGSN context response |
|
Rate limit for support extension headers notification |
|
Rate limit for update MBMS context request |
|
Rate limit for update MBMS context response |
|
Rate limit for update PDP context request |
|
Rate limit for update PDP context response |
|
Rate limit for version not supported |
|
Authenticate Ansible client with forticloud API access token. |
|
The parameter (gtp) in requested url. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Message rate limiting.
fortinet.fortimanager.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: <integer>
create_aa_pdp_response: <integer>
create_mbms_request: <integer>
create_mbms_response: <integer>
create_pdp_request: <integer>
create_pdp_response: <integer>
delete_aa_pdp_request: <integer>
delete_aa_pdp_response: <integer>
delete_mbms_request: <integer>
delete_mbms_response: <integer>
delete_pdp_request: <integer>
delete_pdp_response: <integer>
echo_reponse: <integer>
echo_request: <integer>
error_indication: <integer>
failure_report_request: <integer>
failure_report_response: <integer>
fwd_reloc_complete_ack: <integer>
fwd_relocation_complete: <integer>
fwd_relocation_request: <integer>
fwd_relocation_response: <integer>
fwd_srns_context: <integer>
fwd_srns_context_ack: <integer>
g_pdu: <integer>
identification_request: <integer>
identification_response: <integer>
mbms_de_reg_request: <integer>
mbms_de_reg_response: <integer>
mbms_notify_rej_request: <integer>
mbms_notify_rej_response: <integer>
mbms_notify_request: <integer>
mbms_notify_response: <integer>
mbms_reg_request: <integer>
mbms_reg_response: <integer>
mbms_ses_start_request: <integer>
mbms_ses_start_response: <integer>
mbms_ses_stop_request: <integer>
mbms_ses_stop_response: <integer>
note_ms_request: <integer>
note_ms_response: <integer>
pdu_notify_rej_request: <integer>
pdu_notify_rej_response: <integer>
pdu_notify_request: <integer>
pdu_notify_response: <integer>
ran_info: <integer>
relocation_cancel_request: <integer>
relocation_cancel_response: <integer>
send_route_request: <integer>
send_route_response: <integer>
sgsn_context_ack: <integer>
sgsn_context_request: <integer>
sgsn_context_response: <integer>
support_ext_hdr_notify: <integer>
update_mbms_request: <integer>
update_mbms_response: <integer>
update_pdp_request: <integer>
update_pdp_response: <integer>
version_not_support: <integer>
echo_response: <integer>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |