fmgr_gtp_messagefilterv2 – Message filter for GTPv2 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_messagefilterv2 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_messagefilterv2 - no description type: dict
    • bearer-resource-cmd-fail - Bearer resource (command 68, failure indication 69). type: str choices: [allow, deny] more...
    • change-notification - Change notification (req 38, resp 39). type: str choices: [allow, deny] more...
    • create-bearer - Create bearer (req 95, resp 96). type: str choices: [allow, deny] more...
    • create-session - Create session (req 32, resp 33). type: str choices: [allow, deny] more...
    • delete-bearer-cmd-fail - Delete bearer (command 66, failure indication 67). type: str choices: [allow, deny] more...
    • delete-bearer-req-resp - Delete bearer (req 99, resp 100). type: str choices: [allow, deny] more...
    • delete-pdn-connection-set - Delete PDN connection set (req 101, resp 102). type: str choices: [allow, deny] more...
    • delete-session - Delete session (req 36, resp 37). type: str choices: [allow, deny] more...
    • echo - Echo (req 1, resp 2). type: str choices: [allow, deny] more...
    • modify-bearer-cmd-fail - Modify bearer (command 64 , failure indication 65). type: str choices: [allow, deny] more...
    • modify-bearer-req-resp - Modify bearer (req 34, resp 35). type: str choices: [allow, deny] more...
    • name - Message filter name. type: str more...
    • resume - Resume (notify 164 , ack 165). type: str choices: [allow, deny] more...
    • suspend - Suspend (notify 162, ack 163). type: str choices: [allow, deny] more...
    • trace-session - Trace session (activation 71, deactivation 72). 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-bearer - Update bearer (req 97, resp 98). type: str choices: [allow, deny] more...
    • update-pdn-connection-set - Update PDN connection set (req 200, resp 201). type: str choices: [allow, deny] more...
    • version-not-support - Version not supported (3). type: str choices: [allow, deny] more...
    • context-req-res-ack - Context request/response/acknowledge (req 130, resp 131, ack 132). type: str choices: [allow, deny] more...
    • forward-relocation-cmp-notif-ack - Forward relocation complete notification/acknowledge (notif 135, ack 136). type: str choices: [allow, deny] more...
    • forward-relocation-req-res - Forward relocation request/response (req 133, resp 134). 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_messagefilterv2:
        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_messagefilterv2:
           bearer-resource-cmd-fail: <value in [allow, deny]>
           change-notification: <value in [allow, deny]>
           create-bearer: <value in [allow, deny]>
           create-session: <value in [allow, deny]>
           delete-bearer-cmd-fail: <value in [allow, deny]>
           delete-bearer-req-resp: <value in [allow, deny]>
           delete-pdn-connection-set: <value in [allow, deny]>
           delete-session: <value in [allow, deny]>
           echo: <value in [allow, deny]>
           modify-bearer-cmd-fail: <value in [allow, deny]>
           modify-bearer-req-resp: <value in [allow, deny]>
           name: <value of string>
           resume: <value in [allow, deny]>
           suspend: <value in [allow, deny]>
           trace-session: <value in [allow, deny]>
           unknown-message: <value in [allow, deny]>
           unknown-message-white-list: <value of integer>
           update-bearer: <value in [allow, deny]>
           update-pdn-connection-set: <value in [allow, deny]>
           version-not-support: <value in [allow, deny]>
           context-req-res-ack: <value in [allow, deny]>
           forward-relocation-cmp-notif-ack: <value in [allow, deny]>
           forward-relocation-req-res: <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.