f5networks.f5_modules.bigip_smtp 模块 – 管理 BIG-IP 上的 SMTP 设置

注意

此模块是 f5networks.f5_modules 集合 (版本 1.32.1) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。

要在 playbook 中使用它，请指定：f5networks.f5_modules.bigip_smtp。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 允许通过配置 SMTP 服务器的参数来配置 BIG-IP 以通过 SMTP 服务器发送邮件。

参数

参数	注释
authentication 布尔值	即使该身份验证未被使用（例如，暂存配置或紧急更改），也可以在 SMTP 服务器的配置上设置凭据。此参数用作开关，以使指定的 smtp_server_username 和 smtp_server_password 参数处于活动状态或非活动状态。 当 true 时，身份验证参数处于活动状态。 当 false 时，身份验证参数处于非活动状态。 选项 false true
encryption 字符串	指定 SMTP 服务器是否需要加密连接才能发送邮件。 选项 "none" "ssl" "tls"
from_address 字符串	发送电子邮件的电子邮件地址。这是收件人看到的“回复”地址。
local_host_name 字符串	SMTP 标头中使用的主机名，格式为完全限定域名。此设置不指 BIG-IP 系统的主机名。
name 字符串 / 必需	指定 SMTP 服务器配置的名称。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth 提供程序以从远程设备获取身份验证令牌。 此选项在与 BIG-IQ 设备一起使用时非常有用。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 先前使用的变量 F5_TEEM 已弃用，因为其名称令人困惑。 选项 false ← (默认) true
password 别名：pass、pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
server 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
timeout 整数	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超时，模块将出错。
transport 字符串	配置连接到远程设备时使用的传输连接。 选项 "rest" ← (默认)
user 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
smtp_server 字符串	SMTP 服务器主机名，格式为完全限定域名。 创建新的 SMTP 配置时，此值是必需的。
smtp_server_password 字符串	SMTP 服务器在验证用户时所需的密码。
smtp_server_port 整数	指定 SMTP 端口号。 创建新的 SMTP 配置时，当 encryption 为 none 或 tls 时，默认为 25。当选择 ssl 时，默认为 465。
smtp_server_username 字符串	SMTP 服务器在验证用户时所需的用户名。
state 字符串	当 present 时，确保 SMTP 配置存在。 当 absent 时，确保 SMTP 配置不存在。 选项 "present" ← (默认) "absent"
update_password 字符串	密码存储为加密形式，因此模块无法知道提供的smtp_server_password是否与现有密码相同或不同。此参数控制smtp_server_password凭据的更新。 当设置为always时，系统始终更新密码。 当设置为on_create时，系统仅为新创建的SMTP服务器配置设置密码。 选项 "always" ← (默认) "on_create"

注释

注意

• 有关使用Ansible管理F5网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。

• 需要BIG-IP软件版本 >= 12。

• F5模块仅操作F5产品的运行配置。为确保BIG-IP特定配置持久保存到磁盘，请务必包含至少一项使用f5networks.f5_modules.bigip_config模块保存运行配置的任务。请参考模块文档，了解保存运行配置的正确使用方法。

示例

- 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

返回值

常用返回值已在此处记录，以下是此模块特有的字段

键	描述
authentication 布尔值	身份验证参数是否处于活动状态。 返回：changed 示例：true
encryption 字符串	SMTP配置的新encryption值。 返回：changed 示例："tls"
from_address 字符串	SMTP配置的新from_address值。 返回：changed 示例："[email protected]"
local_host_name 字符串	SMTP配置的新local_host_name值。 返回：changed 示例："smtp.mydomain.com"
smtp_server 字符串	SMTP配置的新smtp_server值。 返回：changed 示例："mail.mydomain.com"
smtp_server_port 整数	SMTP配置的新smtp_server_port值。 返回：changed 示例：25

作者

• Tim Rupp (@caphrim007)

集合链接

• 问题追踪器
• 主页
• 代码库 (源码)