:source: fortios_firewall_mms_profile.py :orphan: .. fortios_firewall_mms_profile: fortios_firewall_mms_profile -- Configure MMS profiles in Fortinet's FortiOS and FortiGate. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. versionadded:: 2.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and mms_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0 Requirements ------------ The below requirements are needed on the host that executes this module. - ansible>=2.16 Tips ---- Using member operation to add an element to an existing object. FortiOS Version Compatibility ----------------------------- Supported Version Ranges: v6.0.0 -> v6.2.7 Parameters ---------- .. raw:: html Notes ----- .. note:: - Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks - The module supports check_mode. Examples -------- .. code-block:: yaml+jinja - name: Configure MMS profiles. fortinet.fortios.fortios_firewall_mms_profile: vdom: "{{ vdom }}" state: "present" access_token: "" firewall_mms_profile: avnotificationtable: "2147483647" bwordtable: "2147483647" carrier_endpoint_prefix: "enable" carrier_endpoint_prefix_range_max: "24" carrier_endpoint_prefix_range_min: "24" carrier_endpoint_prefix_string: "" carrierendpointbwltable: "2147483647" comment: "Comment." dupe: - action1: "block" action2: "block" action3: "block" block_time1: "17895" block_time2: "17895" block_time3: "17895" limit1: "1073741823" limit2: "1073741823" limit3: "1073741823" protocol: "" status1: "enable" status2: "enable" status3: "enable" window1: "1440" window2: "1440" window3: "1440" extended_utm_log: "" flood: - action1: "block" action2: "block" action3: "block" block_time1: "17895" block_time2: "17895" block_time3: "17895" limit1: "1073741823" limit2: "1073741823" limit3: "1073741823" protocol: "" status1: "enable" status2: "enable" status3: "enable" window1: "1440" window2: "1440" window3: "1440" mm1: "avmonitor" mm1_addr_hdr: "" mm1_addr_source: "http-header" mm1_convert_hex: "enable" mm1_outbreak_prevention: "disabled" mm1_retr_dupe: "enable" mm1_retrieve_scan: "enable" mm1comfortamount: "2147483647" mm1comfortinterval: "2147483647" mm1oversizelimit: "409600" mm3: "avmonitor" mm3_outbreak_prevention: "disabled" mm3oversizelimit: "409600" mm4: "avmonitor" mm4_outbreak_prevention: "disabled" mm4oversizelimit: "409600" mm7: "avmonitor" mm7_addr_hdr: "" mm7_addr_source: "http-header" mm7_convert_hex: "enable" mm7_outbreak_prevention: "disabled" mm7comfortamount: "2147483647" mm7comfortinterval: "2147483647" mm7oversizelimit: "409600" mms_antispam_mass_log: "enable" mms_av_block_log: "enable" mms_av_oversize_log: "enable" mms_av_virus_log: "enable" mms_carrier_endpoint_filter_log: "enable" mms_checksum_log: "enable" mms_checksum_table: "2147483647" mms_notification_log: "enable" mms_web_content_log: "enable" mmsbwordthreshold: "1073741823" name: "default_name_80" notif_msisdn: - msisdn: "" threshold: "flood-thresh-1" notification: - alert_int: "720" alert_int_mode: "hours" alert_src_msisdn: "" alert_status: "enable" bword_int: "720" bword_int_mode: "hours" bword_status: "enable" carrier_endpoint_bwl_int: "720" carrier_endpoint_bwl_int_mode: "hours" carrier_endpoint_bwl_status: "enable" days_allowed: "sunday" detect_server: "enable" dupe_int: "720" dupe_int_mode: "hours" dupe_status: "enable" file_block_int: "720" file_block_int_mode: "hours" file_block_status: "enable" flood_int: "720" flood_int_mode: "hours" flood_status: "enable" from_in_header: "enable" mms_checksum_int: "720" mms_checksum_int_mode: "hours" mms_checksum_status: "enable" mmsc_hostname: "myhostname" mmsc_password: "" mmsc_port: "32767" mmsc_url: "" mmsc_username: "" msg_protocol: "mm1" msg_type: "submit-req" protocol: "" rate_limit: "125" tod_window_duration: "" tod_window_end: "" tod_window_start: "" user_domain: "" vas_id: "" vasp_id: "" virus_int: "720" virus_int_mode: "hours" virus_status: "enable" outbreak_prevention: external_blocklist: "disable" ftgd_service: "disable" remove_blocked_const_length: "enable" replacemsg_group: " (source system.replacemsg-group.name)" 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: .. raw:: html
  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3
Status ------ - This module is not guaranteed to have a backwards compatible interface. Authors ------- - Link Zheng (@chillancezen) - Jie Xue (@JieX19) - Hongbin Lu (@fgtdev-hblu) - Frank Shen (@frankshen01) - Miguel Angel Munoz (@mamunozgonzalez) - Nicolas Thomas (@thomnico) .. hint:: If you notice any issues in this documentation, you can create a pull request to improve it.