fortinet.fortimanager.fmgr_firewall_mmsprofile – Configure MMS profiles.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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

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

Choices:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

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.

Choices:

  • disable

  • enable

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

MM1 options.

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

mm1-addr-hdr

string

HTTP header field (for MM1) containing user address.

mm1-addr-source

string

Source for MM1 user address.

Choices:

  • http-header

  • cookie

mm1-convert-hex

string

Enable/disable converting user address from HEX string for MM1.

Choices:

  • disable

  • enable

mm1-outbreak-prevention

string

Enable FortiGuard Virus Outbreak Prevention service.

Choices:

  • disabled

  • files

  • full-archive

mm1-retr-dupe

string

Enable/disable duplicate scanning of MM1 retr.

Choices:

  • disable

  • enable

mm1-retrieve-scan

string

Enable/disable scanning on MM1 retrieve configuration messages.

Choices:

  • disable

  • enable

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

MM3 options.

Choices:

  • 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

string

Enable FortiGuard Virus Outbreak Prevention service.

Choices:

  • disabled

  • files

  • full-archive

mm3oversizelimit

integer

Maximum file size to scan (1 - 819200 kB).

mm4

list / elements=string

MM4 options.

Choices:

  • 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

string

Enable FortiGuard Virus Outbreak Prevention service.

Choices:

  • disabled

  • files

  • full-archive

mm4oversizelimit

integer

Maximum file size to scan (1 - 819200 kB).

mm7

list / elements=string

MM7 options.

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

mm7-addr-hdr

string

HTTP header field (for MM7) containing user address.

mm7-addr-source

string

Source for MM7 user address.

Choices:

  • http-header

  • cookie

mm7-convert-hex

string

Enable/disable conversion of user address from HEX string for MM7.

Choices:

  • disable

  • enable

mm7-outbreak-prevention

string

Enable FortiGuard Virus Outbreak Prevention service.

Choices:

  • disabled

  • files

  • full-archive

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.

Choices:

  • disable

  • enable

mms-av-block-log

string

Enable/disable logging for MMS antivirus file blocking.

Choices:

  • disable

  • enable

mms-av-oversize-log

string

Enable/disable logging for MMS antivirus oversize file blocking.

Choices:

  • disable

  • enable

mms-av-virus-log

string

Enable/disable logging for MMS antivirus scanning.

Choices:

  • disable

  • enable

mms-carrier-endpoint-filter-log

string

Enable/disable logging for MMS end point filter blocking.

Choices:

  • disable

  • enable

mms-checksum-log

string

Enable/disable MMS content checksum logging.

Choices:

  • disable

  • enable

mms-checksum-table

string

MMS content checksum table ID.

mms-notification-log

string

Enable/disable logging for MMS notification messages.

Choices:

  • disable

  • enable

mms-web-content-log

string

Enable/disable logging for MMS web content blocking.

Choices:

  • disable

  • enable

mmsbwordthreshold

integer

MMS banned word threshold.

name

string

Profile name.

notif-msisdn

list / elements=string

Notif-Msisdn.

msisdn

string

Recipient MSISDN.

threshold

list / elements=string

Thresholds on which this MSISDN will receive an alert.

Choices:

  • flood-thresh-1

  • flood-thresh-2

  • flood-thresh-3

  • dupe-thresh-1

  • dupe-thresh-2

  • dupe-thresh-3

remove-blocked-const-length

string

Enable/disable MMS replacement of blocked file constant length.

Choices:

  • disable

  • enable

replacemsg-group

string

Replacement message group.

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

Choices:

  • present

  • absent

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

the maximum time in seconds to wait for other user to release the workspace lock

Default: 300

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: ''
- 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 here, the following are the fields unique to this module:

Key

Description

request_url

string

The full url requested

Returned: always

Sample: “/sys/login/user”

response_code

integer

The status of api request

Returned: always

Sample: 0

response_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)