fortinet.fortios.fortios_spamfilter_profile (2.3.6) — module

Install collection

Install with ansible-galaxy collection install fortinet.fortios:==2.3.6

Add to requirements.yml

  collections:
    - name: fortinet.fortios
      version: 2.3.6

Description

This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

• ansible>=2.15

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Configure AntiSpam profiles.
  fortinet.fortios.fortios_spamfilter_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      spamfilter_profile:
          comment: "Comment."
          external: "enable"
          flow_based: "enable"
          gmail:
              log: "enable"
          imap:
              action: "pass"
              log: "enable"
              tag_msg: "<your_own_value>"
              tag_type: "subject"
          mapi:
              action: "pass"
              log: "enable"
          msn_hotmail:
              log: "enable"
          name: "default_name_18"
          options: "bannedword"
          pop3:
              action: "pass"
              log: "enable"
              tag_msg: "<your_own_value>"
              tag_type: "subject"
          replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
          smtp:
              action: "pass"
              hdrip: "disable"
              local_override: "disable"
              log: "enable"
              tag_msg: "<your_own_value>"
              tag_type: "subject"
          spam_bwl_table: "2147483647"
          spam_bword_table: "2147483647"
          spam_bword_threshold: "1073741823"
          spam_filtering: "enable"
          spam_iptrust_table: "2147483647"
          spam_log: "disable"
          spam_log_fortiguard_response: "disable"
          spam_mheader_table: "2147483647"
          spam_rbl_table: "2147483647"
          yahoo_mail:
              log: "enable"

Inputs

    
vdom:
    default: root
    description:
    - Virtual domain, among those defined previously. A vdom is a virtual instance of
      the FortiGate that can be configured and used as a different unit.
    type: str

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - Member attribute path to operate on.
    - Delimited by a slash character if there are more than one attribute.
    - Parameter marked with member_path is legitimate for doing member operation.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

spamfilter_profile:
    default: null
    description:
    - Configure AntiSpam profiles.
    suboptions:
      comment:
        description:
        - Comment.
        type: str
      external:
        choices:
        - enable
        - disable
        description:
        - Enable/disable external Email inspection.
        type: str
      flow_based:
        choices:
        - enable
        - disable
        description:
        - Enable/disable flow-based spam filtering.
        type: str
      gmail:
        description:
        - Gmail.
        suboptions:
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable logging.
            type: str
        type: dict
      imap:
        description:
        - IMAP.
        suboptions:
          action:
            choices:
            - pass
            - tag
            description:
            - Action for spam email.
            type: str
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable logging.
            type: str
          tag_msg:
            description:
            - Subject text or header added to spam email.
            type: str
          tag_type:
            choices:
            - subject
            - header
            - spaminfo
            description:
            - Tag subject or header for spam email.
            elements: str
            type: list
        type: dict
      mapi:
        description:
        - MAPI.
        suboptions:
          action:
            choices:
            - pass
            - discard
            description:
            - Action for spam email.
            type: str
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable logging.
            type: str
        type: dict
      msn_hotmail:
        description:
        - MSN Hotmail.
        suboptions:
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable logging.
            type: str
        type: dict
      name:
        description:
        - Profile name.
        required: true
        type: str
      options:
        choices:
        - bannedword
        - spambwl
        - spamfsip
        - spamfssubmit
        - spamfschksum
        - spamfsurl
        - spamhelodns
        - spamraddrdns
        - spamrbl
        - spamhdrcheck
        - spamfsphish
        description:
        - Options.
        elements: str
        type: list
      pop3:
        description:
        - POP3.
        suboptions:
          action:
            choices:
            - pass
            - tag
            description:
            - Action for spam email.
            type: str
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable logging.
            type: str
          tag_msg:
            description:
            - Subject text or header added to spam email.
            type: str
          tag_type:
            choices:
            - subject
            - header
            - spaminfo
            description:
            - Tag subject or header for spam email.
            elements: str
            type: list
        type: dict
      replacemsg_group:
        description:
        - Replacement message group. Source system.replacemsg-group.name.
        type: str
      smtp:
        description:
        - SMTP.
        suboptions:
          action:
            choices:
            - pass
            - tag
            - discard
            description:
            - Action for spam email.
            type: str
          hdrip:
            choices:
            - disable
            - enable
            description:
            - Enable/disable SMTP email header IP checks for spamfsip, spamrbl and spambwl
              filters.
            type: str
          local_override:
            choices:
            - disable
            - enable
            description:
            - Enable/disable local filter to override SMTP remote check result.
            type: str
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable logging.
            type: str
          tag_msg:
            description:
            - Subject text or header added to spam email.
            type: str
          tag_type:
            choices:
            - subject
            - header
            - spaminfo
            description:
            - Tag subject or header for spam email.
            elements: str
            type: list
        type: dict
      spam_bwl_table:
        description:
        - Anti-spam black/white list table ID. Source spamfilter.bwl.id.
        type: int
      spam_bword_table:
        description:
        - Anti-spam banned word table ID. Source spamfilter.bword.id.
        type: int
      spam_bword_threshold:
        description:
        - Spam banned word threshold.
        type: int
      spam_filtering:
        choices:
        - enable
        - disable
        description:
        - Enable/disable spam filtering.
        type: str
      spam_iptrust_table:
        description:
        - Anti-spam IP trust table ID. Source spamfilter.iptrust.id.
        type: int
      spam_log:
        choices:
        - disable
        - enable
        description:
        - Enable/disable spam logging for email filtering.
        type: str
      spam_log_fortiguard_response:
        choices:
        - disable
        - enable
        description:
        - Enable/disable logging FortiGuard spam response.
        type: str
      spam_mheader_table:
        description:
        - Anti-spam MIME header table ID. Source spamfilter.mheader.id.
        type: int
      spam_rbl_table:
        description:
        - Anti-spam DNSBL table ID. Source spamfilter.dnsbl.id.
        type: int
      yahoo_mail:
        description:
        - Yahoo! Mail.
        suboptions:
          log:
            choices:
            - enable
            - disable
            description:
            - Enable/disable logging.
            type: str
        type: dict
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str