fmgr_firewall_gtp_messageratelimit – Message rate limiting.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

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.

  • Tested with FortiManager v6.x and v7.x.

Requirements

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

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • 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
  • 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
  • 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
  • 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
  • adom - The parameter in requested url type: str required: true
  • gtp - The parameter in requested url type: str required: true
  • firewall_gtp_messageratelimit - Message rate limiting. type: dict
    • create_aa_pdp_request (Alias name: create-aa-pdp-request) Rate limit for create aa pdp context request (packets per second). type: int more...
    • create_aa_pdp_response (Alias name: create-aa-pdp-response) Rate limit for create aa pdp context response (packets per second). type: int more...
    • create_mbms_request (Alias name: create-mbms-request) Rate limit for create mbms context request (packets per second). type: int more...
    • create_mbms_response (Alias name: create-mbms-response) Rate limit for create mbms context response (packets per second). type: int more...
    • create_pdp_request (Alias name: create-pdp-request) Rate limit for create pdp context request (packets per second). type: int more...
    • create_pdp_response (Alias name: create-pdp-response) Rate limit for create pdp context response (packets per second). type: int more...
    • delete_aa_pdp_request (Alias name: delete-aa-pdp-request) Rate limit for delete aa pdp context request (packets per second). type: int more...
    • delete_aa_pdp_response (Alias name: delete-aa-pdp-response) Rate limit for delete aa pdp context response (packets per second). type: int more...
    • delete_mbms_request (Alias name: delete-mbms-request) Rate limit for delete mbms context request (packets per second). type: int more...
    • delete_mbms_response (Alias name: delete-mbms-response) Rate limit for delete mbms context response (packets per second). type: int more...
    • delete_pdp_request (Alias name: delete-pdp-request) Rate limit for delete pdp context request (packets per second). type: int more...
    • delete_pdp_response (Alias name: delete-pdp-response) Rate limit for delete pdp context response (packets per second). type: int more...
    • echo_reponse (Alias name: echo-reponse) Rate limit for echo response (packets per second). type: int more...
    • echo_request (Alias name: echo-request) Rate limit for echo requests (packets per second). type: int more...
    • error_indication (Alias name: error-indication) Rate limit for error indication (packets per second). type: int more...
    • failure_report_request (Alias name: failure-report-request) Rate limit for failure report request (packets per second). type: int more...
    • failure_report_response (Alias name: failure-report-response) Rate limit for failure report response (packets per second). type: int more...
    • fwd_reloc_complete_ack (Alias name: fwd-reloc-complete-ack) Rate limit for forward relocation complete acknowledge (packets per second). type: int more...
    • fwd_relocation_complete (Alias name: fwd-relocation-complete) Rate limit for forward relocation complete (packets per second). type: int more...
    • fwd_relocation_request (Alias name: fwd-relocation-request) Rate limit for forward relocation request (packets per second). type: int more...
    • fwd_relocation_response (Alias name: fwd-relocation-response) Rate limit for forward relocation response (packets per second). type: int more...
    • fwd_srns_context (Alias name: fwd-srns-context) Rate limit for forward srns context (packets per second). type: int more...
    • fwd_srns_context_ack (Alias name: fwd-srns-context-ack) Rate limit for forward srns context acknowledge (packets per second). type: int more...
    • g_pdu (Alias name: g-pdu) Rate limit for g-pdu (packets per second). type: int more...
    • identification_request (Alias name: identification-request) Rate limit for identification request (packets per second). type: int more...
    • identification_response (Alias name: identification-response) Rate limit for identification response (packets per second). type: int more...
    • mbms_de_reg_request (Alias name: mbms-de-reg-request) Rate limit for mbms de-registration request (packets per second). type: int more...
    • mbms_de_reg_response (Alias name: mbms-de-reg-response) Rate limit for mbms de-registration response (packets per second). type: int more...
    • mbms_notify_rej_request (Alias name: mbms-notify-rej-request) Rate limit for mbms notification reject request (packets per second). type: int more...
    • mbms_notify_rej_response (Alias name: mbms-notify-rej-response) Rate limit for mbms notification reject response (packets per second). type: int more...
    • mbms_notify_request (Alias name: mbms-notify-request) Rate limit for mbms notification request (packets per second). type: int more...
    • mbms_notify_response (Alias name: mbms-notify-response) Rate limit for mbms notification response (packets per second). type: int more...
    • mbms_reg_request (Alias name: mbms-reg-request) Rate limit for mbms registration request (packets per second). type: int more...
    • mbms_reg_response (Alias name: mbms-reg-response) Rate limit for mbms registration response (packets per second). type: int more...
    • mbms_ses_start_request (Alias name: mbms-ses-start-request) Rate limit for mbms session start request (packets per second). type: int more...
    • mbms_ses_start_response (Alias name: mbms-ses-start-response) Rate limit for mbms session start response (packets per second). type: int more...
    • mbms_ses_stop_request (Alias name: mbms-ses-stop-request) Rate limit for mbms session stop request (packets per second). type: int more...
    • mbms_ses_stop_response (Alias name: mbms-ses-stop-response) Rate limit for mbms session stop response (packets per second). type: int more...
    • note_ms_request (Alias name: note-ms-request) Rate limit for note ms gprs present request (packets per second). type: int more...
    • note_ms_response (Alias name: note-ms-response) Rate limit for note ms gprs present response (packets per second). type: int more...
    • pdu_notify_rej_request (Alias name: pdu-notify-rej-request) Rate limit for pdu notify reject request (packets per second). type: int more...
    • pdu_notify_rej_response (Alias name: pdu-notify-rej-response) Rate limit for pdu notify reject response (packets per second). type: int more...
    • pdu_notify_request (Alias name: pdu-notify-request) Rate limit for pdu notify request (packets per second). type: int more...
    • pdu_notify_response (Alias name: pdu-notify-response) Rate limit for pdu notify response (packets per second). type: int more...
    • ran_info (Alias name: ran-info) Rate limit for ran information relay (packets per second). type: int more...
    • relocation_cancel_request (Alias name: relocation-cancel-request) Rate limit for relocation cancel request (packets per second). type: int more...
    • relocation_cancel_response (Alias name: relocation-cancel-response) Rate limit for relocation cancel response (packets per second). type: int more...
    • send_route_request (Alias name: send-route-request) Rate limit for send routing information for gprs request (packets per second). type: int more...
    • send_route_response (Alias name: send-route-response) Rate limit for send routing information for gprs response (packets per second). type: int more...
    • sgsn_context_ack (Alias name: sgsn-context-ack) Rate limit for sgsn context acknowledgement (packets per second). type: int more...
    • sgsn_context_request (Alias name: sgsn-context-request) Rate limit for sgsn context request (packets per second). type: int more...
    • sgsn_context_response (Alias name: sgsn-context-response) Rate limit for sgsn context response (packets per second). type: int more...
    • support_ext_hdr_notify (Alias name: support-ext-hdr-notify) Rate limit for support extension headers notification (packets per second). type: int more...
    • update_mbms_request (Alias name: update-mbms-request) Rate limit for update mbms context request (packets per second). type: int more...
    • update_mbms_response (Alias name: update-mbms-response) Rate limit for update mbms context response (packets per second). type: int more...
    • update_pdp_request (Alias name: update-pdp-request) Rate limit for update pdp context request (packets per second). type: int more...
    • update_pdp_response (Alias name: update-pdp-response) Rate limit for update pdp context response (packets per second). type: int more...
    • version_not_support (Alias name: version-not-support) Rate limit for version not supported (packets per second). type: int more...

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

- 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>

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:

  • meta - The result of the request.returned: always type: dict
    • 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_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

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

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)