f5networks.f5_modules.bigip_asm_policy_import 模块 – 管理 BIG-IP ASM 策略导入

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理 BIG-IP ASM 策略的策略导入。

参数

参数

注释

base64

布尔值

指示导入的策略字符串是否以 Base64 编码。

此参数仅在使用 inline 导入方法时生效。

选项

  • false

  • true

encoding

字符串

指定导入策略的所需应用程序语言。

当设置 auto-detect 编码时，导入的策略不能是 parent 类型，也不能附加到 parent 策略。

当导入策略以附加到 parent 策略时，如果导入策略的 encoding 不同，则必须将其设置为与 parent_policy 相同的值，否则导入将失败。

此参数在 TMOS 版本 13.x 及更高版本上可用，并且仅在使用 inline 导入方法时生效。

选项

  • "windows-874"

  • "utf-8"

  • "koi8-r"

  • "windows-1253"

  • "iso-8859-10"

  • "gbk"

  • "windows-1256"

  • "windows-1250"

  • "iso-8859-13"

  • "iso-8859-9"

  • "windows-1251"

  • "iso-8859-6"

  • "big5"

  • "gb2312"

  • "iso-8859-1"

  • "windows-1252"

  • "iso-8859-4"

  • "iso-8859-2"

  • "iso-8859-3"

  • "gb18030"

  • "shift_jis"

  • "iso-8859-8"

  • "euc-kr"

  • "iso-8859-5"

  • "iso-8859-7"

  • "windows-1255"

  • "euc-jp"

  • "iso-8859-15"

  • "windows-1257"

  • "iso-8859-16"

  • "auto-detect"

force

布尔值

设置为 true 时，任何具有相同名称的现有策略都将被新的导入覆盖。

这适用于内联导入和文件导入，如果策略不存在，则此设置将被忽略。

选项

  • false ←（默认）

  • true

inline

字符串

指定后，将从提供的字符串创建 ASM 策略。

内容需要以有效的 XML 格式提供，否则操作将失败。

name

字符串 / 必需

要创建或覆盖的 ASM 策略。

parent_policy

字符串

新导入的策略应作为子策略附加到的父策略。

当指定 parent_policy 时，导入的 policy_type 不能为 parent。

此参数在 TMOS 版本 13.x 及更高版本上可用，并且仅在使用 inline 导入方法时生效。

partition

字符串

在其上创建策略的设备分区。

此参数也用于指示 parent 策略的分区。

默认值： "Common"

policy_type

字符串

要导入的策略的类型。

当 policy_type 为 security 时，该策略将作为应用程序安全策略导入，您可以将其应用于虚拟服务器。

当 policy_type 为 parent 时，该策略将成为其他安全策略附加到的父策略，从而继承其属性。此策略类型不能应用于虚拟服务器。

此参数在 TMOS 版本 13.x 及更高版本上可用，并且仅在使用 inline 导入方法时生效。

选项

  • "security" ←（默认）

  • "parent"

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

integer

BIG-IP 服务器端口。

您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。

默认值: 443

timeout

integer

指定与网络设备通信（用于连接或发送命令）的超时时间（以秒为单位）。 如果在操作完成之前超出超时时间，模块将出错。

transport

字符串

配置连接到远程设备时要使用的传输连接。

选项

  • "rest" ← (默认)

user

字符串 / 必需

用于连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。

您可以通过设置环境变量 F5_USER 来省略此选项。

validate_certs

布尔值

如果为 no，则不验证 SSL 证书。 仅在个人控制的站点上使用自签名证书时才使用此选项。

您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。

选项

  • false

  • true ← (默认)

retain_inheritance_settings

布尔值

指示导入的安全类型策略在附加到父策略时是否应保留设置。

此参数在 TMOS 版本 13.x 及更高版本上可用，并且仅在使用 inline 导入方法时生效。

选项

  • false

  • true

source

path

要导入到 BIG-IP ASM 的策略文件的完整路径。

从较新版本的 BIG-IP 导出的策略文件无法导入到较旧版本的 BIG-IP 中。 但是，可以将旧版本的 BIG-IP 中的策略文件导入到较新版本的 BIG-IP 中。

文件格式可以是二进制或 XML。

备注

注意

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

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

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

示例

- name: Import ASM policy
  bigip_asm_policy_import:
    name: new_asm_policy
    file: /root/asm_policy.xml
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Import ASM policy inline
  bigip_asm_policy_import:
    name: foo-policy4
    inline: <xml>content</xml>
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Override existing ASM policy
  bigip_asm_policy:
    name: new_asm_policy
    source: /root/asm_policy_new.xml
    force: true
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

键

描述

base64

布尔值

指示导入的策略字符串是否以 Base64 编码。

已返回: changed

示例: true

encoding

字符串

导入策略的所需应用程序语言。

已返回: changed

示例: "utf-8"

force

布尔值

在覆盖现有策略时设置。

已返回: changed

示例: true

inline

字符串

策略的内容，作为内联字符串。

已返回: changed

示例: "<xml>foobar contents</xml>"

name

字符串

要创建/覆盖的 ASM 策略的名称。

已返回: changed

示例: "Asm_APP1_Transparent"

parent_policy

字符串

新导入的策略应作为子策略附加到的父策略。

已返回: changed

示例: "/Common/parent"

policy_type

字符串

要导入的策略的类型。

已返回: changed

示例: "security"

retain_inheritance_settings

布尔值

指示导入的安全类型策略在附加到父策略时是否应保留设置。

已返回: changed

示例: true

source

字符串

ASM 策略文件的本地路径。

已返回: changed

示例: "/root/some_policy.xml"

作者

  • Wojciech Wypior (@wojtek0806)

  • Nitin Khanna (@nitinthewiz)