fmgr_firewall_mmsprofile – Configure MMS profiles.¶
New in version 2.10.
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.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- firewall_mmsprofile - no description 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...
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¶
- 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'
- 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'
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:
- 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_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict