fortinet.fortimanager.fmgr_firewall_gtp_messagefilter module – Message filter.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_gtp_messagefilter.

New in fortinet.fortimanager 2.2.0

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values which need to be adjusted to data sources before usage.

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

firewall_gtp_messagefilter

dictionary

The top level parameters set.

create-aa-pdp

string

Deprecated, please rename it to create_aa_pdp. Create AA PDP.

Choices:

  • "allow"

  • "deny"

create-mbms

string

Deprecated, please rename it to create_mbms. Create MBMS.

Choices:

  • "allow"

  • "deny"

create-pdp

string

Deprecated, please rename it to create_pdp. Create PDP.

Choices:

  • "allow"

  • "deny"

data-record

string

Deprecated, please rename it to data_record. Data record.

Choices:

  • "allow"

  • "deny"

delete-aa-pdp

string

Deprecated, please rename it to delete_aa_pdp. Delete AA PDP.

Choices:

  • "allow"

  • "deny"

delete-mbms

string

Deprecated, please rename it to delete_mbms. Delete MBMS.

Choices:

  • "allow"

  • "deny"

delete-pdp

string

Deprecated, please rename it to delete_pdp. Delete PDP.

Choices:

  • "allow"

  • "deny"

echo

string

Echo.

Choices:

  • "allow"

  • "deny"

error-indication

string

Deprecated, please rename it to error_indication. Error indication.

Choices:

  • "allow"

  • "deny"

failure-report

string

Deprecated, please rename it to failure_report. Failure report.

Choices:

  • "allow"

  • "deny"

fwd-relocation

string

Deprecated, please rename it to fwd_relocation. Forward relocation.

Choices:

  • "allow"

  • "deny"

fwd-srns-context

string

Deprecated, please rename it to fwd_srns_context. Forward SRNS context.

Choices:

  • "allow"

  • "deny"

gtp-pdu

string

Deprecated, please rename it to gtp_pdu. GTP PDU.

Choices:

  • "allow"

  • "deny"

identification

string

Identification.

Choices:

  • "allow"

  • "deny"

mbms-notification

string

Deprecated, please rename it to mbms_notification. MBMS notification.

Choices:

  • "allow"

  • "deny"

node-alive

string

Deprecated, please rename it to node_alive. Node alive.

Choices:

  • "allow"

  • "deny"

note-ms-present

string

Deprecated, please rename it to note_ms_present. Note MS present.

Choices:

  • "allow"

  • "deny"

pdu-notification

string

Deprecated, please rename it to pdu_notification. PDU notification.

Choices:

  • "allow"

  • "deny"

ran-info

string

Deprecated, please rename it to ran_info. Ran info.

Choices:

  • "allow"

  • "deny"

redirection

string

Redirection.

Choices:

  • "allow"

  • "deny"

relocation-cancel

string

Deprecated, please rename it to relocation_cancel. Relocation cancel.

Choices:

  • "allow"

  • "deny"

send-route

string

Deprecated, please rename it to send_route. Send route.

Choices:

  • "allow"

  • "deny"

sgsn-context

string

Deprecated, please rename it to sgsn_context. SGSN context.

Choices:

  • "allow"

  • "deny"

support-extension

string

Deprecated, please rename it to support_extension. Support extension.

Choices:

  • "allow"

  • "deny"

unknown-message-action

string

Deprecated, please rename it to unknown_message_action. Unknown message action.

Choices:

  • "allow"

  • "deny"

update-mbms

string

Deprecated, please rename it to update_mbms. Update MBMS.

Choices:

  • "allow"

  • "deny"

update-pdp

string

Deprecated, please rename it to update_pdp. Update PDP.

Choices:

  • "allow"

  • "deny"

version-not-support

string

Deprecated, please rename it to version_not_support. Version not supported.

Choices:

  • "allow"

  • "deny"

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

gtp

string / required

The parameter (gtp) in requested url.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

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

  • 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 here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)