:source: fmgr_gtp_messagefilterv2.py
:orphan:
.. _fmgr_gtp_messagefilterv2:
fmgr_gtp_messagefilterv2 -- Message filter for GTPv2 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_messagefilterv2 - Message filter for GTPv2 messages. type: dict
- bearer_resource_cmd_fail (Alias name: bearer-resource-cmd-fail) Bearer resource (command 68, failure indication 69). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- change_notification (Alias name: change-notification) Change notification (req 38, resp 39). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- create_bearer (Alias name: create-bearer) Create bearer (req 95, resp 96). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- create_session (Alias name: create-session) Create session (req 32, resp 33). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- delete_bearer_cmd_fail (Alias name: delete-bearer-cmd-fail) Delete bearer (command 66, failure indication 67). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- delete_bearer_req_resp (Alias name: delete-bearer-req-resp) Delete bearer (req 99, resp 100). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- delete_pdn_connection_set (Alias name: delete-pdn-connection-set) Delete pdn connection set (req 101, resp 102). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- delete_session (Alias name: delete-session) Delete session (req 36, resp 37). 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
- modify_bearer_cmd_fail (Alias name: modify-bearer-cmd-fail) Modify bearer (command 64 , failure indication 65). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- modify_bearer_req_resp (Alias name: modify-bearer-req-resp) Modify bearer (req 34, resp 35). 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
- resume Resume (notify 164 , ack 165). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- suspend Suspend (notify 162, ack 163). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- trace_session (Alias name: trace-session) Trace session (activation 71, deactivation 72). 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_bearer (Alias name: update-bearer) Update bearer (req 97, resp 98). type: str choices: [allow, deny]
more...
Supported Version Ranges: v6.0.0 -> latest
- update_pdn_connection_set (Alias name: update-pdn-connection-set) Update pdn connection set (req 200, resp 201). type: str choices: [allow, deny]
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
- context_req_res_ack (Alias name: context-req-res-ack) Context request/response/acknowledge (req 130, resp 131, ack 132). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.0.2 -> latest
- forward_relocation_cmp_notif_ack (Alias name: forward-relocation-cmp-notif-ack) Forward relocation complete notification/acknowledge (notif 135, ack 136). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.0.2 -> latest
- forward_relocation_req_res (Alias name: forward-relocation-req-res) Forward relocation request/response (req 133, resp 134). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.0.2 -> latest
- alert_mme_notif_ack (Alias name: alert-mme-notif-ack) Alert mme notification/acknowledge (notif 153, ack 154). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- configuration_transfer_tunnel (Alias name: configuration-transfer-tunnel) Configuration transfer tunnel (141). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- create_forwarding_tunnel_req_resp (Alias name: create-forwarding-tunnel-req-resp) Create forwarding tunnel request/response (req 160, resp 161). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- create_indirect_forwarding_tunnel_req_resp (Alias name: create-indirect-forwarding-tunnel-req-resp) Create indirect data forwarding tunnel request/response (req 166, resp 167). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- cs_paging (Alias name: cs-paging) Cs paging indication (151) type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- delete_indirect_forwarding_tunnel_req_resp (Alias name: delete-indirect-forwarding-tunnel-req-resp) Delete indirect data forwarding tunnel request/response (req 168, resp 169). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- detach_notif_ack (Alias name: detach-notif-ack) Detach notification/acknowledge (notif 149, ack 150). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- dlink_data_notif_ack (Alias name: dlink-data-notif-ack) Downlink data notification/acknowledge (notif 176, ack 177). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- dlink_notif_failure (Alias name: dlink-notif-failure) Downlink data notification failure indication (70). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- forward_access_notif_ack (Alias name: forward-access-notif-ack) Forward access context notification/acknowledge (notif 137, ack 138). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- identification_req_resp (Alias name: identification-req-resp) Identification request/response (req 128, resp 129). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- isr_status (Alias name: isr-status) Isr status indication (157). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- mbms_session_start_req_resp (Alias name: mbms-session-start-req-resp) Mbms session start request/response (req 231, resp 232). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- mbms_session_stop_req_resp (Alias name: mbms-session-stop-req-resp) Mbms session stop request/response (req 235, resp 236). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- mbms_session_update_req_resp (Alias name: mbms-session-update-req-resp) Mbms session update request/response (req 233, resp 234). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- modify_access_req_resp (Alias name: modify-access-req-resp) Modify access bearers request/response (req 211, resp 212). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- pgw_dlink_notif_ack (Alias name: pgw-dlink-notif-ack) Pgw downlink triggering notification/acknowledge (notif 103, ack 104). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- pgw_restart_notif_ack (Alias name: pgw-restart-notif-ack) Pgw restart notification/acknowledge (notif 179, ack 180). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- ran_info_relay (Alias name: ran-info-relay) Ran information relay (152). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- release_access_bearer_req_resp (Alias name: release-access-bearer-req-resp) Release access bearers request/response (req 170, resp 171). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- relocation_cancel_req_resp (Alias name: relocation-cancel-req-resp) Relocation cancel request/response (req 139, resp 140). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- remote_ue_report_notif_ack (Alias name: remote-ue-report-notif-ack) Remote ue report notification/acknowledge (notif 40, ack 41). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- reserved_for_earlier_version (Alias name: reserved-for-earlier-version) Reserved for earlier version of the gtp specification (178). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- stop_paging_indication (Alias name: stop-paging-indication) Stop paging indication (73). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- ue_activity_notif_ack (Alias name: ue-activity-notif-ack) Ue activity notification/acknowledge (notif 155, ack 156). type: str choices: [allow, deny]
more...
Supported Version Ranges: v7.2.1 -> latest
- ue_registration_query_req_resp (Alias name: ue-registration-query-req-resp) Ue registration query request/response (req 158, resp 159). 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 GTPv2 messages.
fortinet.fortimanager.fmgr_gtp_messagefilterv2:
# workspace_locking_adom:
adom:
state: present #
gtp_messagefilterv2:
name: "your value" # Required variable, string
# bearer_resource_cmd_fail:
# change_notification:
# create_bearer:
# create_session:
# delete_bearer_cmd_fail:
# delete_bearer_req_resp:
# delete_pdn_connection_set:
# delete_session:
# echo:
# modify_bearer_cmd_fail:
# modify_bearer_req_resp:
# resume:
# suspend:
# trace_session:
# unknown_message:
# unknown_message_white_list:
# update_bearer:
# update_pdn_connection_set:
# version_not_support:
# context_req_res_ack:
# forward_relocation_cmp_notif_ack:
# forward_relocation_req_res:
# alert_mme_notif_ack:
# configuration_transfer_tunnel:
# create_forwarding_tunnel_req_resp:
# create_indirect_forwarding_tunnel_req_resp:
# cs_paging:
# delete_indirect_forwarding_tunnel_req_resp:
# detach_notif_ack:
# dlink_data_notif_ack:
# dlink_notif_failure:
# forward_access_notif_ack:
# identification_req_resp:
# isr_status:
# mbms_session_start_req_resp:
# mbms_session_stop_req_resp:
# mbms_session_update_req_resp:
# modify_access_req_resp:
# pgw_dlink_notif_ack:
# pgw_restart_notif_ack:
# ran_info_relay:
# release_access_bearer_req_resp:
# relocation_cancel_req_resp:
# remote_ue_report_notif_ack:
# reserved_for_earlier_version:
# stop_paging_indication:
# ue_activity_notif_ack:
# ue_registration_query_req_resp:
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)