drmofu.fortimanager.fmgr_spamfilter_bword (2.2.2) — module

Install collection

Install with ansible-galaxy collection install drmofu.fortimanager:==2.2.2

Add to requirements.yml

  collections:
    - name: drmofu.fortimanager
      version: 2.2.2

Description

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.

Usage examples

Scanned by Steampunk Spotter

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

 - hosts: fortimanager-inventory
   collections:
     - fortinet.fortimanager
   connection: httpapi
   vars:
      ansible_httpapi_use_ssl: True
      ansible_httpapi_validate_certs: False
      ansible_httpapi_port: 443
   tasks:
    - name: Configure AntiSpam banned word list.
      fmgr_spamfilter_bword:
         bypass_validation: False
         workspace_locking_adom: <value in [global, custom adom including root]>
         workspace_locking_timeout: 300
         rc_succeeded: [0, -2, -3, ...]
         rc_failed: [-2, -3, ...]
         adom: <your own value>
         state: <value in [present, absent]>
         spamfilter_bword:
            comment: <value of string>
            entries:
              -
                  action: <value in [spam, clear]>
                  id: <value of integer>
                  language: <value in [western, simch, trach, ...]>
                  pattern: <value of string>
                  pattern-type: <value in [wildcard, regexp]>
                  score: <value of integer>
                  status: <value in [disable, enable]>
                  where: <value in [subject, body, all]>
            id: <value of integer>
            name: <value of string>

Inputs

    
adom:
    description: the parameter (adom) in requested url
    required: true
    type: str

state:
    choices:
    - present
    - absent
    description: The directive to create, update or delete an object.
    required: true
    type: str

rc_failed:
    description: The rc codes list with which the conditions to fail will be overriden.
    elements: int
    required: false
    type: list

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

access_token:
    description: The token to access FortiManager without using username and password.
    required: false
    type: str

rc_succeeded:
    description: The rc codes list with which the conditions to succeed will be overriden.
    elements: int
    required: false
    type: list

proposed_method:
    choices:
    - update
    - set
    - add
    description: The overridden method for the underlying Json RPC request.
    required: false
    type: str

spamfilter_bword:
    description: the top level parameters set
    required: false
    suboptions:
      comment:
        description: Optional comments.
        type: str
      entries:
        description: description
        elements: dict
        suboptions:
          action:
            choices:
            - spam
            - clear
            description: Mark spam or good.
            type: str
          id:
            description: Banned word entry ID.
            type: int
          language:
            choices:
            - western
            - simch
            - trach
            - japanese
            - korean
            - french
            - thai
            - spanish
            description: Language for the banned word.
            type: str
          pattern:
            description: Pattern for the banned word.
            type: str
          pattern-type:
            choices:
            - wildcard
            - regexp
            description: Wildcard pattern or regular expression.
            type: str
          score:
            description: Score value.
            type: int
          status:
            choices:
            - disable
            - enable
            description: Enable/disable status.
            type: str
          where:
            choices:
            - subject
            - body
            - all
            description: Component of the email to be scanned.
            type: str
        type: list
      id:
        description: ID.
        type: int
      name:
        description: Name of table.
        type: str
    type: dict

bypass_validation:
    default: false
    description: Only set to True when module schema diffs with FortiManager API structure,
      module continues to execute without validating parameters.
    required: false
    type: bool

workspace_locking_adom:
    description: The adom to lock for FortiManager running in workspace mode, the value
      can be global and others including root.
    required: false
    type: str

forticloud_access_token:
    description: Authenticate Ansible client with forticloud API access token.
    required: false
    type: str

workspace_locking_timeout:
    default: 300
    description: The maximum time in seconds to wait for other user to release the workspace
      lock.
    required: false
    type: int

Outputs

meta:
  contains:
    request_url:
      description: The full url requested.
      returned: always
      sample: /sys/login/user
      type: str
    response_code:
      description: The status of api request.
      returned: always
      sample: 0
      type: int
    response_data:
      description: The api response.
      returned: always
      type: list
    response_message:
      description: The descriptive message of the api response.
      returned: always
      sample: OK.
      type: str
    system_information:
      description: The information of the target system.
      returned: always
      type: dict
  description: The result of the request.
  returned: always
  type: dict
rc:
  description: The status the request.
  returned: always
  sample: 0
  type: int
version_check_warning:
  description: Warning if the parameters used in the playbook are not supported by
    the current FortiManager version.
  returned: complex
  type: list