fortinet.fortimanager.fmgr_firewall_gtp_messageratelimit (2.4.0) — module

Message rate limiting.

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

Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0


Add to requirements.yml

  collections:
    - name: fortinet.fortimanager
      version: 2.4.0

Description

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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>

Inputs

    
gtp:
    description: The parameter (gtp) in requested url.
    required: true
    type: str

adom:
    description: The parameter (adom) in requested url.
    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

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

firewall_gtp_messageratelimit:
    description: The top level parameters set.
    required: false
    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

Outputs

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