fmgr_firewall_mmsprofile – Configure MMS profiles.¶
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 |
6.2.11 |
||
| True | 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 |
6.4.12 |
| True | 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 |
7.0.8 |
||||
| True | True | True | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
7.2.3 |
|||||||||
| True | 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
- firewall_mmsprofile - Configure MMS profiles. type: dict
- avnotificationtable - AntiVirus notification table ID. type: str more...
- bwordtable - MMS banned word table ID. type: str more...
- carrier-endpoint-prefix - Enable/disable prefixing of end point values. type: str choices: [disable, enable] more...
- carrier-endpoint-prefix-range-max - Maximum length of end point value that can be prefixed (1 - 48). type: int more...
- carrier-endpoint-prefix-range-min - Minimum end point length to be prefixed (1 - 48). type: int more...
- carrier-endpoint-prefix-string - String with which to prefix End point values. type: str more...
- carrierendpointbwltable - Carrier end point filter table ID. type: str more...
- comment - Comment. type: str more...
- mm1 - MM1 options. type: array choices: [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] more...
- mm1-addr-hdr - HTTP header field (for MM1) containing user address. type: str more...
- mm1-addr-source - Source for MM1 user address. type: str choices: [http-header, cookie] more...
- mm1-convert-hex - Enable/disable converting user address from HEX string for MM1. type: str choices: [disable, enable] more...
- mm1-outbreak-prevention - Enable FortiGuard Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive] more...
- mm1-retr-dupe - Enable/disable duplicate scanning of MM1 retr. type: str choices: [disable, enable] more...
- mm1-retrieve-scan - Enable/disable scanning on MM1 retrieve configuration messages. type: str choices: [disable, enable] more...
- mm1comfortamount - MM1 comfort amount (0 - 4294967295). type: int more...
- mm1comfortinterval - MM1 comfort interval (0 - 4294967295). type: int more...
- mm1oversizelimit - Maximum file size to scan (1 - 819200 kB). type: int more...
- mm3 - MM3 options. type: array choices: [avmonitor, block, oversize, quarantine, scan, avquery, bannedword, no-content-summary, archive-summary, archive-full, carrier-endpoint-bwl, remove-blocked, fragmail, splice, mms-checksum] more...
- mm3-outbreak-prevention - Enable FortiGuard Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive] more...
- mm3oversizelimit - Maximum file size to scan (1 - 819200 kB). type: int more...
- mm4 - MM4 options. type: array choices: [avmonitor, block, oversize, quarantine, scan, avquery, bannedword, no-content-summary, archive-summary, archive-full, carrier-endpoint-bwl, remove-blocked, fragmail, splice, mms-checksum] more...
- mm4-outbreak-prevention - Enable FortiGuard Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive] more...
- mm4oversizelimit - Maximum file size to scan (1 - 819200 kB). type: int more...
- mm7 - MM7 options. type: array choices: [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] more...
- mm7-addr-hdr - HTTP header field (for MM7) containing user address. type: str more...
- mm7-addr-source - Source for MM7 user address. type: str choices: [http-header, cookie] more...
- mm7-convert-hex - Enable/disable conversion of user address from HEX string for MM7. type: str choices: [disable, enable] more...
- mm7-outbreak-prevention - Enable FortiGuard Virus Outbreak Prevention service. type: str choices: [disabled, files, full-archive] more...
- mm7comfortamount - MM7 comfort amount (0 - 4294967295). type: int more...
- mm7comfortinterval - MM7 comfort interval (0 - 4294967295). type: int more...
- mm7oversizelimit - Maximum file size to scan (1 - 819200 kB). type: int more...
- mms-antispam-mass-log - Enable/disable logging for MMS antispam mass. type: str choices: [disable, enable] more...
- mms-av-block-log - Enable/disable logging for MMS antivirus file blocking. type: str choices: [disable, enable] more...
- mms-av-oversize-log - Enable/disable logging for MMS antivirus oversize file blocking. type: str choices: [disable, enable] more...
- mms-av-virus-log - Enable/disable logging for MMS antivirus scanning. type: str choices: [disable, enable] more...
- mms-carrier-endpoint-filter-log - Enable/disable logging for MMS end point filter blocking. type: str choices: [disable, enable] more...
- mms-checksum-log - Enable/disable MMS content checksum logging. type: str choices: [disable, enable] more...
- mms-checksum-table - MMS content checksum table ID. type: str more...
- mms-notification-log - Enable/disable logging for MMS notification messages. type: str choices: [disable, enable] more...
- mms-web-content-log - Enable/disable logging for MMS web content blocking. type: str choices: [disable, enable] more...
- mmsbwordthreshold - MMS banned word threshold. type: int more...
- name - Profile name. type: str more...
- notif-msisdn - Notif-Msisdn. type: array more...
- remove-blocked-const-length - Enable/disable MMS replacement of blocked file constant length. type: str choices: [disable, enable] more...
- replacemsg-group - Replacement message group. type: str more...
- dupe type: dict
- action1 - No description for the parameter type: array choices: [log, archive, intercept, block, archive-first, alert-notif] more...
- action2 - No description for the parameter type: array choices: [log, archive, intercept, block, archive-first, alert-notif] more...
- action3 - No description for the parameter type: array choices: [log, archive, intercept, block, archive-first, alert-notif] more...
- block-time1 - Duration for which action takes effect (0 - 35791 min). type: int more...
- block-time2 - Duration for which action takes effect (0 - 35791 min). type: int more...
- block-time3 - Duration action takes effect (0 - 35791 min). type: int more...
- limit1 - Maximum number of messages allowed. type: int more...
- limit2 - Maximum number of messages allowed. type: int more...
- limit3 - Maximum number of messages allowed. type: int more...
- protocol - Protocol. type: str more...
- status1 - Enable/disable status1 detection. type: str choices: [disable, enable] more...
- status2 - Enable/disable status2 detection. type: str choices: [disable, enable] more...
- status3 - Enable/disable status3 detection. type: str choices: [disable, enable] more...
- window1 - Window to count messages over (1 - 2880 min). type: int more...
- window2 - Window to count messages over (1 - 2880 min). type: int more...
- window3 - Window to count messages over (1 - 2880 min). type: int more...
- flood type: dict
- action1 - No description for the parameter type: array choices: [log, archive, intercept, block, archive-first, alert-notif] more...
- action2 - No description for the parameter type: array choices: [log, archive, intercept, block, archive-first, alert-notif] more...
- action3 - No description for the parameter type: array choices: [log, archive, intercept, block, archive-first, alert-notif] more...
- block-time1 - Duration for which action takes effect (0 - 35791 min). type: int more...
- block-time2 - Duration for which action takes effect (0 - 35791 min). type: int more...
- block-time3 - Duration action takes effect (0 - 35791 min). type: int more...
- limit1 - Maximum number of messages allowed. type: int more...
- limit2 - Maximum number of messages allowed. type: int more...
- limit3 - Maximum number of messages allowed. type: int more...
- protocol - Protocol. type: str more...
- status1 - Enable/disable status1 detection. type: str choices: [disable, enable] more...
- status2 - Enable/disable status2 detection. type: str choices: [disable, enable] more...
- status3 - Enable/disable status3 detection. type: str choices: [disable, enable] more...
- window1 - Window to count messages over (1 - 2880 min). type: int more...
- window2 - Window to count messages over (1 - 2880 min). type: int more...
- window3 - Window to count messages over (1 - 2880 min). type: int more...
- notification type: dict
- alert-int - Alert notification send interval. type: int more...
- alert-int-mode - Alert notification interval mode. type: str choices: [hours, minutes] more...
- alert-src-msisdn - Specify from address for alert messages. type: str more...
- alert-status - Alert notification status. type: str choices: [disable, enable] more...
- bword-int - Banned word notification send interval. type: int more...
- bword-int-mode - Banned word notification interval mode. type: str choices: [hours, minutes] more...
- bword-status - Banned word notification status. type: str choices: [disable, enable] more...
- carrier-endpoint-bwl-int - Carrier end point black/white list notification send interval. type: int more...
- carrier-endpoint-bwl-int-mode - Carrier end point black/white list notification interval mode. type: str choices: [hours, minutes] more...
- carrier-endpoint-bwl-status - Carrier end point black/white list notification status. type: str choices: [disable, enable] more...
- days-allowed - No description for the parameter type: array choices: [sunday, monday, tuesday, wednesday, thursday, friday, saturday] more...
- detect-server - Enable/disable automatic server address determination. type: str choices: [disable, enable] more...
- dupe-int - Duplicate notification send interval. type: int more...
- dupe-int-mode - Duplicate notification interval mode. type: str choices: [hours, minutes] more...
- dupe-status - Duplicate notification status. type: str choices: [disable, enable] more...
- file-block-int - File block notification send interval. type: int more...
- file-block-int-mode - File block notification interval mode. type: str choices: [hours, minutes] more...
- file-block-status - File block notification status. type: str choices: [disable, enable] more...
- flood-int - Flood notification send interval. type: int more...
- flood-int-mode - Flood notification interval mode. type: str choices: [hours, minutes] more...
- flood-status - Flood notification status. type: str choices: [disable, enable] more...
- from-in-header - Enable/disable insertion of from address in HTTP header. type: str choices: [disable, enable] more...
- mms-checksum-int - MMS checksum notification send interval. type: int more...
- mms-checksum-int-mode - MMS checksum notification interval mode. type: str choices: [hours, minutes] more...
- mms-checksum-status - MMS checksum notification status. type: str choices: [disable, enable] more...
- mmsc-hostname - Host name or IP address of the MMSC. type: str more...
- mmsc-password - No description for the parameter type: str more...
- mmsc-port - Port used on the MMSC for sending MMS messages (1 - 65535). type: int more...
- mmsc-url - URL used on the MMSC for sending MMS messages. type: str more...
- mmsc-username - User name required for authentication with the MMSC. type: str more...
- msg-protocol - Protocol to use for sending notification messages. type: str choices: [mm1, mm3, mm4, mm7] more...
- msg-type - MM7 message type. type: str choices: [submit-req, deliver-req] more...
- protocol - Protocol. type: str more...
- rate-limit - Rate limit for sending notification messages (0 - 250). type: int more...
- tod-window-duration - Time of day window duration. type: str more...
- tod-window-end - Obsolete. type: str more...
- tod-window-start - Time of day window start. type: str more...
- user-domain - Domain name to which the user addresses belong. type: str more...
- vas-id - VAS identifier. type: str more...
- vasp-id - VASP identifier. type: str more...
- virus-int - Virus notification send interval. type: int more...
- virus-int-mode - Virus notification interval mode. type: str choices: [hours, minutes] more...
- virus-status - Virus notification status. type: str choices: [disable, enable] more...
- outbreak-prevention type: dict
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: 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