New in version 2.6.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| authentication |
|
Credentials can be set on an SMTP server's configuration even if that authentication is not used (think staging configs or emergency changes). This parameter acts as a switch to make the specified
smtp_server_username and smtp_server_password parameters active or not.When
yes, the authentication parameters will be active.When
no, the authentication parameters will be inactive. |
|
| encryption |
|
Specifies whether the SMTP server requires an encrypted connection in order to send mail.
|
|
| from_address |
Email address that the email is being sent from. This is the "Reply-to" address that the recipient sees.
|
||
| local_host_name |
Host name used in SMTP headers in the format of a fully qualified domain name. This setting does not refer to the BIG-IP system's hostname.
|
||
|
name
required |
Specifies the name of the SMTP server configuration.
|
||
| partition |
Default: Common
|
Device partition to manage resources on.
|
|
|
password
required |
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable
F5_PASSWORD is set.aliases: pass, pwd |
||
|
provider
(added in 2.5) |
A dict object containing connection details.
|
||
| ssh_keyfile |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
| timeout |
Default: 10
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
|
|
server
required |
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER is set. |
||
|
user
required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable
F5_USER is set. |
||
| server_port |
Default: 443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set. |
|
|
password
required |
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable
F5_PASSWORD is set.aliases: pass, pwd |
||
| validate_certs |
|
If
no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. |
|
|
transport
required |
|
Configures the transport connection to use when connecting to the remote device.
|
|
|
server
required |
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER is set. |
||
|
server_port
(added in 2.2) |
Default: 443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set. |
|
| smtp_server |
SMTP server host name in the format of a fully qualified domain name.
This value is required when create a new SMTP configuration.
|
||
| smtp_server_password |
Password that the SMTP server requires when validating a user.
|
||
| smtp_server_port |
Specifies the SMTP port number.
When creating a new SMTP configuration, the default is
25 when encryption is none or tls. The default is 465 when ssl is selected. |
||
| smtp_server_username |
User name that the SMTP server requires when validating a user.
|
||
| state |
|
When
present, ensures that the SMTP configuration exists.When
absent, ensures that the SMTP configuration does not exist. |
|
| update_password |
|
Passwords are stored encrypted, so the module cannot know if the supplied
smtp_server_password is the same or different than the existing password. This parameter controls the updating of the smtp_server_password credential.When
always, will always update the password.When
on_create, will only set the password for newly created SMTP server configurations. |
|
|
user
required |
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable
F5_USER is set. |
||
|
validate_certs
(added in 2.0) |
|
If
no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. |
|
Note
pip install netaddr.pip install f5-sdk.- name: Create a base SMTP server configuration
bigip_smtp:
name: my-smtp
smtp_server: 1.1.1.1
smtp_server_username: mail-admin
smtp_server_password: mail-secret
local_host_name: smtp.mydomain.com
from_address: no-reply@mydomain.com
password: secret
server: lb.mydomain.com
state: present
user: admin
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
authentication
bool
|
changed |
Whether the authentication parameters are active or not.
Sample:
True
|
|
encryption
string
|
changed |
The new
encryption value of the SMTP configuration.Sample:
tls
|
|
from_address
string
|
changed |
The new
from_address value of the SMTP configuration.Sample:
no-reply@mydomain.com
|
|
local_host_name
string
|
changed |
The new
local_host_name value of the SMTP configuration.Sample:
smtp.mydomain.com
|
|
smtp_server
string
|
changed |
The new
smtp_server value of the SMTP configuration.Sample:
mail.mydomain.com
|
|
smtp_server_port
int
|
changed |
The new
smtp_server_port value of the SMTP configuration.Sample:
25
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.