fortinet.fortimanager.fmgr_firewall_mmsprofile – Configure MMS profiles.
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_firewall_mmsprofile.
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 | ||
| firewall_mmsprofile dictionary | the top level parameters set | |||
| avnotificationtable string | AntiVirus notification table ID. | |||
| bwordtable string | MMS banned word table ID. | |||
| carrier-endpoint-prefix string |
| Enable/disable prefixing of end point values. | ||
| carrier-endpoint-prefix-range-max integer | Maximum length of end point value that can be prefixed (1 - 48). | |||
| carrier-endpoint-prefix-range-min integer | Minimum end point length to be prefixed (1 - 48). | |||
| carrier-endpoint-prefix-string string | String with which to prefix End point values. | |||
| carrierendpointbwltable string | Carrier end point filter table ID. | |||
| comment string | Comment. | |||
| mm1 list / elements=string |
| no description | ||
| mm1-addr-hdr string | HTTP header field (for MM1) containing user address. | |||
| mm1-addr-source string |
| Source for MM1 user address. | ||
| mm1-convert-hex string |
| Enable/disable converting user address from HEX string for MM1. | ||
| mm1-outbreak-prevention string |
| Enable FortiGuard Virus Outbreak Prevention service. | ||
| mm1-retr-dupe string |
| Enable/disable duplicate scanning of MM1 retr. | ||
| mm1-retrieve-scan string |
| Enable/disable scanning on MM1 retrieve configuration messages. | ||
| mm1comfortamount integer | MM1 comfort amount (0 - 4294967295). | |||
| mm1comfortinterval integer | MM1 comfort interval (0 - 4294967295). | |||
| mm1oversizelimit integer | Maximum file size to scan (1 - 819200 kB). | |||
| mm3 list / elements=string |
| no description | ||
| mm3-outbreak-prevention string |
| Enable FortiGuard Virus Outbreak Prevention service. | ||
| mm3oversizelimit integer | Maximum file size to scan (1 - 819200 kB). | |||
| mm4 list / elements=string |
| no description | ||
| mm4-outbreak-prevention string |
| Enable FortiGuard Virus Outbreak Prevention service. | ||
| mm4oversizelimit integer | Maximum file size to scan (1 - 819200 kB). | |||
| mm7 list / elements=string |
| no description | ||
| mm7-addr-hdr string | HTTP header field (for MM7) containing user address. | |||
| mm7-addr-source string |
| Source for MM7 user address. | ||
| mm7-convert-hex string |
| Enable/disable conversion of user address from HEX string for MM7. | ||
| mm7-outbreak-prevention string |
| Enable FortiGuard Virus Outbreak Prevention service. | ||
| mm7comfortamount integer | MM7 comfort amount (0 - 4294967295). | |||
| mm7comfortinterval integer | MM7 comfort interval (0 - 4294967295). | |||
| mm7oversizelimit integer | Maximum file size to scan (1 - 819200 kB). | |||
| mms-antispam-mass-log string |
| Enable/disable logging for MMS antispam mass. | ||
| mms-av-block-log string |
| Enable/disable logging for MMS antivirus file blocking. | ||
| mms-av-oversize-log string |
| Enable/disable logging for MMS antivirus oversize file blocking. | ||
| mms-av-virus-log string |
| Enable/disable logging for MMS antivirus scanning. | ||
| mms-carrier-endpoint-filter-log string |
| Enable/disable logging for MMS end point filter blocking. | ||
| mms-checksum-log string |
| Enable/disable MMS content checksum logging. | ||
| mms-checksum-table string | MMS content checksum table ID. | |||
| mms-notification-log string |
| Enable/disable logging for MMS notification messages. | ||
| mms-web-content-log string |
| Enable/disable logging for MMS web content blocking. | ||
| mmsbwordthreshold integer | MMS banned word threshold. | |||
| name string | Profile name. | |||
| notif-msisdn list / elements=string | no description | |||
| msisdn string | Recipient MSISDN. | |||
| threshold list / elements=string |
| no description | ||
| remove-blocked-const-length string |
| Enable/disable MMS replacement of blocked file constant length. | ||
| replacemsg-group string | Replacement message group. | |||
| 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: Configure MMS profiles.
fmgr_firewall_mmsprofile:
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]>
firewall_mmsprofile:
avnotificationtable: <value of string>
bwordtable: <value of string>
carrier-endpoint-prefix: <value in [disable, enable]>
carrier-endpoint-prefix-range-max: <value of integer>
carrier-endpoint-prefix-range-min: <value of integer>
carrier-endpoint-prefix-string: <value of string>
carrierendpointbwltable: <value of string>
comment: <value of string>
mm1:
- avmonitor
- block
- oversize
- quarantine
- scan
- avquery
- bannedword
- no-content-summary
- archive-summary
- archive-full
- carrier-endpoint-bwl
- remove-blocked
- chunkedbypass
- clientcomfort
- servercomfort
- strict-file
- mms-checksum
mm1-addr-hdr: <value of string>
mm1-addr-source: <value in [http-header, cookie]>
mm1-convert-hex: <value in [disable, enable]>
mm1-outbreak-prevention: <value in [disabled, files, full-archive]>
mm1-retr-dupe: <value in [disable, enable]>
mm1-retrieve-scan: <value in [disable, enable]>
mm1comfortamount: <value of integer>
mm1comfortinterval: <value of integer>
mm1oversizelimit: <value of integer>
mm3:
- avmonitor
- block
- oversize
- quarantine
- scan
- avquery
- bannedword
- no-content-summary
- archive-summary
- archive-full
- carrier-endpoint-bwl
- remove-blocked
- fragmail
- splice
- mms-checksum
mm3-outbreak-prevention: <value in [disabled, files, full-archive]>
mm3oversizelimit: <value of integer>
mm4:
- avmonitor
- block
- oversize
- quarantine
- scan
- avquery
- bannedword
- no-content-summary
- archive-summary
- archive-full
- carrier-endpoint-bwl
- remove-blocked
- fragmail
- splice
- mms-checksum
mm4-outbreak-prevention: <value in [disabled, files, full-archive]>
mm4oversizelimit: <value of integer>
mm7:
- avmonitor
- block
- oversize
- quarantine
- scan
- avquery
- bannedword
- no-content-summary
- archive-summary
- archive-full
- carrier-endpoint-bwl
- remove-blocked
- chunkedbypass
- clientcomfort
- servercomfort
- strict-file
- mms-checksum
mm7-addr-hdr: <value of string>
mm7-addr-source: <value in [http-header, cookie]>
mm7-convert-hex: <value in [disable, enable]>
mm7-outbreak-prevention: <value in [disabled, files, full-archive]>
mm7comfortamount: <value of integer>
mm7comfortinterval: <value of integer>
mm7oversizelimit: <value of integer>
mms-antispam-mass-log: <value in [disable, enable]>
mms-av-block-log: <value in [disable, enable]>
mms-av-oversize-log: <value in [disable, enable]>
mms-av-virus-log: <value in [disable, enable]>
mms-carrier-endpoint-filter-log: <value in [disable, enable]>
mms-checksum-log: <value in [disable, enable]>
mms-checksum-table: <value of string>
mms-notification-log: <value in [disable, enable]>
mms-web-content-log: <value in [disable, enable]>
mmsbwordthreshold: <value of integer>
name: <value of string>
notif-msisdn:
-
msisdn: <value of string>
threshold:
- flood-thresh-1
- flood-thresh-2
- flood-thresh-3
- dupe-thresh-1
- dupe-thresh-2
- dupe-thresh-3
remove-blocked-const-length: <value in [disable, enable]>
replacemsg-group: <value of string>
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_firewall_mmsprofile_module.html