Try SpotterMessage filter for GTPv2 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 GTPv2 messages.
fortinet.fortimanager.fmgr_gtp_messagefilterv2:
# 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_messagefilterv2:
bearer_resource_cmd_fail: <value in [allow, deny]>
change_notification: <value in [allow, deny]>
create_bearer: <value in [allow, deny]>
create_session: <value in [allow, deny]>
delete_bearer_cmd_fail: <value in [allow, deny]>
delete_bearer_req_resp: <value in [allow, deny]>
delete_pdn_connection_set: <value in [allow, deny]>
delete_session: <value in [allow, deny]>
echo: <value in [allow, deny]>
modify_bearer_cmd_fail: <value in [allow, deny]>
modify_bearer_req_resp: <value in [allow, deny]>
name: <string>
resume: <value in [allow, deny]>
suspend: <value in [allow, deny]>
trace_session: <value in [allow, deny]>
unknown_message: <value in [allow, deny]>
unknown_message_white_list: <list or integer>
update_bearer: <value in [allow, deny]>
update_pdn_connection_set: <value in [allow, deny]>
version_not_support: <value in [allow, deny]>
context_req_res_ack: <value in [allow, deny]>
forward_relocation_cmp_notif_ack: <value in [allow, deny]>
forward_relocation_req_res: <value in [allow, deny]>
alert_mme_notif_ack: <value in [allow, deny]>
configuration_transfer_tunnel: <value in [allow, deny]>
create_forwarding_tunnel_req_resp: <value in [allow, deny]>
create_indirect_forwarding_tunnel_req_resp: <value in [allow, deny]>
cs_paging: <value in [allow, deny]>
delete_indirect_forwarding_tunnel_req_resp: <value in [allow, deny]>
detach_notif_ack: <value in [allow, deny]>
dlink_data_notif_ack: <value in [allow, deny]>
dlink_notif_failure: <value in [allow, deny]>
forward_access_notif_ack: <value in [allow, deny]>
identification_req_resp: <value in [allow, deny]>
isr_status: <value in [allow, deny]>
mbms_session_start_req_resp: <value in [allow, deny]>
mbms_session_stop_req_resp: <value in [allow, deny]>
mbms_session_update_req_resp: <value in [allow, deny]>
modify_access_req_resp: <value in [allow, deny]>
pgw_dlink_notif_ack: <value in [allow, deny]>
pgw_restart_notif_ack: <value in [allow, deny]>
ran_info_relay: <value in [allow, deny]>
release_access_bearer_req_resp: <value in [allow, deny]>
relocation_cancel_req_resp: <value in [allow, deny]>
remote_ue_report_notif_ack: <value in [allow, deny]>
reserved_for_earlier_version: <value in [allow, deny]>
stop_paging_indication: <value in [allow, deny]>
ue_activity_notif_ack: <value in [allow, deny]>
ue_registration_query_req_resp: <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_messagefilterv2:
description: The top level parameters set.
required: false
suboptions:
alert-mme-notif-ack:
choices:
- allow
- deny
description: Deprecated, please rename it to alert_mme_notif_ack. Alert MME notification/acknowledge
type: str
bearer-resource-cmd-fail:
choices:
- allow
- deny
description: Deprecated, please rename it to bearer_resource_cmd_fail. Bearer
resource
type: str
change-notification:
choices:
- allow
- deny
description: Deprecated, please rename it to change_notification. Change notification
type: str
configuration-transfer-tunnel:
choices:
- allow
- deny
description: Deprecated, please rename it to configuration_transfer_tunnel. Configuration
transfer tunnel
type: str
context-req-res-ack:
choices:
- allow
- deny
description: Deprecated, please rename it to context_req_res_ack. Context request/response/acknowledge
type: str
create-bearer:
choices:
- allow
- deny
description: Deprecated, please rename it to create_bearer. Create bearer
type: str
create-forwarding-tunnel-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to create_forwarding_tunnel_req_resp.
Create forwarding tunnel request/response
type: str
create-indirect-forwarding-tunnel-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to create_indirect_forwarding_tunnel_req_resp.
Create indirect data forwarding tunnel request...
type: str
create-session:
choices:
- allow
- deny
description: Deprecated, please rename it to create_session. Create session
type: str
cs-paging:
choices:
- allow
- deny
description: Deprecated, please rename it to cs_paging. CS paging indication
type: str
delete-bearer-cmd-fail:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_bearer_cmd_fail. Delete bearer
type: str
delete-bearer-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_bearer_req_resp. Delete bearer
type: str
delete-indirect-forwarding-tunnel-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_indirect_forwarding_tunnel_req_resp.
Delete indirect data forwarding tunnel request...
type: str
delete-pdn-connection-set:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_pdn_connection_set. Delete
PDN connection set
type: str
delete-session:
choices:
- allow
- deny
description: Deprecated, please rename it to delete_session. Delete session
type: str
detach-notif-ack:
choices:
- allow
- deny
description: Deprecated, please rename it to detach_notif_ack. Detach notification/acknowledge
type: str
dlink-data-notif-ack:
choices:
- allow
- deny
description: Deprecated, please rename it to dlink_data_notif_ack. Downlink data
notification/acknowledge
type: str
dlink-notif-failure:
choices:
- allow
- deny
description: Deprecated, please rename it to dlink_notif_failure. Downlink data
notification failure indication
type: str
echo:
choices:
- allow
- deny
description: Echo
type: str
forward-access-notif-ack:
choices:
- allow
- deny
description: Deprecated, please rename it to forward_access_notif_ack. Forward
access context notification/acknowledge
type: str
forward-relocation-cmp-notif-ack:
choices:
- allow
- deny
description: Deprecated, please rename it to forward_relocation_cmp_notif_ack.
Forward relocation complete notification/acknowledge
type: str
forward-relocation-req-res:
choices:
- allow
- deny
description: Deprecated, please rename it to forward_relocation_req_res. Forward
relocation request/response
type: str
identification-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to identification_req_resp. Identification
request/response
type: str
isr-status:
choices:
- allow
- deny
description: Deprecated, please rename it to isr_status. ISR status indication
type: str
mbms-session-start-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to mbms_session_start_req_resp. MBMS
session start request/response
type: str
mbms-session-stop-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to mbms_session_stop_req_resp. MBMS
session stop request/response
type: str
mbms-session-update-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to mbms_session_update_req_resp. MBMS
session update request/response
type: str
modify-access-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to modify_access_req_resp. Modify access
bearers request/response
type: str
modify-bearer-cmd-fail:
choices:
- allow
- deny
description: Deprecated, please rename it to modify_bearer_cmd_fail. Modify bearer
type: str
modify-bearer-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to modify_bearer_req_resp. Modify bearer
type: str
name:
description: Message filter name.
required: true
type: str
pgw-dlink-notif-ack:
choices:
- allow
- deny
description: Deprecated, please rename it to pgw_dlink_notif_ack. PGW downlink
triggering notification/acknowledge
type: str
pgw-restart-notif-ack:
choices:
- allow
- deny
description: Deprecated, please rename it to pgw_restart_notif_ack. PGW restart
notification/acknowledge
type: str
ran-info-relay:
choices:
- allow
- deny
description: Deprecated, please rename it to ran_info_relay. RAN information relay
type: str
release-access-bearer-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to release_access_bearer_req_resp. Release
access bearers request/response
type: str
relocation-cancel-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to relocation_cancel_req_resp. Relocation
cancel request/response
type: str
remote-ue-report-notif-ack:
choices:
- allow
- deny
description: Deprecated, please rename it to remote_ue_report_notif_ack. Remote
UE report notification/acknowledge
type: str
reserved-for-earlier-version:
choices:
- allow
- deny
description: Deprecated, please rename it to reserved_for_earlier_version. Reserved
for earlier version of the GTP specification
type: str
resume:
choices:
- allow
- deny
description: Resume
type: str
stop-paging-indication:
choices:
- allow
- deny
description: Deprecated, please rename it to stop_paging_indication. Stop Paging
Indication
type: str
suspend:
choices:
- allow
- deny
description: Suspend
type: str
trace-session:
choices:
- allow
- deny
description: Deprecated, please rename it to trace_session. Trace session
type: str
ue-activity-notif-ack:
choices:
- allow
- deny
description: Deprecated, please rename it to ue_activity_notif_ack. UE activity
notification/acknowledge
type: str
ue-registration-query-req-resp:
choices:
- allow
- deny
description: Deprecated, please rename it to ue_registration_query_req_resp. UE
registration query request/response
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-bearer:
choices:
- allow
- deny
description: Deprecated, please rename it to update_bearer. Update bearer
type: str
update-pdn-connection-set:
choices:
- allow
- deny
description: Deprecated, please rename it to update_pdn_connection_set. Update
PDN connection set
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