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

Note

This module is part of the fortinet.fortimanager collection (version 2.2.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

Alert MME notification/acknowledge

Choices:

  • "allow"

  • "deny"

bearer-resource-cmd-fail

string

Bearer resource

Choices:

  • "allow"

  • "deny"

change-notification

string

Change notification

Choices:

  • "allow"

  • "deny"

configuration-transfer-tunnel

string

Configuration transfer tunnel

Choices:

  • "allow"

  • "deny"

context-req-res-ack

string

Context request/response/acknowledge

Choices:

  • "allow"

  • "deny"

create-bearer

string

Create bearer

Choices:

  • "allow"

  • "deny"

create-forwarding-tunnel-req-resp

string

Create forwarding tunnel request/response

Choices:

  • "allow"

  • "deny"

create-indirect-forwarding-tunnel-req-resp

string

Create indirect data forwarding tunnel request/response

Choices:

  • "allow"

  • "deny"

create-session

string

Create session

Choices:

  • "allow"

  • "deny"

cs-paging

string

CS paging indication

Choices:

  • "allow"

  • "deny"

delete-bearer-cmd-fail

string

Delete bearer

Choices:

  • "allow"

  • "deny"

delete-bearer-req-resp

string

Delete bearer

Choices:

  • "allow"

  • "deny"

delete-indirect-forwarding-tunnel-req-resp

string

Delete indirect data forwarding tunnel request/response

Choices:

  • "allow"

  • "deny"

delete-pdn-connection-set

string

Delete PDN connection set

Choices:

  • "allow"

  • "deny"

delete-session

string

Delete session

Choices:

  • "allow"

  • "deny"

detach-notif-ack

string

Detach notification/acknowledge

Choices:

  • "allow"

  • "deny"

string

Downlink data notification/acknowledge

Choices:

  • "allow"

  • "deny"

string

Downlink data notification failure indication

Choices:

  • "allow"

  • "deny"

echo

string

Echo

Choices:

  • "allow"

  • "deny"

forward-access-notif-ack

string

Forward access context notification/acknowledge

Choices:

  • "allow"

  • "deny"

forward-relocation-cmp-notif-ack

string

Forward relocation complete notification/acknowledge

Choices:

  • "allow"

  • "deny"

forward-relocation-req-res

string

Forward relocation request/response

Choices:

  • "allow"

  • "deny"

identification-req-resp

string

Identification request/response

Choices:

  • "allow"

  • "deny"

isr-status

string

ISR status indication

Choices:

  • "allow"

  • "deny"

mbms-session-start-req-resp

string

MBMS session start request/response

Choices:

  • "allow"

  • "deny"

mbms-session-stop-req-resp

string

MBMS session stop request/response

Choices:

  • "allow"

  • "deny"

mbms-session-update-req-resp

string

MBMS session update request/response

Choices:

  • "allow"

  • "deny"

modify-access-req-resp

string

Modify access bearers request/response

Choices:

  • "allow"

  • "deny"

modify-bearer-cmd-fail

string

Modify bearer

Choices:

  • "allow"

  • "deny"

modify-bearer-req-resp

string

Modify bearer

Choices:

  • "allow"

  • "deny"

name

string

Message filter name.

string

PGW downlink triggering notification/acknowledge

Choices:

  • "allow"

  • "deny"

pgw-restart-notif-ack

string

PGW restart notification/acknowledge

Choices:

  • "allow"

  • "deny"

ran-info-relay

string

RAN information relay

Choices:

  • "allow"

  • "deny"

release-access-bearer-req-resp

string

Release access bearers request/response

Choices:

  • "allow"

  • "deny"

relocation-cancel-req-resp

string

Relocation cancel request/response

Choices:

  • "allow"

  • "deny"

remote-ue-report-notif-ack

string

Remote UE report notification/acknowledge

Choices:

  • "allow"

  • "deny"

reserved-for-earlier-version

string

Reserved for earlier version of the GTP specification

Choices:

  • "allow"

  • "deny"

resume

string

Resume

Choices:

  • "allow"

  • "deny"

stop-paging-indication

string

Stop Paging Indication

Choices:

  • "allow"

  • "deny"

suspend

string

Suspend

Choices:

  • "allow"

  • "deny"

trace-session

string

Trace session

Choices:

  • "allow"

  • "deny"

ue-activity-notif-ack

string

UE activity notification/acknowledge

Choices:

  • "allow"

  • "deny"

ue-registration-query-req-resp

string

UE registration query request/response

Choices:

  • "allow"

  • "deny"

unknown-message

string

Allow or Deny unknown messages.

Choices:

  • "allow"

  • "deny"

unknown-message-white-list

integer

White list

update-bearer

string

Update bearer

Choices:

  • "allow"

  • "deny"

update-pdn-connection-set

string

Update PDN connection set

Choices:

  • "allow"

  • "deny"

version-not-support

string

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

  • 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: Message filter for GTPv2 messages.
     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]>
           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)