Skip to content

Latest commit

 

History

History
303 lines (258 loc) · 13.1 KB

fortios_emailfilter_iptrust.rst

File metadata and controls

303 lines (258 loc) · 13.1 KB
Raw
source:fortios_emailfilter_iptrust.py
orphan:

fortios_emailfilter_iptrust -- Configure AntiSpam IP trust in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify emailfilter feature and iptrust 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.14

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility


Supported Version Ranges
fortios_emailfilter_iptrust v6.2.0 -> latest

Parameters

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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 default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • emailfilter_iptrust - Configure AntiSpam IP trust. type: dict more...
    Supported Version Ranges
    emailfilter_iptrust v6.2.0 -> latest
    • comment - Optional comments. type: str more...
      Supported Version Ranges
      comment v6.2.0 -> latest
    • entries - Spam filter trusted IP addresses. type: list member_path: entries:id more...
      Supported Version Ranges
      entries v6.2.0 -> latest
      • addr_type - Type of address. type: str choices: ipv4, ipv6 more...
        Supported Version Ranges
        addr_type v6.2.0 -> latest
        [ipv4] v6.0.0 -> latest
        [ipv6] v6.0.0 -> latest
      • id - Trusted IP entry ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.2.0 -> latest
      • ip4_subnet - IPv4 network address or network address/subnet mask bits. type: str more...
        Supported Version Ranges
        ip4_subnet v6.2.0 -> latest
      • ip6_subnet - IPv6 network address/subnet mask bits. type: str more...
        Supported Version Ranges
        ip6_subnet v6.2.0 -> latest
      • status - Enable/disable status. type: str choices: enable, disable more...
        Supported Version Ranges
        status v6.2.0 -> latest
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
    • id - ID. see Notes. type: int required: true more...
      Supported Version Ranges
      id v6.2.0 -> latest
    • name - Name of table. type: str more...
      Supported Version Ranges
      name v6.2.0 -> latest

Notes

Note

  • We highly recommend using your own value as the id instead of 0, while '0' is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure AntiSpam IP trust.
  fortinet.fortios.fortios_emailfilter_iptrust:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      emailfilter_iptrust:
          comment: "Optional comments."
          entries:
              -
                  addr_type: "ipv4"
                  id: "6"
                  ip4_subnet: "<your_own_value>"
                  ip6_subnet: "<your_own_value>"
                  status: "enable"
          id: "10"
          name: "default_name_11"

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:

  • 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.