:source: fmgr_gtp_messagefilterv0v1.py
:orphan:
.. _fmgr_gtp_messagefilterv0v1:
fmgr_gtp_messagefilterv0v1 -- Message filter for GTPv0/v1 messages.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v6.0.0 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- state - The directive to create, update or delete an object type: str required: true choices: present, absent
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- revision_note - The change note that can be specified when an object is created or updated. type: string required: false
- adom - The parameter in requested url type: str required: true
- gtp_messagefilterv0v1 - Message filter for GTPv0/v1 messages. type: dict
- create_mbms (Alias name: create-mbms) Gtpv1 create mbms context (req 100, resp 101). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- create_pdp (Alias name: create-pdp) Create pdp context (req 16, resp 17). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- data_record (Alias name: data-record) Data record transfer (req 240, resp 241). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- delete_aa_pdp (Alias name: delete-aa-pdp) Gtpv0 delete aa pdp context (req 24, resp 25). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- delete_mbms (Alias name: delete-mbms) Gtpv1 delete mbms context (req 104, resp 105). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- delete_pdp (Alias name: delete-pdp) Delete pdp context (req 20, resp 21). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- echo Echo (req 1, resp 2). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- end_marker (Alias name: end-marker) Gtpv1 end marker (254). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- error_indication (Alias name: error-indication) Error indication (26). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- failure_report (Alias name: failure-report) Failure report (req 34, resp 35). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- fwd_relocation (Alias name: fwd-relocation) Gtpv1 forward relocation (req 53, resp 54, complete 55, complete ack 59). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- fwd_srns_context (Alias name: fwd-srns-context) Gtpv1 forward srns (context 58, context ack 60). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- gtp_pdu (Alias name: gtp-pdu) Pdu (255). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- identification Identification (req 48, resp 49). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- mbms_de_registration (Alias name: mbms-de-registration) Gtpv1 mbms de-registration (req 114, resp 115). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- mbms_notification (Alias name: mbms-notification) Gtpv1 mbms notification (req 96, resp 97, reject req 98. type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- mbms_registration (Alias name: mbms-registration) Gtpv1 mbms registration (req 112, resp 113). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- mbms_session_start (Alias name: mbms-session-start) Gtpv1 mbms session start (req 116, resp 117). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- mbms_session_stop (Alias name: mbms-session-stop) Gtpv1 mbms session stop (req 118, resp 119). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- mbms_session_update (Alias name: mbms-session-update) Gtpv1 mbms session update (req 120, resp 121). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- ms_info_change_notif (Alias name: ms-info-change-notif) Gtpv1 ms info change notification (req 128, resp 129). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- name Message filter name. type: str
more...
Supported Version Ranges: v6.0.0 -> latest
- node_alive (Alias name: node-alive) Node alive (req 4, resp 5). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- note_ms_present (Alias name: note-ms-present) Note ms gprs present (req 36, resp 37). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- pdu_notification (Alias name: pdu-notification) Pdu notification (req 27, resp 28, reject req 29, reject resp 30). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- ran_info (Alias name: ran-info) Gtpv1 ran information relay (70). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- redirection Redirection (req 6, resp 7). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- relocation_cancel (Alias name: relocation-cancel) Gtpv1 relocation cancel (req 56, resp 57). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- send_route (Alias name: send-route) Send routing information for gprs (req 32, resp 33). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- sgsn_context (Alias name: sgsn-context) Sgsn context (req 50, resp 51, ack 52). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- support_extension (Alias name: support-extension) Gtpv1 supported extension headers notify (31). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- unknown_message (Alias name: unknown-message) Allow or deny unknown messages. type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- unknown_message_white_list (Alias name: unknown-message-white-list) White list (to allow) of unknown messages. type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- update_mbms (Alias name: update-mbms) Gtpv1 update mbms context (req 102, resp 103). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- update_pdp (Alias name: update-pdp) Update pdp context (req 18, resp 19). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- v0_create_aa_pdp__v1_init_pdp_ctx (Alias name: v0-create-aa-pdp--v1-init-pdp-ctx) Gtpv0 create aa pdp context (req 22, resp 23); or gtpv1 initiate pdp context (req 22, resp 23). type: str choices: [deny, allow]
more...
Supported Version Ranges: v6.0.0 -> latest
- version_not_support (Alias name: version-not-support) Version not supported (3). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- create_aa_pdp|init_pdp_ctx (Alias name: create-aa-pdp|init-pdp-ctx) Gtpv0 create aa pdp context (req 22, resp 23). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.2.0 -> v6.4.15
- ue_registration_query (Alias name: ue-registration-query) Ue registration query (req 61, resp ack 62). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Message filter for GTPv0/v1 messages.
fortinet.fortimanager.fmgr_gtp_messagefilterv0v1:
# workspace_locking_adom:
adom:
state: present #
gtp_messagefilterv0v1:
name: "your value" # Required variable, string
# create_mbms:
# create_pdp:
# data_record:
# delete_aa_pdp:
# delete_mbms:
# delete_pdp:
# echo:
# end_marker:
# error_indication:
# failure_report:
# fwd_relocation:
# fwd_srns_context:
# gtp_pdu:
# identification:
# mbms_de_registration:
# mbms_notification:
# mbms_registration:
# mbms_session_start:
# mbms_session_stop:
# mbms_session_update:
# ms_info_change_notif:
# node_alive:
# note_ms_present:
# pdu_notification:
# ran_info:
# redirection:
# relocation_cancel:
# send_route:
# sgsn_context:
# support_extension:
# unknown_message:
# unknown_message_white_list:
# update_mbms:
# update_pdp:
# v0_create_aa_pdp__v1_init_pdp_ctx:
# version_not_support:
# create_aa_pdp|init_pdp_ctx:
# ue_registration_query:
Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)