fmgr_firewall_gtp_messagefilter – Message filter.¶
New in version 2.2.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.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.4 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
6.2.11 |
6.2.12 |
|
True | True | True | True | None | 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 |
6.4.12 |
6.4.13 |
False | False | False | False | False | False | False | False | False | False | False | False | False | False |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
7.0.8 |
7.0.9 |
||||
False | False | False | False | False | False | False | False | False | False | ||||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
7.2.4 |
|||||||||
False | False | False | False | False | |||||||||
7.4.0 |
7.4.1 |
||||||||||||
False | False |
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
- 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 - The parameter in requested url type: str required: true
- firewall_gtp_messagefilter - Message filter. type: dict
- create-aa-pdp - Create AA PDP. type: str choices: [allow, deny] more...
- create-mbms - Create MBMS. type: str choices: [allow, deny] more...
- create-pdp - Create PDP. type: str choices: [allow, deny] more...
- data-record - Data record. type: str choices: [allow, deny] more...
- delete-aa-pdp - Delete AA PDP. type: str choices: [allow, deny] more...
- delete-mbms - Delete MBMS. type: str choices: [allow, deny] more...
- delete-pdp - Delete PDP. type: str choices: [allow, deny] more...
- echo - Echo. type: str choices: [allow, deny] more...
- error-indication - Error indication. type: str choices: [allow, deny] more...
- failure-report - Failure report. type: str choices: [allow, deny] more...
- fwd-relocation - Forward relocation. type: str choices: [allow, deny] more...
- fwd-srns-context - Forward SRNS context. type: str choices: [allow, deny] more...
- gtp-pdu - GTP PDU. type: str choices: [allow, deny] more...
- identification - Identification. type: str choices: [allow, deny] more...
- mbms-notification - MBMS notification. type: str choices: [allow, deny] more...
- node-alive - Node alive. type: str choices: [allow, deny] more...
- note-ms-present - Note MS present. type: str choices: [allow, deny] more...
- pdu-notification - PDU notification. type: str choices: [allow, deny] more...
- ran-info - Ran info. type: str choices: [allow, deny] more...
- redirection - Redirection. type: str choices: [allow, deny] more...
- relocation-cancel - Relocation cancel. type: str choices: [allow, deny] more...
- send-route - Send route. type: str choices: [allow, deny] more...
- sgsn-context - SGSN context. type: str choices: [allow, deny] more...
- support-extension - Support extension. type: str choices: [allow, deny] more...
- unknown-message-action - Unknown message action. type: str choices: [allow, deny] more...
- update-mbms - Update MBMS. type: str choices: [allow, deny] more...
- update-pdp - Update PDP. type: str choices: [allow, deny] more...
- version-not-support - Version not supported. 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.
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: 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