fortiswitch_system_email_server – Email server configuration in Fortinet’s FortiSwitch

New in version 1.0.0.

Synopsis

  • This module is able to configure a FortiSwitch device by allowing the user to set and modify system feature and email_server category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v7.0.0

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.14

FortiSW Version Compatibility


Supported Version Ranges
fortiswitch_system_email_server v7.2.1 -> latest

Parameters

  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • 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
  • system_email_server - Email server configuration. type: dict
    • authenticate - Enable/disable authentication. type: str choices: enable, disable
    • password - Set SMTP server user password for authentication. type: str
    • port - Set SMTP server port. type: int
    • reply_to - Set Reply-To email address. type: str
    • security - Set connection security used by the email server. type: str choices: none, starttls, smtps
    • server - Set SMTP server IP address or hostname. type: str
    • source_ip - Set SMTP server IPv4 source IP. type: str
    • source_ip6 - Set SMTP server IPv6 source IP. type: str
    • ssl_min_proto_version - Set minimum supported protocol version for SSL/TLS connections . type: str choices: SSLv3, TLSv1, TLSv1-1, TLSv1-2, TLSv1-3
    • username - Set SMTP server user name for authentication. type: str
    • validate_server - Enable/disable validation of server certificate. type: str choices: enable, disable

Examples

- name: Email server configuration.
  fortinet.fortiswitch.fortiswitch_system_email_server:
      system_email_server:
          authenticate: "enable"
          password: "<your_own_value>"
          port: "5"
          reply_to: "<your_own_value>"
          security: "none"
          server: "192.168.100.40"
          source_ip: "<your_own_value>"
          source_ip6: "<your_own_value>"
          ssl_min_proto_version: "SSLv3"
          username: "<your_own_value>"
          validate_server: "enable"

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 fortiSwitch image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiSwitch returned: always type: str sample: PUT
  • http_status - Last result given by FortiSwitch on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiSwitch 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
  • serial - Serial number of the unit returned: always type: str sample: FS1D243Z13000122
  • status - Indication of the operation's result returned: always type: str sample: success
  • version - Version of the FortiSwitch returned: always type: str sample: v7.0.0

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)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.