fmgr_gtp_messagefilterv0v1 – Message filter for GTPv0/v1 messages.

New in version 2.10.

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.

Requirements

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

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
gtp_messagefilterv0v1 yes yes yes yes yes yes yes yes yes

Parameters

  • 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
  • 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
  • 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
  • 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
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • adom - The parameter in requested url type: str required: true
  • gtp_messagefilterv0v1 - no description type: dict
    • create-mbms - GTPv1 create MBMS context (req 100, resp 101). type: str choices: [allow, deny] more...
    • create-pdp - Create PDP context (req 16, resp 17). type: str choices: [allow, deny] more...
    • data-record - Data record transfer (req 240, resp 241). type: str choices: [allow, deny] more...
    • delete-aa-pdp - GTPv0 delete AA PDP context (req 24, resp 25). type: str choices: [allow, deny] more...
    • delete-mbms - GTPv1 delete MBMS context (req 104, resp 105). type: str choices: [allow, deny] more...
    • delete-pdp - Delete PDP context (req 20, resp 21). type: str choices: [allow, deny] more...
    • echo - Echo (req 1, resp 2). type: str choices: [allow, deny] more...
    • end-marker - GTPv1 End marker (254). type: str choices: [allow, deny] more...
    • error-indication - Error indication (26). type: str choices: [allow, deny] more...
    • failure-report - Failure report (req 34, resp 35). type: str choices: [allow, deny] more...
    • fwd-relocation - GTPv1 forward relocation (req 53, resp 54, complete 55, complete ack 59). type: str choices: [allow, deny] more...
    • fwd-srns-context - GTPv1 forward SRNS (context 58, context ack 60). type: str choices: [allow, deny] more...
    • gtp-pdu - PDU (255). type: str choices: [allow, deny] more...
    • identification - Identification (req 48, resp 49). type: str choices: [allow, deny] more...
    • mbms-de-registration - GTPv1 MBMS de-registration (req 114, resp 115). type: str choices: [allow, deny] more...
    • mbms-notification - GTPv1 MBMS notification (req 96, resp 97, reject req 98. type: str choices: [allow, deny] more...
    • mbms-registration - GTPv1 MBMS registration (req 112, resp 113). type: str choices: [allow, deny] more...
    • mbms-session-start - GTPv1 MBMS session start (req 116, resp 117). type: str choices: [allow, deny] more...
    • mbms-session-stop - GTPv1 MBMS session stop (req 118, resp 119). type: str choices: [allow, deny] more...
    • mbms-session-update - GTPv1 MBMS session update (req 120, resp 121). type: str choices: [allow, deny] more...
    • ms-info-change-notif - GTPv1 MS info change notification (req 128, resp 129). type: str choices: [allow, deny] more...
    • name - Message filter name. type: str more...
    • node-alive - Node alive (req 4, resp 5). type: str choices: [allow, deny] more...
    • note-ms-present - Note MS GPRS present (req 36, resp 37). type: str choices: [allow, deny] more...
    • pdu-notification - PDU notification (req 27, resp 28, reject req 29, reject resp 30). type: str choices: [allow, deny] more...
    • ran-info - GTPv1 RAN information relay (70). type: str choices: [allow, deny] more...
    • redirection - Redirection (req 6, resp 7). type: str choices: [allow, deny] more...
    • relocation-cancel - GTPv1 relocation cancel (req 56, resp 57). type: str choices: [allow, deny] more...
    • send-route - Send routing information for GPRS (req 32, resp 33). type: str choices: [allow, deny] more...
    • sgsn-context - SGSN context (req 50, resp 51, ack 52). type: str choices: [allow, deny] more...
    • support-extension - GTPv1 supported extension headers notify (31). type: str choices: [allow, deny] more...
    • unknown-message - Allow or Deny unknown messages. type: str choices: [allow, deny] more...
    • unknown-message-white-list - White list (to allow) of unknown messages. type: int more...
    • update-mbms - GTPv1 update MBMS context (req 102, resp 103). type: str choices: [allow, deny] more...
    • update-pdp - Update PDP context (req 18, resp 19). type: str choices: [allow, deny] more...
    • v0-create-aa-pdp--v1-init-pdp-ctx - GTPv0 create AA PDP context (req 22, resp 23); Or GTPv1 initiate PDP context (req 22, resp 23). type: str choices: [deny, allow] more...
    • version-not-support - Version not supported (3). type: str choices: [allow, deny] 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

- 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: no description
     fmgr_gtp_messagefilterv0v1:
        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>
        state: <value in [present, absent]>
        gtp_messagefilterv0v1:
           create-mbms: <value in [allow, deny]>
           create-pdp: <value in [allow, deny]>
           data-record: <value in [allow, deny]>
           delete-aa-pdp: <value in [allow, deny]>
           delete-mbms: <value in [allow, deny]>
           delete-pdp: <value in [allow, deny]>
           echo: <value in [allow, deny]>
           end-marker: <value in [allow, deny]>
           error-indication: <value in [allow, deny]>
           failure-report: <value in [allow, deny]>
           fwd-relocation: <value in [allow, deny]>
           fwd-srns-context: <value in [allow, deny]>
           gtp-pdu: <value in [allow, deny]>
           identification: <value in [allow, deny]>
           mbms-de-registration: <value in [allow, deny]>
           mbms-notification: <value in [allow, deny]>
           mbms-registration: <value in [allow, deny]>
           mbms-session-start: <value in [allow, deny]>
           mbms-session-stop: <value in [allow, deny]>
           mbms-session-update: <value in [allow, deny]>
           ms-info-change-notif: <value in [allow, deny]>
           name: <value of string>
           node-alive: <value in [allow, deny]>
           note-ms-present: <value in [allow, deny]>
           pdu-notification: <value in [allow, deny]>
           ran-info: <value in [allow, deny]>
           redirection: <value in [allow, deny]>
           relocation-cancel: <value in [allow, deny]>
           send-route: <value in [allow, deny]>
           sgsn-context: <value in [allow, deny]>
           support-extension: <value in [allow, deny]>
           unknown-message: <value in [allow, deny]>
           unknown-message-white-list: <value of integer>
           update-mbms: <value in [allow, deny]>
           update-pdp: <value in [allow, deny]>
           v0-create-aa-pdp--v1-init-pdp-ctx: <value in [deny, allow]>
           version-not-support: <value in [allow, deny]>

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:

  • 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_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

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

Authors

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

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.