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 中添加	包含连接详细信息的 dict 对象。
auth_provider 字符串	配置用于从远程设备获取身份验证令牌的身份验证提供程序。此选项在处理 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 应用程序安全管理器 (ASM) 的许可时，才能使用此选项。选择 `false` `true`

注释 

注意

有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 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)