fortinet.fortimanager.fmgr_gtp_messagefilterv2 module – Message filter for GTPv2 messages.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_gtp_messagefilterv2.

New in fortinet.fortimanager 2.0.0

Synopsis

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

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

gtp_messagefilterv2

dictionary

The top level parameters set.

alert-mme-notif-ack

string

Deprecated, please rename it to alert_mme_notif_ack. Alert MME notification/acknowledge

Choices:

  • "allow"

  • "deny"

bearer-resource-cmd-fail

string

Deprecated, please rename it to bearer_resource_cmd_fail. Bearer resource

Choices:

  • "allow"

  • "deny"

change-notification

string

Deprecated, please rename it to change_notification. Change notification

Choices:

  • "allow"

  • "deny"

configuration-transfer-tunnel

string

Deprecated, please rename it to configuration_transfer_tunnel. Configuration transfer tunnel

Choices:

  • "allow"

  • "deny"

context-req-res-ack

string

Deprecated, please rename it to context_req_res_ack. Context request/response/acknowledge

Choices:

  • "allow"

  • "deny"

create-bearer

string

Deprecated, please rename it to create_bearer. Create bearer

Choices:

  • "allow"

  • "deny"

create-forwarding-tunnel-req-resp

string

Deprecated, please rename it to create_forwarding_tunnel_req_resp. Create forwarding tunnel request/response

Choices:

  • "allow"

  • "deny"

create-indirect-forwarding-tunnel-req-resp

string

Deprecated, please rename it to create_indirect_forwarding_tunnel_req_resp. Create indirect data forwarding tunnel request…

Choices:

  • "allow"

  • "deny"

create-session

string

Deprecated, please rename it to create_session. Create session

Choices:

  • "allow"

  • "deny"

cs-paging

string

Deprecated, please rename it to cs_paging. CS paging indication

Choices:

  • "allow"

  • "deny"

delete-bearer-cmd-fail

string

Deprecated, please rename it to delete_bearer_cmd_fail. Delete bearer

Choices:

  • "allow"

  • "deny"

delete-bearer-req-resp

string

Deprecated, please rename it to delete_bearer_req_resp. Delete bearer

Choices:

  • "allow"

  • "deny"

delete-indirect-forwarding-tunnel-req-resp

string

Deprecated, please rename it to delete_indirect_forwarding_tunnel_req_resp. Delete indirect data forwarding tunnel request…

Choices:

  • "allow"

  • "deny"

delete-pdn-connection-set

string

Deprecated, please rename it to delete_pdn_connection_set. Delete PDN connection set

Choices:

  • "allow"

  • "deny"

delete-session

string

Deprecated, please rename it to delete_session. Delete session

Choices:

  • "allow"

  • "deny"

detach-notif-ack

string

Deprecated, please rename it to detach_notif_ack. Detach notification/acknowledge

Choices:

  • "allow"

  • "deny"

string

Deprecated, please rename it to dlink_data_notif_ack. Downlink data notification/acknowledge

Choices:

  • "allow"

  • "deny"

string

Deprecated, please rename it to dlink_notif_failure. Downlink data notification failure indication

Choices:

  • "allow"

  • "deny"

echo

string

Echo

Choices:

  • "allow"

  • "deny"

forward-access-notif-ack

string

Deprecated, please rename it to forward_access_notif_ack. Forward access context notification/acknowledge

Choices:

  • "allow"

  • "deny"

forward-relocation-cmp-notif-ack

string

Deprecated, please rename it to forward_relocation_cmp_notif_ack. Forward relocation complete notification/acknowledge

Choices:

  • "allow"

  • "deny"

forward-relocation-req-res

string

Deprecated, please rename it to forward_relocation_req_res. Forward relocation request/response

Choices:

  • "allow"

  • "deny"

identification-req-resp

string

Deprecated, please rename it to identification_req_resp. Identification request/response

Choices:

  • "allow"

  • "deny"

isr-status

string

Deprecated, please rename it to isr_status. ISR status indication

Choices:

  • "allow"

  • "deny"

mbms-session-start-req-resp

string

Deprecated, please rename it to mbms_session_start_req_resp. MBMS session start request/response

Choices:

  • "allow"

  • "deny"

mbms-session-stop-req-resp

string

Deprecated, please rename it to mbms_session_stop_req_resp. MBMS session stop request/response

Choices:

  • "allow"

  • "deny"

mbms-session-update-req-resp

string

Deprecated, please rename it to mbms_session_update_req_resp. MBMS session update request/response

Choices:

  • "allow"

  • "deny"

modify-access-req-resp

string

Deprecated, please rename it to modify_access_req_resp. Modify access bearers request/response

Choices:

  • "allow"

  • "deny"

