f5networks.f5_modules.bigip_ucs 模块 – 管理 UCS 文件的上传、安装和删除

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP 系统上 UCS 文件的上传、安装和删除。用户配置集 (UCS) 是一个备份文件，其中包含 BIG-IP 配置数据，可在发生故障或 RMA 更换时用于完全恢复 BIG-IP 系统。

参数

参数	注释
force 布尔值	如果为 true，则系统每次都上传文件并替换设备上的文件。如果为 false，则仅在文件不存在时才上传文件。通常情况下，只有在您认为映像在上传过程中已损坏的情况下，才应为 true。 选项 false ← (默认) true
include_chassis_level_config 布尔值	在恢复 UCS 文件期间，包含在引导卷集之间共享的底盘级配置。例如，集群默认配置。 选项 false true
no_license 布尔值	执行 UCS 文件及其所有包含文件的完全恢复，但许可证文件除外。此选项必须用于在 RMA（退货授权）设备上恢复 UCS。 选项 false true
no_platform_check 布尔值	绕过平台检查，并允许安装使用不同平台创建的 UCS。默认情况下（无此选项），不允许安装使用不同平台创建的 UCS。 选项 false true
passphrase 字符串	指定加载指定的 UCS 文件所需的密码。
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 ← (默认)
reset_trust 布尔值	指定时，设备和信任域证书和密钥不会从 UCS 加载。相反，将生成一个新集合。 选项 false true
state 字符串	当为 installed 时，确保 UCS 已上传并安装在系统上。当为 present 时，确保 UCS 已上传。当为 absent 时，UCS 将从系统中删除。当为 installed 时，UCS 的上传是幂等的，但是该配置的安装不是幂等的。 选项 "absent" "installed" "present" ← (默认)
ucs 字符串 / 必需	要安装的 UCS 文件路径。如果 state 为 installed 或 activated，则必须提供此参数。当 state 为 absent 时，此参数的完整路径将被忽略，仅使用文件名来选择要移除的 UCS。因此，您可以指定 /foo/bar/test.ucs，此模块只会查找 test.ucs。

备注

注意

• 此模块仅执行最基本的检查。需要考虑其他检查和因素。请参阅 https://support.f5.com/kb/en-us/solutions/public/11000/300/sol11318.html

• 此模块不处理具有 FIPS 140 HSM 的设备。

• 此模块不处理 6400、6800、8400 或 8800 硬件平台上的 BIG-IP 系统。

• 此模块不验证 UCS 文件中的新 SSH 密钥或替换的 SSH 密钥是否已在 BIG-IP 系统和 SCCP 之间同步。

• 此模块不支持“rma”选项。

• 此模块不支持在 BIG-IP 1500、3400、4100、6400、6800 或 8400 硬件平台上还原 UCS 存档，除非该平台是创建备份的系统。

• 只有当目标系统的 hostname 与创建 UCS 存档的系统的 hostname 匹配时，UCS 还原操作才会还原完整配置。如果 hostname 不匹配，则仅还原共享配置。您可以使用 bigip_hostname Ansible 模块在使用此模块之前执行任务来确保 hostname 匹配。

• 此模块不支持重新许可从 UCS 还原的 BIG-IP。

• 此模块不支持在更换的 RMA 设备上还原加密的存档。

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

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

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

示例

- name: Upload UCS
  bigip_ucs:
    ucs: /root/bigip.localhost.localdomain.ucs
    state: present
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Install (upload, install) UCS.
  bigip_ucs:
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Install (upload, install) UCS without installing the license portion
  bigip_ucs:
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    no_license: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Install (upload, install) UCS except the license, and bypassing the platform check
  bigip_ucs:
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    no_license: true
    no_platform_check: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Install (upload, install) UCS using a passphrase necessary to load the UCS
  bigip_ucs:
    ucs: /root/bigip.localhost.localdomain.ucs
    state: installed
    passphrase: MyPassphrase1234
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Remove uploaded UCS file
  bigip_ucs:
    ucs: bigip.localhost.localdomain.ucs
    state: absent
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

资源链接

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