f5networks.f5_modules.bigip_file_copy 模块 – 管理 BIG-IP 数据存储中的文件

注意

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

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

要安装它,请使用: ansible-galaxy collection install f5networks.f5_modules

要在剧本中使用它,请指定: f5networks.f5_modules.bigip_file_copy

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 BIG-IP 上各种数据存储中的文件。

参数

参数

注释

datastore

字符串

指定要将文件放入的数据存储。

有几个不同的数据存储,每个数据存储都允许以不同的方式公开文件。

当为 external-monitor 时,指定的文件将存储为外部监控文件,并可用于外部监控。

当为 ifile 时,指定的文件将存储为 iFile。

当为 lw4o6-table 时,指定的文件将存储为轻量级 4 over 6 (lw4o6) 隧道绑定表,其中包括 lwB4 的 IPv6 地址、公共 IPv4 地址和受限端口集。

选项

  • "external-monitor"

  • "ifile" ← (默认)

  • "lw4o6-table"

force

布尔值

强制覆盖文件。

默认情况下,只有在给定文件名文件的 SHA 值不同时才会覆盖文件。此参数可用于即使文件已存在且其 SHA 值匹配也强制覆盖文件。

lw4o6-table 数据存储不会保留其文件的校验和。因此,您需要提供此参数来更新任何这些文件。

选项

  • false ← (默认)

  • true

name

字符串

文件在 BIG-IP 上应驻留的文件名。

如果未指定此参数,则使用 source 参数中提供的文件名。

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 ← (默认)

source

别名:src

path

指定要上传文件的路径。

如果statepresent,则此参数是必需的。

state

字符串

present时,确保资源存在。

absent时,确保资源被移除。

选项

  • "present" ← (默认)

  • "absent"

注释

注意

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

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

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

示例

- name: Upload a file as an iFile
  bigip_file_copy:
    name: foo
    source: /path/to/file.txt
    datastore: ifile
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

# Upload a directory of files
- name: Recursively upload web related files in /var/tmp/project
  find:
    paths: /var/tmp/project
    patterns: "^.*?\\.(?:html|?:css|?:js)$"
    use_regex: true
  register: f

- name: Upload a directory of files as a set of iFiles
  bigip_file_copy:
    source: "{{ item.path }}"
    datastore: ifile
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
    loop: f
  delegate_to: localhost
# End upload a directory of files

- name: Upload a file to use in an external monitor
  bigip_file_copy:
    source: /path/to/files/external.sh
    datastore: external-monitor
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

作者

  • Tim Rupp (@caphrim007)