fortinet.fortios.fortios_system_email_server – Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication features 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_system_email_server.

New in version 2.10: of fortinet.fortios

Synopsis

This module is able to configure a FortiGate or FortiOS (FOS) 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 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.
system_email_server dictionary			Configure the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication features.
	authenticate string	Choices: enable disable	Enable/disable authentication.
	interface string		Specify outgoing interface to reach server. Source system.interface.name.
	interface_select_method string	Choices: auto sdwan specify	Specify how to select outgoing interface to reach server.
	password string		SMTP server user password for authentication.
	port integer		SMTP server port.
	reply_to string		Reply-To email address.
	security string	Choices: none starttls smtps	Connection security used by the email server.
	server string		SMTP server IP address or hostname.
	source_ip string		SMTP server IPv4 source IP.
	source_ip6 string		SMTP server IPv6 source IP.
	ssl_min_proto_version string	Choices: default SSLv3 TLSv1 TLSv1-1 TLSv1-2	Minimum supported protocol version for SSL/TLS connections .
	type string	Choices: custom	Use FortiGuard Message service or custom email server.
	username string		SMTP server user name for authentication.
	validate_server string	Choices: enable disable	Enable/disable validation of server certificate.
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 the email server used by the FortiGate various things. For example, for sending email messages to users to support user authentication
     features.
    fortios_system_email_server:
      vdom:  "{{ vdom }}"
      system_email_server:
        authenticate: "enable"
        interface: "<your_own_value> (source system.interface.name)"
        interface_select_method: "auto"
        password: "<your_own_value>"
        port: "7"
        reply_to: "<your_own_value>"
        security: "none"
        server: "192.168.100.40"
        source_ip: "84.230.14.43"
        source_ip6: "<your_own_value>"
        ssl_min_proto_version: "default"
        type: "custom"
        username: "<your_own_value>"
        validate_server: "enable"

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: 17.0.2.10658
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
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_email_server_module.html

Docs

Docs4dev

Title here