Try SpotterMessage filter for GTPv0/v1 messages.
| "added in version" 2.0.0 of fortinet.fortimanager"
Authors: Xinwei Du (@dux-fortinet), Xing Li (@lix-fortinet), Jie Xue (@JieX19), Link Zheng (@chillancezen), Frank Shen (@fshen01), Hongbin Lu (@fgtdev-hblu)
preview | supported by community
Install with ansible-galaxy collection install fortinet.fortimanager:==2.4.0
collections:
- name: fortinet.fortimanager
version: 2.4.0This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
- 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]>
adom:
description: The parameter (adom) in requested url.
required: true
type: str
state:
choices:
- present
- absent
description: The directive to create, update or delete an object.
required: true
type: str
rc_failed:
description: The rc codes list with which the conditions to fail will be overriden.
elements: int
type: list
enable_log:
default: false
description: Enable/Disable logging for task.
type: bool
access_token:
description: The token to access FortiManager without using username and password.
type: str
rc_succeeded:
description: The rc codes list with which the conditions to succeed will be overriden.
elements: int
type: list
proposed_method:
choices:
- update
- set
- add
description: The overridden method for the underlying Json RPC request.
type: str
bypass_validation:
default: false
description: Only set to True when module schema diffs with FortiManager API structure,
module continues to execute without validating parameters.
type: bool
gtp_messagefilterv0v1:
description: The top level parameters set.
required: false
suboptions:
create-aa-pdp|init-pdp-ctx:
choices:
- allow
- deny
description: Deprecated, please rename it to create_aa_pdp|init_pdp_ctx. GTPv0
create AA PDP context
type: str
create-mbms:
choices:
- allow
- deny
description: Deprecated, please rename it to create_mbms. GTPv1 create MBMS context
type: str
create-pdp:
choices:
- allow
- deny
description: Deprecated, please rename it to create_pdp. Create PDP context
type: str
data-record:
choices:
- allow
- deny
description: Deprecated, please rename it to data_record. Data record transfer
type: str
delete-aa-pdp:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_aa_pdp. GTPv0 delete AA PDP
context
type: str
delete-mbms:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_mbms. GTPv1 delete MBMS context
type: str
delete-pdp:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_pdp. Delete PDP context
type: str
echo:
choices:
- allow
- deny
description: Echo
type: str
end-marker:
choices:
- allow
- deny
description: Deprecated, please rename it to end_marker. GTPv1 End marker
type: str
error-indication:
choices:
- allow
- deny
description: Deprecated, please rename it to error_indication. Error indication
type: str
failure-report:
choices:
- allow
- deny
description: Deprecated, please rename it to failure_report. Failure report
type: str
fwd-relocation:
choices:
- allow
- deny
description: Deprecated, please rename it to fwd_relocation. GTPv1 forward relocation
type: str
fwd-srns-context:
choices:
- allow
- deny
description: Deprecated, please rename it to fwd_srns_context. GTPv1 forward SRNS
type: str
gtp-pdu:
choices:
- allow
- deny
description: Deprecated, please rename it to gtp_pdu. PDU
type: str
identification:
choices:
- allow
- deny
description: Identification
type: str
mbms-de-registration:
choices:
- allow
- deny
description: Deprecated, please rename it to mbms_de_registration. GTPv1 MBMS
de-registration
type: str
mbms-notification:
choices:
- allow
- deny
description: Deprecated, please rename it to mbms_notification. GTPv1 MBMS notification
type: str
mbms-registration:
choices:
- allow
- deny
description: Deprecated, please rename it to mbms_registration. GTPv1 MBMS registration
type: str
mbms-session-start:
choices:
- allow
- deny
description: Deprecated, please rename it to mbms_session_start. GTPv1 MBMS session
start
type: str
mbms-session-stop:
choices:
- allow
- deny
description: Deprecated, please rename it to mbms_session_stop. GTPv1 MBMS session
stop
type: str
mbms-session-update:
choices:
- allow
- deny
description: Deprecated, please rename it to mbms_session_update. GTPv1 MBMS session
update
type: str
ms-info-change-notif:
choices:
- allow
- deny
description: Deprecated, please rename it to ms_info_change_notif. GTPv1 MS info
change notification
type: str
name:
description: Message filter name.
required: true
type: str
node-alive:
choices:
- allow
- deny
description: Deprecated, please rename it to node_alive. Node alive
type: str
note-ms-present:
choices:
- allow
- deny
description: Deprecated, please rename it to note_ms_present. Note MS GPRS present
type: str
pdu-notification:
choices:
- allow
- deny
description: Deprecated, please rename it to pdu_notification. PDU notification
type: str
ran-info:
choices:
- allow
- deny
description: Deprecated, please rename it to ran_info. GTPv1 RAN information relay
type: str
redirection:
choices:
- allow
- deny
description: Redirection
type: str
relocation-cancel:
choices:
- allow
- deny
description: Deprecated, please rename it to relocation_cancel. GTPv1 relocation
cancel
type: str
send-route:
choices:
- allow
- deny
description: Deprecated, please rename it to send_route. Send routing information
for GPRS
type: str
sgsn-context:
choices:
- allow
- deny
description: Deprecated, please rename it to sgsn_context. SGSN context
type: str
support-extension:
choices:
- allow
- deny
description: Deprecated, please rename it to support_extension. GTPv1 supported
extension headers notify
type: str
ue-registration-query:
choices:
- allow
- deny
description: Deprecated, please rename it to ue_registration_query. UE Registration
Query
type: str
unknown-message:
choices:
- allow
- deny
description: Deprecated, please rename it to unknown_message. Allow or Deny unknown
messages.
type: str
unknown-message-white-list:
description: (list) Deprecated, please rename it to unknown_message_white_list.
White list
type: raw
update-mbms:
choices:
- allow
- deny
description: Deprecated, please rename it to update_mbms. GTPv1 update MBMS context
type: str
update-pdp:
choices:
- allow
- deny
description: Deprecated, please rename it to update_pdp. Update PDP context
type: str
v0-create-aa-pdp--v1-init-pdp-ctx:
choices:
- deny
- allow
description: Deprecated, please rename it to v0_create_aa_pdp__v1_init_pdp_ctx.
GTPv0 create AA PDP context
type: str
version-not-support:
choices:
- allow
- deny
description: Deprecated, please rename it to version_not_support. Version not
supported
type: str
type: dict
workspace_locking_adom:
description: The adom to lock for FortiManager running in workspace mode, the value
can be global and others including root.
type: str
forticloud_access_token:
description: Authenticate Ansible client with forticloud API access token.
type: str
workspace_locking_timeout:
default: 300
description: The maximum time in seconds to wait for other user to release the workspace
lock.
type: int
meta:
contains:
request_url:
description: The full url requested.
returned: always
sample: /sys/login/user
type: str
response_code:
description: The status of api request.
returned: always
sample: 0
type: int
response_data:
description: The api response.
returned: always
type: list
response_message:
description: The descriptive message of the api response.
returned: always
sample: OK.
type: str
system_information:
description: The information of the target system.
returned: always
type: dict
description: The result of the request.
returned: always
type: dict
rc:
description: The status the request.
returned: always
sample: 0
type: int
version_check_warning:
description: Warning if the parameters used in the playbook are not supported by
the current FortiManager version.
returned: complex
type: list