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 以协助进行故障排除。
参数
参数 |
注释 |
---|---|
当 选项
|
|
在 QKview 中包含完整(所有适用)信息。 选项
|
|
您要在本地文件系统中保存 QKview 的目标位置。 |
|
从 QKview 中排除各种文件。 选项
|
|
从 QKview 中排除核心文件。 选项
|
|
要在远程 BIG-IP 上创建的 QKview 文件的名称。 默认: |
|
如果为 选项
|
|
QKview 文件的最大文件大小,以字节为单位。默认情况下,不指定最大文件大小。 |
|
如果为 选项
|
|
包含连接详细信息的 dict 对象。 |
|
配置身份验证提供程序,以便从远程设备获取身份验证令牌。 此选项在处理 BIG-IQ 设备时真正使用。 |
|
如果为 您可以通过设置环境变量 先前使用的变量 选项
|
|
用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 |
|
BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 |
|
BIG-IP 服务器端口。 您可以通过设置环境变量 默认: |
|
指定与网络设备通信(连接或发送命令)的超时时间(以秒为单位)。如果在操作完成之前超时,则模块将出错。 |
|
配置连接到远程设备时使用的传输连接。 选项
|
|
用于连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上具有管理权限。 您可以通过设置环境变量 |
|
如果为 您可以通过设置环境变量 选项
|
注释
注意
此模块不包含“最大时间”或“限制到刀片”选项。
如果您将此模块与 Ansible Tower 或 Ansible AWX 一起使用,您应该了解这些 Ansible 产品如何在受限环境中执行作业。更多信息请参考 https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/module-usage-with-tower.html
一些长时间运行的任务可能会导致 BIG-IP 上的 REST 接口超时,为避免这种情况,请按照此 KB 文章调整计时器 https://support.f5.com/csp/article/K94602685
有关使用 Ansible 管理 F5 Networks 设备的更多信息,请参阅 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块仅操作 F5 产品的运行配置。为了确保 BIG-IP 的特定配置持久保存到磁盘,请务必至少包含一个使用 f5networks.f5_modules.bigip_config 模块来保存运行配置的任务。有关正确使用模块来保存运行配置的信息,请参阅模块的文档。
示例
- 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