fortinet.fortios.fortios_spamfilter_bword – Configure AntiSpam banned word list in Fortinet’s FortiOS and FortiGate.  Note This plugin is part of the fortinet.fortios collection (version 2.1.2). 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.fortios. To use it in a playbook, specify: fortinet.fortios.fortios_spamfilter_bword.   New in version 2.10: of fortinet.fortios   Synopsis Requirements Parameters Notes Examples Return Values  Synopsis  This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify spamfilter feature and bword 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.9.0  Parameters   Parameter Choices/Defaults Comments    access_token  string      Token-based authentication. Generated from GUI of Fortigate.     enable_log  boolean    
Choices: 
no ← yes    Enable/Disable logging for task.     spamfilter_bword  dictionary      Configure AntiSpam banned word list.      comment  string      Optional comments.      entries  list / elements=string      Spam filter banned word.       action  string    
Choices: spam clear    Mark spam or good.       id  integer / required      Banned word entry ID.       language  string    
Choices: western simch trach japanese korean french thai spanish    Language for the banned word.       pattern  string      Pattern for the banned word.       pattern_type  string    
Choices: wildcard regexp    Wildcard pattern or regular expression.       score  integer      Score value.       status  string    
Choices: enable disable    Enable/disable status.       where  string    
Choices: subject body all    Component of the email to be scanned.      id  integer / required      ID.      name  string      Name of table.     state  string / required    
Choices: present absent    Indicates whether to create or remove the object.     vdom  string    Default:"root"   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.     Notes  Note  Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks   Examples - hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure AntiSpam banned word list.
    fortios_spamfilter_bword:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      spamfilter_bword:
        comment: "Optional comments."
        entries:
         -
            action: "spam"
            id:  "6"
            language: "western"
            pattern: "<your_own_value>"
            pattern_type: "wildcard"
            score: "10"
            status: "enable"
            where: "subject"
        id:  "13"
        name: "default_name_14"
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    build  string   always  Build number of the fortigate image  Sample: 1547     http_method  string   always  Last method used to provision the content into FortiGate  Sample: PUT     http_status  string   always  Last result given by FortiGate on last operation applied  Sample: 200     mkey  string   success  Master key (id) used in the last call to FortiGate  Sample: id     name  string   always  Name of the table used to fulfill the request  Sample: urlfilter     path  string   always  Path of the table used to fulfill the request  Sample: webfilter     revision  string   always  Internal revision number  Sample: 30.092-19-86338     serial  string   always  Serial number of the unit  Sample: FGVMEVYYQT3AB5352     status  string   always  Indication of the operation's result  Sample: success     vdom  string   always  Virtual domain used  Sample: root     version  string   always  Version of the FortiGate  Sample: v5.6.3     Authors  Link Zheng (@chillancezen) Jie Xue (@JieX19) Hongbin Lu (@fgtdev-hblu) Frank Shen (@frankshen01) Miguel Angel Munoz (@mamunozgonzalez) Nicolas Thomas (@thomnico) 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible/collections/fortinet/fortios/fortios_spamfilter_bword_module.html', 'source': 'DevDocs.IO'}