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