fortinet.fortimanager.fmgr_firewall_mmsprofile module – Configure MMS profiles.
Note
This module is part of the fortinet.fortimanager collection (version 2.3.0).
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 fortinet.fortimanager 2.0.0
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 |
Comments |
---|---|
The token to access FortiManager without using username and password. |
|
the parameter (adom) in requested url |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
the top level parameters set |
|
AntiVirus notification table ID. |
|
MMS banned word table ID. |
|
Enable/disable prefixing of end point values. Choices:
|
|
Maximum length of end point value that can be prefixed |
|
Minimum end point length to be prefixed |
|
String with which to prefix End point values. |
|
Carrier end point filter table ID. |
|
Comment. |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
Duration for which action takes effect |
|
Duration for which action takes effect |
|
Duration action takes effect |
|
Maximum number of messages allowed. |
|
Maximum number of messages allowed. |
|
Maximum number of messages allowed. |
|
Protocol. |
|
Enable/disable status1 detection. Choices:
|
|
Enable/disable status2 detection. Choices:
|
|
Enable/disable status3 detection. Choices:
|
|
Window to count messages over |
|
Window to count messages over |
|
Window to count messages over |
|
no description |
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
Duration for which action takes effect |
|
Duration for which action takes effect |
|
Duration action takes effect |
|
Maximum number of messages allowed. |
|
Maximum number of messages allowed. |
|
Maximum number of messages allowed. |
|
Protocol. |
|
Enable/disable status1 detection. Choices:
|
|
Enable/disable status2 detection. Choices:
|
|
Enable/disable status3 detection. Choices:
|
|
Window to count messages over |
|
Window to count messages over |
|
Window to count messages over |
|
MM1 options. Choices:
|
|
HTTP header field |
|
Source for MM1 user address. Choices:
|
|
Enable/disable converting user address from HEX string for MM1. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
Enable/disable duplicate scanning of MM1 retr. Choices:
|
|
Enable/disable scanning on MM1 retrieve configuration messages. Choices:
|
|
MM1 comfort amount |
|
MM1 comfort interval |
|
Maximum file size to scan |
|
MM3 options. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
Maximum file size to scan |
|
MM4 options. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
Maximum file size to scan |
|
MM7 options. Choices:
|
|
HTTP header field |
|
Source for MM7 user address. Choices:
|
|
Enable/disable conversion of user address from HEX string for MM7. Choices:
|
|
Enable FortiGuard Virus Outbreak Prevention service. Choices:
|
|
MM7 comfort amount |
|
MM7 comfort interval |
|
Maximum file size to scan |
|
Enable/disable logging for MMS antispam mass. Choices:
|
|
Enable/disable logging for MMS antivirus file blocking. Choices:
|
|
Enable/disable logging for MMS antivirus oversize file blocking. Choices:
|
|
Enable/disable logging for MMS antivirus scanning. Choices:
|
|
Enable/disable logging for MMS end point filter blocking. Choices:
|
|
Enable/disable MMS content checksum logging. Choices:
|
|
MMS content checksum table ID. |
|
Enable/disable logging for MMS notification messages. Choices:
|
|
Enable/disable logging for MMS web content blocking. Choices:
|
|
MMS banned word threshold. |
|
Profile name. |
|
Notif-Msisdn. |
|
Recipient MSISDN. |
|
Thresholds on which this MSISDN will receive an alert. Choices:
|
|
no description |
|
Alert notification send interval. |
|
Alert notification interval mode. Choices:
|
|
Specify from address for alert messages. |
|
Alert notification status. Choices:
|
|
Banned word notification send interval. |
|
Banned word notification interval mode. Choices:
|
|
Banned word notification status. Choices:
|
|
Carrier end point black/white list notification send interval. |
|
Carrier end point black/white list notification interval mode. Choices:
|
|
Carrier end point black/white list notification status. Choices:
|
|
no description Choices:
|
|
Enable/disable automatic server address determination. Choices:
|
|
Duplicate notification send interval. |
|
Duplicate notification interval mode. Choices:
|
|
Duplicate notification status. Choices:
|
|
File block notification send interval. |
|
File block notification interval mode. Choices:
|
|
File block notification status. Choices:
|
|
Flood notification send interval. |
|
Flood notification interval mode. Choices:
|
|
Flood notification status. Choices:
|
|
Enable/disable insertion of from address in HTTP header. Choices:
|
|
MMS checksum notification send interval. |
|
MMS checksum notification interval mode. Choices:
|
|
MMS checksum notification status. Choices:
|
|
Host name or IP address of the MMSC. |
|
(list) no description |
|
Port used on the MMSC for sending MMS messages |
|
URL used on the MMSC for sending MMS messages. |
|
User name required for authentication with the MMSC. |
|
Protocol to use for sending notification messages. Choices:
|
|
MM7 message type. Choices:
|
|
Protocol. |
|
Rate limit for sending notification messages |
|
Time of day window duration. |
|
Obsolete. |
|
Time of day window start. |
|
Domain name to which the user addresses belong. |
|
VAS identifier. |
|
VASP identifier. |
|
Virus notification send interval. |
|
Virus notification interval mode. Choices:
|
|
Virus notification status. Choices:
|
|
no description |
|
Enable/disable external malware blocklist. Choices:
|
|
Enable/disable FortiGuard Virus outbreak prevention service. Choices:
|
|
Enable/disable MMS replacement of blocked file constant length. Choices:
|
|
Replacement message group. |
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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: fortimanager00
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
adom: FortiCarrier # FortiCarrier only object, need a FortiCarrier adom
state: present
firewall_mmsprofile:
comment: 'ansible-comment'
#extended-utm-log: disable
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
mm3:
- avmonitor
- block
- oversize
- quarantine
- scan
- avquery
- bannedword
- no-content-summary
- archive-summary
- archive-full
- carrier-endpoint-bwl
- remove-blocked
- fragmail
- splice
- mms-checksum
mm4:
- avmonitor
- block
- oversize
- quarantine
- scan
- avquery
- bannedword
- no-content-summary
- archive-summary
- archive-full
- carrier-endpoint-bwl
- remove-blocked
- fragmail
- splice
- mms-checksum
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
name: 'ansible-test'
- name: gathering fortimanager facts
hosts: fortimanager00
gather_facts: no
connection: httpapi
collections:
- fortinet.fortimanager
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: retrieve all the MMS profiles
fmgr_fact:
facts:
selector: 'firewall_mmsprofile'
params:
adom: 'FortiCarrier' # FortiCarrier only object, need a FortiCarrier adom
mms-profile: 'your_value'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |