f5networks.f5_modules.bigip_config 模块 – 管理 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_config。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

通过允许修改运行配置的 TMSH 命令或将 SCF 格式的文件合并到运行配置中来管理 BIG-IP 配置。此外，此模块非常重要，因为它允许您将运行配置保存到磁盘。由于所有 F5 模块都操作运行配置，因此务必使用此模块保存该运行配置。

参数 

参数	注释
merge_content 字符串	加载要合并到运行配置中的指定配置。这等效于使用 `tmsh` 命令 `load sys config from-terminal merge`。如果需要从文件或模板读取配置，请分别使用 Ansible 的 `file` 或 `template` 查找插件。
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 布尔值	加载设备上的默认配置。如果指定此选项，则在运行任何命令或其他提供的配置之前加载默认配置。选项 `false` ← (默认) `true`
save 布尔值	`save` 参数指示模块将运行配置保存到启动配置。此操作是在对当前运行配置进行任何更改后执行的。如果没有进行任何更改，配置仍将保存到启动配置。此选项始终导致模块返回已更改。选项 `false` `true` ← (默认)
verify 布尔值	验证指定的配置是否有效以替换运行配置。运行配置不会更改。将此参数设置为 `true` 时，模块不会报告任何更改。选项 `false` ← (默认) `true`

备注 

注意

此模块要求设备上的 sys db 变量 systemauth.disablebash 设置为 false。
有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为确保 BIG-IP 特定配置持久保存到磁盘，请确保至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参阅模块的文档，了解如何正确使用模块保存运行配置。

示例 

- name: Save the running configuration of the BIG-IP
  bigip_config:
    save: true
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost

- name: Reset the BIG-IP configuration, for example, to RMA the device
  bigip_config:
    reset: true
    save: true
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost

- name: Load an SCF configuration
  bigip_config:
    merge_content: "{{ lookup('file', '/path/to/config.scf') }}"
    provider:
      server: lb.mydomain.com
      password: secret
      user: admin
  delegate_to: localhost

返回值 

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

键	描述
stdout 列表 / 元素=字符串	来自选项的响应集。已返回：始终示例： `["...", "..."]`
stdout_lines 列表 / 元素=字符串	标准输出值被分割成一个列表。已返回：始终示例： `[["...", "..."], ["..."], ["..."]]`

作者

Tim Rupp (@caphrim007)