New in version 2.9.
The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
host string | FortiOS or FortiGate IP address. | ||
https boolean |
| Indicates if the requests towards FortiGate must use HTTPS protocol. | |
password string | Default: "" | FortiOS or FortiGate password. | |
ssl_verify boolean |
| Ensures FortiGate certificate must be verified by a proper CA. | |
system_email_server dictionary | Default: null | 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 |
| Enable/disable authentication. | |
password string | SMTP server user password for authentication. | ||
port integer | SMTP server port. | ||
reply_to string | Reply-To email address. | ||
security string |
| 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 |
| Minimum supported protocol version for SSL/TLS connections . | |
type string |
| Use FortiGuard Message service or custom email server. | |
username string | SMTP server user name for authentication. | ||
validate_server string |
| Enable/disable validation of server certificate. | |
username string | FortiOS or FortiGate username. | ||
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. |
Note
- hosts: localhost vars: host: "192.168.122.40" username: "admin" password: "" vdom: "root" ssl_verify: "False" 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: host: "{{ host }}" username: "{{ username }}" password: "{{ password }}" vdom: "{{ vdom }}" https: "False" 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: "84.230.14.43" source_ip6: "<your_own_value>" ssl_min_proto_version: "default" type: "custom" username: "<your_own_value>" validate_server: "enable"
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 |
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_system_email_server_module.html