fortinet.fortimanager.fmgr_gtp_messagefilterv0v1 module – Message filter for GTPv0/v1 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_messagefilterv0v1.

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_messagefilterv0v1

dictionary

the top level parameters set

create-aa-pdp|init-pdp-ctx

string

GTPv0 create AA PDP context

Choices:

  • "allow"

  • "deny"

create-mbms

string

GTPv1 create MBMS context

Choices:

  • "allow"

  • "deny"

create-pdp

string

Create PDP context

Choices:

  • "allow"

  • "deny"

data-record

string

Data record transfer

Choices:

  • "allow"

  • "deny"

delete-aa-pdp

string

GTPv0 delete AA PDP context

Choices:

  • "allow"

  • "deny"

delete-mbms

string

GTPv1 delete MBMS context

Choices:

  • "allow"

  • "deny"

delete-pdp

string

Delete PDP context

Choices:

  • "allow"

  • "deny"

echo

string

Echo

Choices:

  • "allow"

  • "deny"

end-marker

string

GTPv1 End marker

Choices:

  • "allow"

  • "deny"

error-indication

string

Error indication

Choices:

  • "allow"

  • "deny"

failure-report

string

Failure report

Choices:

  • "allow"

  • "deny"

fwd-relocation

string

GTPv1 forward relocation

Choices:

  • "allow"

  • "deny"

fwd-srns-context

string

GTPv1 forward SRNS

Choices:

  • "allow"

  • "deny"

gtp-pdu

string

PDU

Choices:

  • "allow"

  • "deny"

identification

string

Identification

Choices:

  • "allow"

  • "deny"

mbms-de-registration

string

GTPv1 MBMS de-registration

Choices:

  • "allow"

  • "deny"

mbms-notification

string

GTPv1 MBMS notification

Choices:

  • "allow"

  • "deny"

mbms-registration

string

GTPv1 MBMS registration

Choices:

  • "allow"

  • "deny"

mbms-session-start

string

GTPv1 MBMS session start

Choices:

  • "allow"

  • "deny"

mbms-session-stop

string

GTPv1 MBMS session stop

Choices:

  • "allow"

  • "deny"

mbms-session-update

string

GTPv1 MBMS session update

Choices:

  • "allow"

  • "deny"

ms-info-change-notif

string

GTPv1 MS info change notification

Choices:

  • "allow"

  • "deny"

name

string

Message filter name.

node-alive

string

Node alive

Choices:

  • "allow"

  • "deny"

note-ms-present

string

Note MS GPRS present

Choices:

  • "allow"

  • "deny"

pdu-notification

string

PDU notification

Choices:

  • "allow"

  • "deny"

ran-info

string

GTPv1 RAN information relay

Choices:

  • "allow"

  • "deny"

redirection

string

Redirection

Choices:

  • "allow"

  • "deny"

relocation-cancel

string

GTPv1 relocation cancel

Choices:

  • "allow"

  • "deny"

send-route

string

Send routing information for GPRS

Choices:

  • "allow"

  • "deny"

sgsn-context

string

SGSN context

Choices:

  • "allow"

  • "deny"

support-extension

string

GTPv1 supported extension headers notify

Choices:

  • "allow"

  • "deny"

ue-registration-query

string

UE Registration Query

Choices:

  • "allow"

  • "deny"

unknown-message

string

Allow or Deny unknown messages.

Choices:

  • "allow"

  • "deny"

unknown-message-white-list

integer

White list

update-mbms

string

GTPv1 update MBMS context

Choices:

  • "allow"

  • "deny"

update-pdp

string

Update PDP context

Choices:

  • "allow"

  • "deny"

v0-create-aa-pdp–v1-init-pdp-ctx

string

GTPv0 create AA PDP context

Choices:

  • "deny"

  • "allow"

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 GTPv0/v1 messages.
     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]>
           create-aa-pdp|init-pdp-ctx: <value in [allow, deny]>
           ue-registration-query: <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)