fmgr_gtp_messagefilterv2 – Message filter for GTPv2 messages.¶
New in version 2.0.0.
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.9.0
FortiManager Version Compatibility¶
6.0.0 |
|||||||||||
| True | |||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
||
| True | True | True | True | True | True | True | True | True | True | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
| True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
||||
| True | True | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
|||||||||
| True | True | True | |||||||||
7.4.0 |
|||||||||||
| True |
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_messagefilterv2 - Message filter for GTPv2 messages. type: dict
- bearer-resource-cmd-fail - Bearer resource (command 68, failure indication 69). type: str choices: [allow, deny] more...
- change-notification - Change notification (req 38, resp 39). type: str choices: [allow, deny] more...
- create-bearer - Create bearer (req 95, resp 96). type: str choices: [allow, deny] more...
- create-session - Create session (req 32, resp 33). type: str choices: [allow, deny] more...
- delete-bearer-cmd-fail - Delete bearer (command 66, failure indication 67). type: str choices: [allow, deny] more...
- delete-bearer-req-resp - Delete bearer (req 99, resp 100). type: str choices: [allow, deny] more...
- delete-pdn-connection-set - Delete PDN connection set (req 101, resp 102). type: str choices: [allow, deny] more...
- delete-session - Delete session (req 36, resp 37). type: str choices: [allow, deny] more...
- echo - Echo (req 1, resp 2). type: str choices: [allow, deny] more...
- modify-bearer-cmd-fail - Modify bearer (command 64 , failure indication 65). type: str choices: [allow, deny] more...
- modify-bearer-req-resp - Modify bearer (req 34, resp 35). type: str choices: [allow, deny] more...
- name - Message filter name. type: str more...
- resume - Resume (notify 164 , ack 165). type: str choices: [allow, deny] more...
- suspend - Suspend (notify 162, ack 163). type: str choices: [allow, deny] more...
- trace-session - Trace session (activation 71, deactivation 72). type: str choices: [allow, deny] more...
- unknown-message - Allow or Deny unknown messages. type: str choices: [allow, deny] more...
- unknown-message-white-list - White list (to allow) of unknown messages. type: int more...
- update-bearer - Update bearer (req 97, resp 98). type: str choices: [allow, deny] more...
- update-pdn-connection-set - Update PDN connection set (req 200, resp 201). type: str choices: [allow, deny] more...
- version-not-support - Version not supported (3). type: str choices: [allow, deny] more...
- context-req-res-ack - Context request/response/acknowledge (req 130, resp 131, ack 132). type: str choices: [allow, deny] more...
- forward-relocation-cmp-notif-ack - Forward relocation complete notification/acknowledge (notif 135, ack 136). type: str choices: [allow, deny] more...
- forward-relocation-req-res - Forward relocation request/response (req 133, resp 134). type: str choices: [allow, deny] more...
- alert-mme-notif-ack - Alert MME notification/acknowledge (notif 153, ack 154). type: str choices: [allow, deny] more...
- configuration-transfer-tunnel - Configuration transfer tunnel (141). type: str choices: [allow, deny] more...
- create-forwarding-tunnel-req-resp - Create forwarding tunnel request/response (req 160, resp 161). type: str choices: [allow, deny] more...
- create-indirect-forwarding-tunnel-req-resp - Create indirect data forwarding tunnel request/response (req 166, resp 167). type: str choices: [allow, deny] more...
- cs-paging - CS paging indication (151) type: str choices: [allow, deny] more...
- delete-indirect-forwarding-tunnel-req-resp - Delete indirect data forwarding tunnel request/response (req 168, resp 169). type: str choices: [allow, deny] more...
- detach-notif-ack - Detach notification/acknowledge (notif 149, ack 150). type: str choices: [allow, deny] more...
- dlink-data-notif-ack - Downlink data notification/acknowledge (notif 176, ack 177). type: str choices: [allow, deny] more...
- dlink-notif-failure - Downlink data notification failure indication (70). type: str choices: [allow, deny] more...
- forward-access-notif-ack - Forward access context notification/acknowledge (notif 137, ack 138). type: str choices: [allow, deny] more...
- identification-req-resp - Identification request/response (req 128, resp 129). type: str choices: [allow, deny] more...
- isr-status - ISR status indication (157). type: str choices: [allow, deny] more...
- mbms-session-start-req-resp - MBMS session start request/response (req 231, resp 232). type: str choices: [allow, deny] more...
- mbms-session-stop-req-resp - MBMS session stop request/response (req 235, resp 236). type: str choices: [allow, deny] more...
- mbms-session-update-req-resp - MBMS session update request/response (req 233, resp 234). type: str choices: [allow, deny] more...
- modify-access-req-resp - Modify access bearers request/response (req 211, resp 212). type: str choices: [allow, deny] more...
- pgw-dlink-notif-ack - PGW downlink triggering notification/acknowledge (notif 103, ack 104). type: str choices: [allow, deny] more...
- pgw-restart-notif-ack - PGW restart notification/acknowledge (notif 179, ack 180). type: str choices: [allow, deny] more...
- ran-info-relay - RAN information relay (152). type: str choices: [allow, deny] more...
- release-access-bearer-req-resp - Release access bearers request/response (req 170, resp 171). type: str choices: [allow, deny] more...
- relocation-cancel-req-resp - Relocation cancel request/response (req 139, resp 140). type: str choices: [allow, deny] more...
- remote-ue-report-notif-ack - Remote UE report notification/acknowledge (notif 40, ack 41). type: str choices: [allow, deny] more...
- reserved-for-earlier-version - Reserved for earlier version of the GTP specification (178). type: str choices: [allow, deny] more...
- stop-paging-indication - Stop Paging Indication (73). type: str choices: [allow, deny] more...
- ue-activity-notif-ack - UE activity notification/acknowledge (notif 155, ack 156). type: str choices: [allow, deny] more...
- ue-registration-query-req-resp - UE registration query request/response (req 158, resp 159). 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¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Message filter for GTPv2 messages.
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: <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: <value of 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: <value of 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]>
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 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0