f5networks.f5_modules.bigip_profile_ftp 模块 – 管理 FTP 配置文件

注意

此模块是 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_profile_ftp。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP 系统上的 FTP 配置文件。

参数

参数	注释
allow_ftps 布尔值	允许显式 FTPS 协商。 选项 false true
description 字符串	配置文件的描述。
inherit_parent_profile 布尔值	使 FTP 数据通道继承控制通道使用的 TCP 配置文件。 当 false 时，数据通道仅使用 FastL4 (BigProto)。 选项 false true
log_profile 字符串	配置控制日志记录的 ALG 日志配置文件。
log_publisher 字符串	配置处理此配置文件事件日志记录的日志发布者。
name 字符串 / 必需	指定配置文件的名称。
parent 字符串	指定此配置文件继承设置的配置文件。 创建新配置文件时，如果未指定此参数，则默认为系统提供的 ftp 配置文件。
partition 字符串	管理资源的设备分区。 默认值： "Common"
port 整数	指定此 FTP 配置文件使用的数据通道端口的服务。 有效值范围介于 0 和 65535（包含）。
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 ← (默认)
security 布尔值	为 BIG-IP 应用安全管理器启用安全的 FTP 通信。 只有在系统已获得 BIG-IP ASM 许可的情况下才能使用此选项。 选项 false true
state 字符串	当 state 为 present 时，确保 ftp 配置文件存在。 当 state 为 absent 时，确保 ftp 配置文件已删除。 选项 "present" ← (默认) "absent"
translate_extended 布尔值	在与IPv4服务器通信时，将RFC 2428扩展请求EPSV和EPRT转换为PASV和PORT。 只有在系统已获得BIG-IP Application Security Manager (ASM)许可证的情况下才能使用此选项。 选项 false true

注释

注意

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

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

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

示例

- name: Create an ftp profile
  bigip_profile_ftp:
    name: foo
    parent: /Common/barfoo
    port: 2221
    allow_ftps: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Modify an ftp profile
  bigip_profile_ftp:
    name: foo
    log_profile: /Common/alg_log
    log_publisher: /Common/foo_publisher
    security: true
    description: my description
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove an ftp profile
  bigip_profile_ftp:
    name: foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
allow_ftps 布尔值	允许显式FTPS协商。 返回：changed 示例：true
description 字符串	配置文件的描述。 返回：changed 示例："Foo is bar"
inherit_parent_profile 布尔值	使 FTP 数据通道继承控制通道使用的 TCP 配置文件。 返回：changed 示例：false
log_profile 字符串	控制日志记录的ALG日志配置文件。 返回：changed 示例："/Common/foo_log_profile"
log_publisher 列表 / 元素=字符串	处理此配置文件事件日志记录的日志发布者的名称。 返回：changed 示例：["/Common/publisher_1"]
parent 字符串	指定此配置文件继承设置的配置文件。 返回：changed 示例："/Common/ftp"
port 整数	指定此 FTP 配置文件使用的数据通道端口的服务。 返回：changed 示例：20
security 布尔值	为 BIG-IP 应用安全管理器启用安全的 FTP 通信。 返回：changed 示例：false
translate_extended 布尔值	在与IPv4服务器通信时转换RFC 2428扩展请求。 返回：changed 示例：true

作者

• Wojciech Wypior (@wojtek0806)

资源链接

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