lix_fortinet.fortios.fortios_emailfilter_block_allow_list (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

Requirements

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

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

- 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 anti-spam block/allow list.
    fortios_emailfilter_block_allow_list:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      emailfilter_block_allow_list:
        comment: "Optional comments."
        entries:
         -
            action: "reject"
            addr_type: "ipv4"
            email_pattern: "<your_own_value>"
            id:  "8"
            ip4_subnet: "<your_own_value>"
            ip6_subnet: "<your_own_value>"
            pattern: "<your_own_value>"
            pattern_type: "wildcard"
            status: "enable"
            type: "ip"
        id:  "15"
        name: "default_name_16"

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

emailfilter_block_allow_list:
    default: null
    description:
    - Configure anti-spam block/allow list.
    suboptions:
      comment:
        description:
        - Optional comments.
        type: str
      entries:
        description:
        - Anti-spam block/allow entries.
        elements: dict
        suboptions:
          action:
            choices:
            - reject
            - spam
            - clear
            description:
            - Reject, mark as spam or good email.
            type: str
          addr_type:
            choices:
            - ipv4
            - ipv6
            description:
            - IP address type.
            type: str
          email_pattern:
            description:
            - Email address pattern.
            type: str
          id:
            description:
            - Entry ID.
            type: int
          ip4_subnet:
            description:
            - IPv4 network address/subnet mask bits.
            type: str
          ip6_subnet:
            description:
            - IPv6 network address/subnet mask bits.
            type: str
          pattern:
            description:
            - Pattern to match.
            type: str
          pattern_type:
            choices:
            - wildcard
            - regexp
            description:
            - Wildcard pattern or regular expression.
            type: str
          status:
            choices:
            - enable
            - disable
            description:
            - Enable/disable status.
            type: str
          type:
            choices:
            - ip
            - email-to
            - email-from
            - subject
            - email
            description:
            - Entry type.
            type: str
        type: list
      id:
        description:
        - ID.
        required: true
        type: int
      name:
        description:
        - Name of table.
        type: str
    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