fortinet.fortimanager.fmgr_gtp_messagefilterv2 – Message filter for GTPv2 messages.
Note
This plugin is part of the fortinet.fortimanager collection (version 2.1.3).
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_gtp_messagefilterv2.
New in version 2.10: of fortinet.fortimanager
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 | Choices/Defaults | Comments | |
|---|---|---|---|
| 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
|
|
| enable_log
boolean
|
|
Enable/Disable logging for task
|
|
| gtp_messagefilterv2
dictionary
|
the top level parameters set
|
||
| bearer-resource-cmd-fail
string
|
|
Bearer resource (command 68, failure indication 69).
|
|
| change-notification
string
|
|
Change notification (req 38, resp 39).
|
|
| create-bearer
string
|
|
Create bearer (req 95, resp 96).
|
|
| create-session
string
|
|
Create session (req 32, resp 33).
|
|
| delete-bearer-cmd-fail
string
|
|
Delete bearer (command 66, failure indication 67).
|
|
| delete-bearer-req-resp
string
|
|
Delete bearer (req 99, resp 100).
|
|
| delete-pdn-connection-set
string
|
|
Delete PDN connection set (req 101, resp 102).
|
|
| delete-session
string
|
|
Delete session (req 36, resp 37).
|
|
| echo
string
|
|
Echo (req 1, resp 2).
|
|
| modify-bearer-cmd-fail
string
|
|
Modify bearer (command 64 , failure indication 65).
|
|
| modify-bearer-req-resp
string
|
|
Modify bearer (req 34, resp 35).
|
|
| name
string
|
Message filter name.
|
||
| resume
string
|
|
Resume (notify 164 , ack 165).
|
|
| suspend
string
|
|
Suspend (notify 162, ack 163).
|
|
| trace-session
string
|
|
Trace session (activation 71, deactivation 72).
|
|
| unknown-message
string
|
|
Allow or Deny unknown messages.
|
|
| unknown-message-white-list
integer
|
no description
|
||
| update-bearer
string
|
|
Update bearer (req 97, resp 98).
|
|
| update-pdn-connection-set
string
|
|
Update PDN connection set (req 200, resp 201).
|
|
| version-not-support
string
|
|
Version not supported (3).
|
|
| proposed_method
string
|
|
The overridden method for the underlying Json RPC request
|
|
| rc_failed
list / elements=string
|
the rc codes list with which the conditions to fail will be overriden
|
||
| rc_succeeded
list / elements=string
|
the rc codes list with which the conditions to succeed will be overriden
|
||
| state
string / required
|
|
the directive to create, update or delete an object
|
|
| 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
|
Default:
300
|
the maximum time in seconds to wait for other user to release the workspace lock
|
|
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]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| request_url
string
|
always |
The full url requested
Sample:
/sys/login/user
|
| response_code
integer
|
always |
The status of api request
|
| response_message
string
|
always |
The descriptive message of the api response
Sample:
OK.
|
Authors
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_gtp_messagefilterv2_module.html