Note
This plugin is part of the f5networks.f5_modules collection.
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 version 1.0.0: of f5networks.f5_modules
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| authentication boolean |
| 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 smtp_server_username and smtp_server_password parameters active or not.When yes, the authentication parameters are active.When no, the authentication parameters are inactive. | |
| encryption string |
| Specifies whether the SMTP server requires an encrypted connection in order to send mail. | |
| from_address string | Email address the email is being sent from. This is the "Reply-to" address the recipient sees. | ||
| local_host_name string | 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. | ||
| name string / required | Specifies the name of the SMTP server configuration. | ||
| partition string | Default: "Common" | Device partition to manage resources on. | |
| provider dictionary added in 1.0.0 of f5networks.f5_modules | A dict object containing connection details. | ||
| auth_provider string | Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. | ||
| no_f5_teem boolean |
| If yes, TEEM telemetry data is not sent to F5.You may omit this option by setting the environment variable F5_TEEM. | |
| password string / required | The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable F5_PASSWORD.aliases: pass, pwd | ||
| server string / required | The BIG-IP host. You may omit this option by setting the environment variable F5_SERVER. | ||
| server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable F5_SERVER_PORT. | |
| timeout integer | 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. | ||
| transport string |
| Configures the transport connection to use when connecting to the remote device. | |
| user string / required | The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable F5_USER. | ||
| validate_certs boolean |
| If no, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.You may omit this option by setting the environment variable F5_VALIDATE_CERTS. | |
| smtp_server string | SMTP server host name in the format of a fully qualified domain name. This value is required when creating a new SMTP configuration. | ||
| smtp_server_password string | Password the SMTP server requires when validating a user. | ||
| smtp_server_port integer | 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 string | User name the SMTP server requires when validating a user. | ||
| state string |
| When present, ensures the SMTP configuration exists.When absent, ensures the SMTP configuration does not exist. | |
| update_password string |
| 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, the system always updates the password.When on_create, the system only sets the password for newly created SMTP server configurations. | |
Note
- 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
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| authentication boolean | 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: |
| 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 integer | changed | The new smtp_server_port value of the SMTP configuration.Sample: 25 |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/f5networks/f5_modules/bigip_smtp_module.html