f5networks.f5_modules.bigip_ucs_fetch 模块 – 从远程节点获取 UCS 文件

注意

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

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

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

要在剧本中使用它，请指定：f5networks.f5_modules.bigip_ucs_fetch。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 此模块用于从远程计算机获取 UCS 文件并将其存储在本地文件树中，按主机名进行组织。此模块旨在创建和传输可能不存在的 UCS 文件，它不需要预先创建 UCS 文件。因此，除非将 fail_on_missing 设置为“yes”，否则缺少远程 UCS 不是错误。

参数

参数	注释
async_timeout 整数	在设备上创建新的 UCS 文件时使用的参数。 等待 API 异步接口完成其任务的秒数。 可接受的值范围介于 150 和 1800 秒之间。 默认值： 150
attributes 别名：attr 字符串	生成的 文件系统对象应具有的属性。 要获取支持的标志，请查看目标系统上 chattr 的手册页。 此字符串应按 lsattr 显示的顺序包含属性。 假设 = 运算符为默认值，否则需要在字符串中包含 + 或 - 运算符。
backup 布尔值	创建一个包含时间戳信息的备份文件，以便如果错误地覆盖了文件，可以找回原始文件。 选项 false ← (默认) true
create_on_missing 布尔值	如果远程系统上该文件尚不存在，则根据 src 的值创建 UCS。 当设置为 false 时，如果 fail_on_missing 设置为 false，如果设备上缺少 ucs 文件，则模块将返回无更改。 选项 false true ← (默认)
dest 路径	保存 UCS 文件的目录。 当 only_create_file 设置为 false 时，此选项是必需的。
encryption_password 字符串	如果需要，用于加密 UCS 文件的密码。
fail_on_missing 布尔值	如果远程系统上缺少 UCS 文件，则使模块失败。 此选项始终优先于 create_on_missing，因此，当设置为 true 时，即使 create_on_missing 选项设置为 true，如果缺少 UCS，模块也将始终失败。 当设置为 false 时，如果 create_on_missing 设置为 false，如果设备上缺少 ucs 文件，则模块将返回无更改。 选项 false ← (默认) true
force 布尔值	如果为 false，则只有在目标文件不存在时才传输文件。 选项 false true ← (默认)
group 字符串	应该拥有文件系统对象的组的名称，就像传递给 chown 一样。 如果未指定，则它使用当前用户的当前组，除非您是 root 用户，在这种情况下，它可以保留之前的拥有者。
mode 任意	生成的 文件系统对象应具有的权限。 对于习惯使用/usr/bin/chmod的用户来说，请记住权限模式实际上是八进制数。您必须向 Ansible 提供足够的信息以便其正确解析这些数字。为了获得一致的结果，请用引号括起八进制数（例如，'644' 或 '1777'），这样 Ansible 就会接收到一个字符串，并可以自行将字符串转换为数字。添加前导零（例如，0755）有时有效，但在循环和其他一些情况下可能会失败。 如果不遵循以上任一规则而直接向 Ansible 提供数字，则最终会得到一个十进制数，这将导致意外的结果。 从 Ansible 1.8 版本开始，模式可以指定为符号模式（例如，u+rwx 或 u=rw,g=r,o=r）。 如果未指定mode，并且目标文件系统对象**不存在**，则在设置新创建的文件系统对象的模式时，将使用系统上的默认umask。 如果未指定mode，并且目标文件系统对象**存在**，则将使用现有文件系统对象的模式。 指定mode 是确保以正确的权限创建文件系统对象的最佳方法。有关更多详细信息，请参阅 CVE-2020-1736。
only_create_file 布尔值 在 f5networks.f5_modules 1.12.0 中添加	如果为true，则会在设备上创建文件，而不是下载文件。如果 UCS 存档存在于设备上，则不会进行任何更改，也不会下载文件。 要重新创建留在设备上的 UCS 文件，请使用bigip_ucs 模块删除它们，然后在将only_create_file 设置为true 的情况下运行此模块。 选项 false ← (默认) true
owner 字符串	应该拥有文件系统对象的用户名，如同传递给chown一样。 如果未指定，则使用当前用户，除非您是 root 用户，在这种情况下，它可以保留之前的拥有者。 指定数字用户名将被视为用户 ID 而不是用户名。避免使用数字用户名以避免此混淆。
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
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 ← (默认)
selevel 字符串	SELinux 文件系统对象上下文中的级别部分。 这是 MLS/MCS 属性，有时称为range。 设置为_default 时，如果可用，它将使用策略的level 部分。
serole 字符串	SELinux 文件系统对象上下文的角色部分。 设置为_default 时，如果可用，它将使用策略的role 部分。
setype 字符串	SELinux 文件系统对象上下文中的类型部分。 设置为_default 时，如果可用，它将使用策略的type 部分。
seuser 字符串	SELinux 文件系统对象上下文的用户部分。 默认情况下，它使用system 策略（如果适用）。 设置为_default 时，如果可用，它将使用策略的user 部分。
src 字符串	要在远程服务器上创建以供下载的 UCS 文件的名称。 文件将被检索或创建在 /var/local/ucs/ 中。 当only_create_file 设置为true 时，此选项是必需的。
unsafe_writes 布尔值	影响何时使用原子操作来防止目标文件系统对象的数据损坏或不一致读取。 默认情况下，此模块使用原子操作来防止目标文件系统对象的数据损坏或不一致读取，但有时系统配置或损坏的方式会阻止此操作。一个例子是 docker 挂载的文件系统对象，无法从容器内部以原子方式更新，只能以不安全的方式写入。 此选项允许 Ansible 在原子操作失败时回退到不安全的文件系统对象更新方法（但是，它不会强制 Ansible 执行不安全的写入）。 重要！不安全的写入容易出现竞争条件，并可能导致数据损坏。 选项 false ← (默认) true