modify-bearer-cmd-fail

string

Deprecated, please rename it to modify_bearer_cmd_fail. Modify bearer

Choices:

  • "allow"

  • "deny"

modify-bearer-req-resp

string

Deprecated, please rename it to modify_bearer_req_resp. Modify bearer

Choices:

  • "allow"

  • "deny"

name

string / required

Message filter name.

string

Deprecated, please rename it to pgw_dlink_notif_ack. PGW downlink triggering notification/acknowledge

Choices:

  • "allow"

  • "deny"

pgw-restart-notif-ack

string

Deprecated, please rename it to pgw_restart_notif_ack. PGW restart notification/acknowledge

Choices:

  • "allow"

  • "deny"

ran-info-relay

string

Deprecated, please rename it to ran_info_relay. RAN information relay

Choices:

  • "allow"

  • "deny"

release-access-bearer-req-resp

string

Deprecated, please rename it to release_access_bearer_req_resp. Release access bearers request/response

Choices:

  • "allow"

  • "deny"

relocation-cancel-req-resp

string

Deprecated, please rename it to relocation_cancel_req_resp. Relocation cancel request/response

Choices:

  • "allow"

  • "deny"

remote-ue-report-notif-ack

string

Deprecated, please rename it to remote_ue_report_notif_ack. Remote UE report notification/acknowledge

Choices:

  • "allow"

  • "deny"

reserved-for-earlier-version

string

Deprecated, please rename it to reserved_for_earlier_version. Reserved for earlier version of the GTP specification

Choices:

  • "allow"

  • "deny"

resume

string

Resume

Choices:

  • "allow"

  • "deny"

stop-paging-indication

string

Deprecated, please rename it to stop_paging_indication. Stop Paging Indication

Choices:

  • "allow"

  • "deny"

suspend

string

Suspend

Choices:

  • "allow"

  • "deny"

trace-session

string

Deprecated, please rename it to trace_session. Trace session

Choices:

  • "allow"

  • "deny"

ue-activity-notif-ack

string

Deprecated, please rename it to ue_activity_notif_ack. UE activity notification/acknowledge

Choices:

  • "allow"

  • "deny"

ue-registration-query-req-resp

string

Deprecated, please rename it to ue_registration_query_req_resp. UE registration query request/response

Choices:

  • "allow"

  • "deny"

unknown-message

string

Deprecated, please rename it to unknown_message. Allow or Deny unknown messages.

Choices:

  • "allow"

  • "deny"

unknown-message-white-list

any

(list) Deprecated, please rename it to unknown_message_white_list. White list

update-bearer

string

Deprecated, please rename it to update_bearer. Update bearer

Choices:

  • "allow"

  • "deny"

update-pdn-connection-set

string

Deprecated, please rename it to update_pdn_connection_set. Update PDN connection set

Choices:

  • "allow"

  • "deny"

version-not-support

string

Deprecated, please rename it to version_not_support. Version not supported

Choices:

  • "allow"

  • "deny"

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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 filter for GTPv2 messages.
      fortinet.fortimanager.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: present # <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: <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: <list or 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]>
          alert_mme_notif_ack: <value in [allow, deny]>
          configuration_transfer_tunnel: <value in [allow, deny]>
          create_forwarding_tunnel_req_resp: <value in [allow, deny]>
          create_indirect_forwarding_tunnel_req_resp: <value in [allow, deny]>
          cs_paging: <value in [allow, deny]>
          delete_indirect_forwarding_tunnel_req_resp: <value in [allow, deny]>
          detach_notif_ack: <value in [allow, deny]>
          dlink_data_notif_ack: <value in [allow, deny]>
          dlink_notif_failure: <value in [allow, deny]>
          forward_access_notif_ack: <value in [allow, deny]>
          identification_req_resp: <value in [allow, deny]>
          isr_status: <value in [allow, deny]>
          mbms_session_start_req_resp: <value in [allow, deny]>
          mbms_session_stop_req_resp: <value in [allow, deny]>
          mbms_session_update_req_resp: <value in [allow, deny]>
          modify_access_req_resp: <value in [allow, deny]>
          pgw_dlink_notif_ack: <value in [allow, deny]>
          pgw_restart_notif_ack: <value in [allow, deny]>
          ran_info_relay: <value in [allow, deny]>
          release_access_bearer_req_resp: <value in [allow, deny]>
          relocation_cancel_req_resp: <value in [allow, deny]>
          remote_ue_report_notif_ack: <value in [allow, deny]>
          reserved_for_earlier_version: <value in [allow, deny]>
          stop_paging_indication: <value in [allow, deny]>
          ue_activity_notif_ack: <value in [allow, deny]>
          ue_registration_query_req_resp: <value in [allow, deny]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)