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

From Get docs
Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr gtp messagefilterv0v1 module


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

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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

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


New in version 2.10: of fortinet.fortimanager


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 Choices/Defaults Comments

adom

string / required

the parameter (adom) in requested url

bypass_validation

boolean

  • no ←

  • yes

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

gtp_messagefilterv0v1

dictionary

the top level parameters set

create-mbms

string

  • allow
  • deny

GTPv1 create MBMS context (req 100, resp 101).

create-pdp

string

  • allow
  • deny

Create PDP context (req 16, resp 17).

data-record

string

  • allow
  • deny

Data record transfer (req 240, resp 241).

delete-aa-pdp

string

  • allow
  • deny

GTPv0 delete AA PDP context (req 24, resp 25).

delete-mbms

string

  • allow
  • deny

GTPv1 delete MBMS context (req 104, resp 105).

delete-pdp

string

  • allow
  • deny

Delete PDP context (req 20, resp 21).

echo

string

  • allow
  • deny

Echo (req 1, resp 2).

end-marker

string

  • allow
  • deny

GTPv1 End marker (254).

error-indication

string

  • allow
  • deny

Error indication (26).

failure-report

string

  • allow
  • deny

Failure report (req 34, resp 35).

fwd-relocation

string

  • allow
  • deny

GTPv1 forward relocation (req 53, resp 54, complete 55, complete ack 59).

fwd-srns-context

string

  • allow
  • deny

GTPv1 forward SRNS (context 58, context ack 60).

gtp-pdu

string

  • allow
  • deny

PDU (255).

identification

string

  • allow
  • deny

Identification (req 48, resp 49).

mbms-de-registration

string

  • allow
  • deny

GTPv1 MBMS de-registration (req 114, resp 115).

mbms-notification

string

  • allow
  • deny

GTPv1 MBMS notification (req 96, resp 97, reject req 98. reject resp 99).

mbms-registration

string

  • allow
  • deny

GTPv1 MBMS registration (req 112, resp 113).

mbms-session-start

string

  • allow
  • deny

GTPv1 MBMS session start (req 116, resp 117).

mbms-session-stop

string

  • allow
  • deny

GTPv1 MBMS session stop (req 118, resp 119).

mbms-session-update

string

  • allow
  • deny

GTPv1 MBMS session update (req 120, resp 121).

ms-info-change-notif

string

  • allow
  • deny

GTPv1 MS info change notification (req 128, resp 129).

name

string

Message filter name.

node-alive

string

  • allow
  • deny

Node alive (req 4, resp 5).

note-ms-present

string

  • allow
  • deny

Note MS GPRS present (req 36, resp 37).

pdu-notification

string

  • allow
  • deny

PDU notification (req 27, resp 28, reject req 29, reject resp 30).

ran-info

string

  • allow
  • deny

GTPv1 RAN information relay (70).

redirection

string

  • allow
  • deny

Redirection (req 6, resp 7).

relocation-cancel

string

  • allow
  • deny

GTPv1 relocation cancel (req 56, resp 57).

send-route

string

  • allow
  • deny

Send routing information for GPRS (req 32, resp 33).

sgsn-context

string

  • allow
  • deny

SGSN context (req 50, resp 51, ack 52).

support-extension

string

  • allow
  • deny

GTPv1 supported extension headers notify (31).

unknown-message

string

  • allow
  • deny

Allow or Deny unknown messages.

unknown-message-white-list

integer

no description

update-mbms

string

  • allow
  • deny

GTPv1 update MBMS context (req 102, resp 103).

update-pdp

string

  • allow
  • deny

Update PDP context (req 18, resp 19).

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

string

  • deny
  • allow

GTPv0 create AA PDP context (req 22, resp 23); Or GTPv1 initiate PDP context (req 22, resp 23).

version-not-support

string

  • allow
  • deny

Version not supported (3).

rc_failed

list / elements=string

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

rc_succeeded

list / elements=string

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

state

string / required

  • present
  • absent

the directive to create, update or delete an object

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

Default:

300

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



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]>

Return Values

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

Key Returned Description

request_url

string

always

The full url requested


Sample:

/sys/login/user

response_code

integer

always

The status of api request


response_message

string

always

The descriptive message of the api response


Sample:

OK.




Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_gtp_messagefilterv0v1_module.html


Retrieved from "https://getdocs.org/index.php?title=Ansible/docs/2.11/collections/fortinet/fortimanager/fmgr_gtp_messagefilterv0v1_module&oldid=63634"
Powered by MediaWiki