f5networks.f5_modules.bigip_smtp module – Manages SMTP settings on the BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
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 f5networks.f5_modules
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_smtp
.
New in f5networks.f5_modules 1.0.0
Synopsis
Allows configuring of the BIG-IP to send mail via an SMTP server by configuring the parameters of an SMTP server.
Parameters
Parameter |
Comments |
---|---|
Credentials can be set on an SMTP server’s configuration even if that authentication is not used (for example, staging configs or emergency changes). This parameter acts as a switch to make the specified When When Choices:
|
|
Specifies whether the SMTP server requires an encrypted connection in order to send mail. Choices:
|
|
Email address from which the email is being sent. This is the “Reply-to” address the recipient sees. |
|
Hostname used in SMTP headers in the format of a fully qualified domain name. This setting does not refer to the hostname of the BIG-IP system. |
|
Specifies the name of the SMTP server configuration. |
|
Device partition to manage resources on. Default: |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
SMTP server host name in the format of a fully qualified domain name. This value is required when creating a new SMTP configuration. |
|
Password the SMTP server requires when validating a user. |
|
Specifies the SMTP port number. When creating a new SMTP configuration, the default is |
|
User name the SMTP server requires when validating a user. |
|
When When Choices:
|
|
Passwords are stored encrypted, so the module cannot know if the supplied When When Choices:
|
Notes
Note
For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples
- 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: [email protected]
state: present
provider:
user: admin
password: secret
server: lb.mydomain.com
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Whether the authentication parameters are active or not. Returned: changed Sample: |
|
The new Returned: changed Sample: |
|
The new Returned: changed Sample: |
|
The new Returned: changed Sample: |
|
The new Returned: changed Sample: |
|
The new Returned: changed Sample: |