drmofu.fortimanager.fmgr_firewall_gtp_messageratelimit (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

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
    required: false
    type: list

enable_log:
    default: false
    description: Enable/Disable logging for task.
    required: false
    type: bool

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    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.
    required: false
    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.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

firewall_gtp_messageratelimit:
    description: the top level parameters set
    required: false
    suboptions:
      create-aa-pdp-request:
        description: Rate limit for create AA PDP context request
        type: int
      create-aa-pdp-response:
        description: Rate limit for create AA PDP context response
        type: int
      create-mbms-request:
        description: Rate limit for create MBMS context request
        type: int
      create-mbms-response:
        description: Rate limit for create MBMS context response
        type: int
      create-pdp-request:
        description: Rate limit for create PDP context request
        type: int
      create-pdp-response:
        description: Rate limit for create PDP context response
        type: int
      delete-aa-pdp-request:
        description: Rate limit for delete AA PDP context request
        type: int
      delete-aa-pdp-response:
        description: Rate limit for delete AA PDP context response
        type: int
      delete-mbms-request:
        description: Rate limit for delete MBMS context request
        type: int
      delete-mbms-response:
        description: Rate limit for delete MBMS context response
        type: int
      delete-pdp-request:
        description: Rate limit for delete PDP context request
        type: int
      delete-pdp-response:
        description: Rate limit for delete PDP context response
        type: int
      echo-reponse:
        description: Rate limit for echo response
        type: int
      echo-request:
        description: Rate limit for echo requests
        type: int
      error-indication:
        description: Rate limit for error indication
        type: int
      failure-report-request:
        description: Rate limit for failure report request
        type: int
      failure-report-response:
        description: Rate limit for failure report response
        type: int
      fwd-reloc-complete-ack:
        description: Rate limit for forward relocation complete acknowledge
        type: int
      fwd-relocation-complete:
        description: Rate limit for forward relocation complete
        type: int
      fwd-relocation-request:
        description: Rate limit for forward relocation request
        type: int
      fwd-relocation-response:
        description: Rate limit for forward relocation response
        type: int
      fwd-srns-context:
        description: Rate limit for forward SRNS context
        type: int
      fwd-srns-context-ack:
        description: Rate limit for forward SRNS context acknowledge
        type: int
      g-pdu:
        description: Rate limit for G-PDU
        type: int
      identification-request:
        description: Rate limit for identification request
        type: int
      identification-response:
        description: Rate limit for identification response
        type: int
      mbms-de-reg-request:
        description: Rate limit for MBMS de-registration request
        type: int
      mbms-de-reg-response:
        description: Rate limit for MBMS de-registration response
        type: int
      mbms-notify-rej-request:
        description: Rate limit for MBMS notification reject request
        type: int
      mbms-notify-rej-response:
        description: Rate limit for MBMS notification reject response
        type: int
      mbms-notify-request:
        description: Rate limit for MBMS notification request
        type: int
      mbms-notify-response:
        description: Rate limit for MBMS notification response
        type: int
      mbms-reg-request:
        description: Rate limit for MBMS registration request
        type: int
      mbms-reg-response:
        description: Rate limit for MBMS registration response
        type: int
      mbms-ses-start-request:
        description: Rate limit for MBMS session start request
        type: int
      mbms-ses-start-response:
        description: Rate limit for MBMS session start response
        type: int
      mbms-ses-stop-request:
        description: Rate limit for MBMS session stop request
        type: int
      mbms-ses-stop-response:
        description: Rate limit for MBMS session stop response
        type: int
      note-ms-request:
        description: Rate limit for note MS GPRS present request
        type: int
      note-ms-response:
        description: Rate limit for note MS GPRS present response
        type: int
      pdu-notify-rej-request:
        description: Rate limit for PDU notify reject request
        type: int
      pdu-notify-rej-response:
        description: Rate limit for PDU notify reject response
        type: int
      pdu-notify-request:
        description: Rate limit for PDU notify request
        type: int
      pdu-notify-response:
        description: Rate limit for PDU notify response
        type: int
      ran-info:
        description: Rate limit for RAN information relay
        type: int
      relocation-cancel-request:
        description: Rate limit for relocation cancel request
        type: int
      relocation-cancel-response:
        description: Rate limit for relocation cancel response
        type: int
      send-route-request:
        description: Rate limit for send routing information for GPRS request
        type: int
      send-route-response:
        description: Rate limit for send routing information for GPRS response
        type: int
      sgsn-context-ack:
        description: Rate limit for SGSN context acknowledgement
        type: int
      sgsn-context-request:
        description: Rate limit for SGSN context request
        type: int
      sgsn-context-response:
        description: Rate limit for SGSN context response
        type: int
      support-ext-hdr-notify:
        description: Rate limit for support extension headers notification
        type: int
      update-mbms-request:
        description: Rate limit for update MBMS context request
        type: int
      update-mbms-response:
        description: Rate limit for update MBMS context response
        type: int
      update-pdp-request:
        description: Rate limit for update PDP context request
        type: int
      update-pdp-response:
        description: Rate limit for update PDP context response
        type: int
      version-not-support:
        description: 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