fmgr_firewall_gtp_messagefilter – Message filter.

Added in version 2.2.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.2.0 -> v6.2.12

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
  • 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 - The parameter in requested url type: str required: true
  • firewall_gtp_messagefilter - Message filter. type: dict
    • create_aa_pdp (Alias name: create-aa-pdp) Create aa pdp. type: str choices: [allow, deny] more...
    • create_mbms (Alias name: create-mbms) Create mbms. type: str choices: [allow, deny] more...
    • create_pdp (Alias name: create-pdp) Create pdp. type: str choices: [allow, deny] more...
    • data_record (Alias name: data-record) Data record. type: str choices: [allow, deny] more...
    • delete_aa_pdp (Alias name: delete-aa-pdp) Delete aa pdp. type: str choices: [allow, deny] more...
    • delete_mbms (Alias name: delete-mbms) Delete mbms. type: str choices: [allow, deny] more...
    • delete_pdp (Alias name: delete-pdp) Delete pdp. type: str choices: [allow, deny] more...
    • echo Echo. type: str choices: [allow, deny] more...
    • error_indication (Alias name: error-indication) Error indication. type: str choices: [allow, deny] more...
    • failure_report (Alias name: failure-report) Failure report. type: str choices: [allow, deny] more...
    • fwd_relocation (Alias name: fwd-relocation) Forward relocation. type: str choices: [allow, deny] more...
    • fwd_srns_context (Alias name: fwd-srns-context) Forward srns context. type: str choices: [allow, deny] more...
    • gtp_pdu (Alias name: gtp-pdu) Gtp pdu. type: str choices: [allow, deny] more...
    • identification Identification. type: str choices: [allow, deny] more...
    • mbms_notification (Alias name: mbms-notification) Mbms notification. type: str choices: [allow, deny] more...
    • node_alive (Alias name: node-alive) Node alive. type: str choices: [allow, deny] more...
    • note_ms_present (Alias name: note-ms-present) Note ms present. type: str choices: [allow, deny] more...
    • pdu_notification (Alias name: pdu-notification) Pdu notification. type: str choices: [allow, deny] more...
    • ran_info (Alias name: ran-info) Ran info. type: str choices: [allow, deny] more...
    • redirection Redirection. type: str choices: [allow, deny] more...
    • relocation_cancel (Alias name: relocation-cancel) Relocation cancel. type: str choices: [allow, deny] more...
    • send_route (Alias name: send-route) Send route. type: str choices: [allow, deny] more...
    • sgsn_context (Alias name: sgsn-context) Sgsn context. type: str choices: [allow, deny] more...
    • support_extension (Alias name: support-extension) Support extension. type: str choices: [allow, deny] more...
    • unknown_message_action (Alias name: unknown-message-action) Unknown message action. type: str choices: [allow, deny] more...
    • update_mbms (Alias name: update-mbms) Update mbms. type: str choices: [allow, deny] more...
    • update_pdp (Alias name: update-pdp) Update pdp. type: str choices: [allow, deny] more...
    • version_not_support (Alias name: version-not-support) Version not supported. 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.
      fortinet.fortimanager.fmgr_firewall_gtp_messagefilter:
        # 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>
        gtp: <your own value>
        firewall_gtp_messagefilter:
          create_aa_pdp: <value in [allow, deny]>
          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]>
          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_notification: <value in [allow, deny]>
          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_action: <value in [allow, deny]>
          update_mbms: <value in [allow, deny]>
          update_pdp: <value in [allow, deny]>
          version_not_support: <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)