f5networks.f5_modules.bigip_asm_policy_fetch 模块 – 从远程节点导出 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_fetch。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 从远程节点导出 ASM 策略。

参数

参数	注释
base64 布尔值	如果为 true，则返回的 inline ASM 策略内容将进行 Base64 编码。 仅适用于 inline ASM 策略导出。 选择 false true
binary 布尔值	如果为 true，则导出的 ASM 策略为二进制格式。 仅适用于 file ASM 策略导出。 选择 false true
compact 布尔值	如果为 true，则仅导出 ASM 策略的自定义设置。 仅适用于 XML 类型的 ASM 策略导出。 选择 false true
dest 路径	用于保存策略文件的目录。 当 inline 设置为 true 时，将忽略此选项。
file 字符串	要在远程设备上创建以进行下载的文件的名称。 当 binary 设置为 false 时，ASM 策略为 XML 格式。
force 布尔值	如果为 false，则仅当目标位置不存在该文件时才会传输该文件。 选择 false true ← (默认)
inline 布尔值	如果为 true，则 ASM 策略将以字符串的形式 inline 导出，而不是作为文件导出。 可以在 playbook 的 result 字典中，在 inline_policy 键下检索该策略。 选择 false true
name 字符串 / 必需	导出策略的名称，用于在远程设备上创建文件以进行下载。
partition 字符串	包含要导出的 ASM 策略的设备分区。 默认： "Common"
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的 dict 对象。
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" ← (默认)
用户 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上拥有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不验证 SSL 证书。仅在个人控制的、使用自签名证书的站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选择 false true ← (默认)

说明

注意

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

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

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

示例

- name: Export policy in binary format
  bigip_asm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    binary: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export policy inline base64 encoded format
  bigip_asm_policy_fetch:
    name: foobar
    inline: true
    base64: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export policy in XML format
  bigip_asm_policy_fetch:
    name: foobar
    file: export_foo
    dest: /root/download
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export compact policy in XML format
  bigip_asm_policy_fetch:
    name: foobar
    file: export_foo.xml
    dest: /root/download/
    compact: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Export policy in binary format, autogenerate name
  bigip_asm_policy_fetch:
    name: foobar
    dest: /root/download/
    binary: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
base64 布尔值	设置为以 Base64 格式编码内联导出。 返回: changed 示例: false
binary 布尔值	设置为以二进制格式导出 ASM 策略。 返回: changed 示例: true
compact 布尔值	仅设置为导出自定义 ASM 策略设置。 返回: changed 示例: false
dest 字符串	下载导出的 ASM 策略的本地路径。 返回: changed 示例: "/root/downloads/foobar.xml"
file 字符串	要下载的远程 BIG-IP 上的策略文件名。如果未指定，则这是一个随机生成的文件名。 返回: changed 示例: "foobar.xml"
inline 布尔值	当要导出的 ASM 策略为内联时设置。 返回: changed 示例: true
name 字符串	要导出的 ASM 策略的名称。 返回: changed 示例: "Asm_APP1_Transparent"

作者

• Wojciech Wypior (@wojtek0806)

• Nitin Khanna (@nitinthewiz)

集合链接

• 问题跟踪器
• 主页
• 存储库（源）