fmgr_gtp_messagefilterv0v1 – Message filter for GTPv0/v1 messages.

Added in version 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.

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 v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • 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
  • 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...
    • create_pdp (Alias name: create-pdp) Create pdp context (req 16, resp 17). type: str choices: [allow, deny] more...
    • data_record (Alias name: data-record) Data record transfer (req 240, resp 241). type: str choices: [allow, deny] more...
    • delete_aa_pdp (Alias name: delete-aa-pdp) Gtpv0 delete aa pdp context (req 24, resp 25). type: str choices: [allow, deny] more...
    • delete_mbms (Alias name: delete-mbms) Gtpv1 delete mbms context (req 104, resp 105). type: str choices: [allow, deny] more...
    • delete_pdp (Alias name: delete-pdp) Delete pdp context (req 20, resp 21). type: str choices: [allow, deny] more...
    • echo Echo (req 1, resp 2). type: str choices: [allow, deny] more...
    • end_marker (Alias name: end-marker) Gtpv1 end marker (254). type: str choices: [allow, deny] more...
    • error_indication (Alias name: error-indication) Error indication (26). type: str choices: [allow, deny] more...
    • failure_report (Alias name: failure-report) Failure report (req 34, resp 35). type: str choices: [allow, deny] more...
    • fwd_relocation (Alias name: fwd-relocation) Gtpv1 forward relocation (req 53, resp 54, complete 55, complete ack 59). type: str choices: [allow, deny] more...
    • fwd_srns_context (Alias name: fwd-srns-context) Gtpv1 forward srns (context 58, context ack 60). type: str choices: [allow, deny] more...
    • gtp_pdu (Alias name: gtp-pdu) Pdu (255). type: str choices: [allow, deny] more...
    • identification Identification (req 48, resp 49). type: str choices: [allow, deny] more...
    • mbms_de_registration (Alias name: mbms-de-registration) Gtpv1 mbms de-registration (req 114, resp 115). type: str choices: [allow, deny] more...
    • mbms_notification (Alias name: mbms-notification) Gtpv1 mbms notification (req 96, resp 97, reject req 98. type: str choices: [allow, deny] more...
    • mbms_registration (Alias name: mbms-registration) Gtpv1 mbms registration (req 112, resp 113). type: str choices: [allow, deny] more...
    • mbms_session_start (Alias name: mbms-session-start) Gtpv1 mbms session start (req 116, resp 117). type: str choices: [allow, deny] more...
    • mbms_session_stop (Alias name: mbms-session-stop) Gtpv1 mbms session stop (req 118, resp 119). type: str choices: [allow, deny] more...
    • mbms_session_update (Alias name: mbms-session-update) Gtpv1 mbms session update (req 120, resp 121). type: str choices: [allow, deny] more...
    • 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...
    • name Message filter name. type: str more...
    • node_alive (Alias name: node-alive) Node alive (req 4, resp 5). type: str choices: [allow, deny] more...
    • note_ms_present (Alias name: note-ms-present) Note ms gprs present (req 36, resp 37). type: str choices: [allow, deny] more...
    • pdu_notification (Alias name: pdu-notification) Pdu notification (req 27, resp 28, reject req 29, reject resp 30). type: str choices: [allow, deny] more...
    • ran_info (Alias name: ran-info) Gtpv1 ran information relay (70). type: str choices: [allow, deny] more...
    • redirection Redirection (req 6, resp 7). type: str choices: [allow, deny] more...
    • relocation_cancel (Alias name: relocation-cancel) Gtpv1 relocation cancel (req 56, resp 57). type: str choices: [allow, deny] more...
    • send_route (Alias name: send-route) Send routing information for gprs (req 32, resp 33). type: str choices: [allow, deny] more...
    • sgsn_context (Alias name: sgsn-context) Sgsn context (req 50, resp 51, ack 52). type: str choices: [allow, deny] more...
    • support_extension (Alias name: support-extension) Gtpv1 supported extension headers notify (31). type: str choices: [allow, deny] more...
    • unknown_message (Alias name: unknown-message) Allow or deny unknown messages. type: str choices: [allow, deny] more...
    • unknown_message_white_list (Alias name: unknown-message-white-list) White list (to allow) of unknown messages. type: list more...
    • update_mbms (Alias name: update-mbms) Gtpv1 update mbms context (req 102, resp 103). type: str choices: [allow, deny] more...
    • update_pdp (Alias name: update-pdp) Update pdp context (req 18, resp 19). type: str choices: [allow, deny] more...
    • 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...
    • version_not_support (Alias name: version-not-support) Version not supported (3). type: str choices: [allow, deny] more...
    • 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...
    • ue_registration_query (Alias name: ue-registration-query) Ue registration query (req 61, resp ack 62). type: str choices: [allow, deny] more...

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

- 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

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