f5networks.f5_modules.bigip_qkview 模块 – 管理设备上的 QKviews

注意

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

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

要安装它,请使用: ansible-galaxy collection install f5networks.f5_modules

要在剧本中使用它,请指定: f5networks.f5_modules.bigip_qkview

f5networks.f5_modules 1.0.0 中的新增功能

概要

  • 管理从 BIG-IP 创建和下载 QKviews。qkview 实用程序会自动从 BIG-IP 系统收集配置和诊断信息,并将数据组合到 QKView 文件中。F5 支持可能要求您发送或上传此 QKview 以协助进行故障排除。

参数

参数

注释

asm_request_log

布尔值

true 时,包含 ASM 请求日志数据。当 False 时,排除 ASM 请求日志数据。

选项

  • false ← (默认)

  • true

complete_information

布尔值

在 QKview 中包含完整(所有适用)的信息。

选项

  • false ← (默认)

  • true

dest

路径

您要保存 QKview 的本地文件系统上的目标位置。

exclude

列表 / 元素=字符串

从 QKview 中排除各种文件。

选项

  • "all"

  • "audit"

  • "secure"

  • "bash_history"

exclude_core

布尔值

从 QKview 中排除核心文件。

选项

  • false ← (默认)

  • true

filename

字符串

要在远程 BIG-IP 上创建的 QKview 文件的名称。

默认值: "localhost.localdomain.qkview"

force

布尔值

如果 no,只有在目标文件不存在时才会传输文件。

选项

  • false

  • true ← (默认)

max_file_size

整数

QKview 文件的最大文件大小(以字节为单位)。默认情况下,不指定最大文件大小。

only_create_file

布尔值

f5networks.f5_modules 1.20.0 中新增

如果 true,则在设备上创建文件而不下载。模块不会从设备删除该文件。

选项

  • false ← (默认)

  • true

provider

字典

f5networks.f5_modules 1.0.0 中新增

包含连接详细信息的字典对象。

auth_provider

字符串

配置 auth 提供程序以从远程设备获取身份验证令牌。

此选项在使用 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 ← (默认)

备注

注意

示例

- name: Fetch a qkview from the remote device
  bigip_qkview:
    asm_request_log: true
    exclude:
      - audit
      - secure
    dest: /tmp/localhost.localdomain.qkview
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

作者

  • Tim Rupp (@caphrim007)