f5networks.f5_modules.bigip_apm_policy_fetch 模块 – 从远程节点导出 APM 策略或 APM 访问配置文件。

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

从远程节点导出 APM 策略或 APM 访问配置文件。

参数 

参数	注释
dest 路径	一个用于保存文件的目录。
file 字符串	在远程设备上创建的用于下载的文件名。
force 布尔值	如果 `false`，则仅当文件在目标位置不存在时才会传输文件。选项 `false` `true` ← (默认)
name 字符串 / 必需	导出以在远程设备上创建用于下载的文件的 APM 策略或 APM 访问配置文件的名称。
partition 字符串	包含要导出的 APM 策略或 APM 访问配置文件的设备分区。默认值： `"Common"`
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` ← (默认)
type 字符串	指定要从设备导出的项的类型。选项 `"profile_access"` ← (默认) `"access_policy"`

注释 

注意

由于 ID685681，无法在 v12.x 和 13.x 上通过 REST API 执行 ng_* 工具，一旦此问题修复，此限制将被删除。
需要 BIG-IP >= 14.0.0
有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 的特定配置持久保存到磁盘，请确保至少包含一个使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。有关正确使用模块以保存运行配置的信息，请参阅模块的文档。

示例 

- name: Export APM access profile
  bigip_apm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export APM access policy
  bigip_apm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    type: access_policy
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export APM access profile, autogenerate name
  bigip_apm_policy_fetch:
    name: foobar
    dest: /root/download
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值 

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

键	描述
dest 字符串	下载导出的 APM 策略的本地路径。返回: changed 示例: `"/root/downloads/profile-foobar_file.conf.tar.gz"`
file 字符串	要下载的远程 BIG-IP 上导出的文件名。如果未指定，则这将是一个随机生成的文件名。返回: changed 示例: `"foobar_file"`
name 字符串	要导出的 APM 策略或 APM 访问配置文件的名称。返回: changed 示例: `"APM_policy_global"`
type 字符串	设置为指定要导出的项目类型。返回: changed 示例: `"access_policy"`

作者

Wojciech Wypior (@wojtek0806)