注释

注意

• BIG-IP 没有提供任何方法可以通过任何接口获取系统上 UCS 文件的校验和，可能例外的是直接登录到框中（这将不支持设备模式）。因此，此模块所能做的最好的事情就是检查磁盘上文件是否存在；不进行校验和计算。

• 如果您将此模块与 Ansible Tower 或 Ansible AWX 一起使用，则应了解这些 Ansible 产品如何在受限环境中执行作业。更多信息可以在此处找到 https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/module-usage-with-tower.html

• 一些运行时间较长的任务可能会导致 BIG-IP 上的 REST 接口超时，为避免这种情况，请根据此 KB 文章调整计时器 https://support.f5.com/csp/article/K94602685

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

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

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

示例

- name: Download a new UCS
  bigip_ucs_fetch:
    src: cs_backup.ucs
    dest: /tmp/cs_backup.ucs
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Only create new UCS, no download
  bigip_ucs_fetch:
    src: cs_backup.ucs
    only_create_file: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Recreate UCS file left on device - remove file first
  bigip_ucs:
    ucs: cs_backup.ucs
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Recreate UCS file left on device - create new file
  bigip_ucs_fetch:
    src: cs_backup.ucs
    only_create_file: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

键	描述
backup_file 字符串	备份文件的名称。 返回：已更改以及如果 backup=yes 示例："/path/to/file.txt.2015-02-12@22:09~"
checksum 字符串	下载文件的 SHA1 校验和。 返回：成功或已更改 示例："7b46bbe4f8ebfee64761b5313855618f64c64109"
dest 字符串	UCS 保存到的 Ansible 主机上的位置。 返回：成功 示例："/path/to/file.txt"
gid 整数	执行后 UCS 文件的组 ID。 返回：成功 示例：100
group 字符串	执行后 UCS 文件的组。 返回：成功 示例： "httpd"
md5sum 字符串	下载文件的MD5校验和。 返回： changed 或 success 示例： "96cacab4c259c4598727d7cf2ceb3b45"
mode 字符串	执行后目标UCS的权限。 返回：成功 示例： "420"
owner 字符串	执行后UCS文件的拥有者。 返回：成功 示例： "httpd"
size 整数	执行后目标UCS的大小。 返回：成功 示例： 1220
src 字符串	要从远程BIG-IP下载的UCS文件名。如果未指定，则为随机生成的名称。 返回： changed 示例： "cs_backup.ucs"
uid 整数	执行后UCS文件的拥有者ID。 返回：成功 示例：100

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

资源链接

• 问题追踪
• 主页
• 代码仓库