f5networks.f5_modules.bigip_apm_policy_import 模块 – 管理 BIG-IP APM 策略或 APM 访问配置文件导入

注意

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

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

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

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

f5networks.f5_modules 1.0.0 中的新增功能

概要 

管理 BIG-IP APM 策略或 APM 访问配置文件导入。

参数 

参数	注释
force 布尔值	设置为 `true` 时，任何具有相同名称的现有策略都将被新的导入覆盖。如果策略不存在，则忽略此设置。选项 `false` ← (默认) `true`
name 字符串 / 必需	要创建或覆盖的 APM 策略或 APM 访问配置文件的名称。
partition 字符串	在其中管理资源的设备分区。默认值： `"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` ← (默认)
reuse_objects 布尔值	设置为 `true` 并且策略中引用的对象存在于 BIG-IP 上时，将使用这些对象而不是策略中定义的对象。重用现有对象可以减小配置大小。现有对象的配置可能与策略中定义的对象的配置不同！选项 `false` `true` ← (默认)
source 路径	要导入到 BIG-IP APM 的文件的完整路径。
type 字符串	指定要从设备导出的项目类型。选项 `"profile_access"` ← (默认) `"access_policy"` `"profile_api_protection"`

备注 

注意

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

示例 

- name: Import APM profile
  bigip_apm_policy_import:
    name: new_apm_profile
    source: /root/apm_profile.tar.gz
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Import APM policy
  bigip_apm_policy_import:
    name: new_apm_policy
    source: /root/apm_policy.tar.gz
    type: access_policy
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Override existing APM policy
  bigip_asm_policy:
    name: new_apm_policy
    source: /root/apm_policy.tar.gz
    force: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Import APM profile without re-using existing configuration objects
  bigip_apm_policy_import:
    name: new_apm_profile
    source: /root/apm_profile.tar.gz
    reuse_objects: false
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值 

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

键	描述
force 布尔值	覆盖现有策略或配置文件时设置。返回： changed 示例： `true`
name 字符串	要创建/覆盖的 APM 策略或 APM 访问配置文件的名称。返回： changed 示例： `"APM_policy_global"`
reuse_objects 布尔值	在 BIG-IP 上重用现有对象时设置。返回： changed 示例： `true`
source 字符串	APM 策略文件的本地路径。返回： changed 示例： `"/root/some_policy.tar.gz"`
type 字符串	设置为指定要导出的项目类型。返回： changed 示例： `"access_policy"`

作者

Wojciech Wypior (@wojtek0806)