fortinet.fortimanager.fmgr_gtp_messagefilterv0v1 module – Message filter for GTPv0/v1 messages.

Note

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

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

aliases: create-aa-pdp|init-pdp-ctx

string

GTPv0 create AA PDP context

Choices:

  • "allow"

  • "deny"

create_mbms

aliases: create-mbms

string

GTPv1 create MBMS context

Choices:

  • "allow"

  • "deny"

create_pdp

aliases: create-pdp

string

Create PDP context

Choices:

  • "allow"

  • "deny"

data_record

aliases: data-record

string

Data record transfer

Choices:

  • "allow"

  • "deny"

delete_aa_pdp

aliases: delete-aa-pdp

string

GTPv0 delete AA PDP context

Choices:

  • "allow"

  • "deny"

delete_mbms

aliases: delete-mbms

string

GTPv1 delete MBMS context

Choices:

  • "allow"

  • "deny"

delete_pdp

aliases: delete-pdp

string

Delete PDP context

Choices:

  • "allow"

  • "deny"

echo

string

Echo

Choices:

  • "allow"

  • "deny"

end_marker

aliases: end-marker

string

GTPv1 End marker

Choices:

  • "allow"

  • "deny"

error_indication

aliases: error-indication

string

Error indication

Choices:

  • "allow"

  • "deny"

failure_report

aliases: failure-report

string

Failure report

Choices:

  • "allow"

  • "deny"

fwd_relocation

aliases: fwd-relocation

string

GTPv1 forward relocation

Choices:

  • "allow"

  • "deny"

fwd_srns_context

aliases: fwd-srns-context

string

GTPv1 forward SRNS

Choices:

  • "allow"

  • "deny"

gtp_pdu

aliases: gtp-pdu

string

PDU

Choices:

  • "allow"

  • "deny"

identification

string

Identification

Choices:

  • "allow"

  • "deny"

mbms_de_registration

aliases: mbms-de-registration

string

GTPv1 MBMS de-registration

Choices:

  • "allow"

  • "deny"

mbms_notification

aliases: mbms-notification

string

GTPv1 MBMS notification

Choices:

  • "allow"

  • "deny"

mbms_registration

aliases: mbms-registration

string

GTPv1 MBMS registration

Choices:

  • "allow"

  • "deny"

mbms_session_start

aliases: mbms-session-start

string

GTPv1 MBMS session start

Choices:

  • "allow"

  • "deny"

mbms_session_stop

aliases: mbms-session-stop

string

GTPv1 MBMS session stop

Choices:

  • "allow"

  • "deny"

mbms_session_update

aliases: mbms-session-update

string

GTPv1 MBMS session update

Choices:

  • "allow"

  • "deny"

ms_info_change_notif

aliases: ms-info-change-notif

string

GTPv1 MS info change notification

Choices:

  • "allow"

  • "deny"

name

string / required

Message filter name.

node_alive

aliases: node-alive

string

Node alive

Choices:

  • "allow"

  • "deny"

note_ms_present

aliases: note-ms-present

string

Note MS GPRS present

Choices:

  • "allow"

  • "deny"

pdu_notification

aliases: pdu-notification

string

PDU notification

Choices:

  • "allow"

  • "deny"

ran_info

aliases: ran-info

string

GTPv1 RAN information relay

Choices:

  • "allow"

  • "deny"

redirection

string

Redirection

Choices:

  • "allow"

  • "deny"

relocation_cancel

aliases: relocation-cancel

string

GTPv1 relocation cancel

Choices:

  • "allow"

  • "deny"

send_route

aliases: send-route

string

Send routing information for GPRS

Choices:

  • "allow"

  • "deny"

sgsn_context

aliases: sgsn-context

string

SGSN context

Choices:

  • "allow"

  • "deny"

support_extension

aliases: support-extension

string

GTPv1 supported extension headers notify

Choices:

  • "allow"

  • "deny"

ue_registration_query

aliases: ue-registration-query

string

UE Registration Query

Choices:

  • "allow"

  • "deny"

unknown_message

aliases: unknown-message

string

Allow or Deny unknown messages.

Choices:

  • "allow"

  • "deny"

unknown_message_white_list

aliases: unknown-message-white-list

any

(list) White list

update_mbms

aliases: update-mbms

string

GTPv1 update MBMS context

Choices:

  • "allow"

  • "deny"

update_pdp

aliases: update-pdp

string

Update PDP context

Choices:

  • "allow"

  • "deny"

v0_create_aa_pdp__v1_init_pdp_ctx

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

string

GTPv0 create AA PDP context

Choices:

  • "deny"

  • "allow"

version_not_support

aliases: 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

  • 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 GTPv0/v1 messages.
      fortinet.fortimanager.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: present # <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: <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: <list or 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)