bigip_qkview – Manage QKviews on the device

New in version 1.0.0.

Synopsis

  • Manages creating and downloading QKviews from a BIG-IP. The qkview utility automatically collects configuration and diagnostic information from BIG-IP systems, and combines the data into a QKView file. F5 Support may request you send or upload this QKview to assist in troubleshooting.

Parameters

Parameter Choices/Defaults Configuration Comments
asm_request_log
boolean
    Choices:
  • no ←
  • yes
When true, includes ASM request log data. When false, excludes ASM request log data.
complete_information
boolean
    Choices:
  • no ←
  • yes
Include complete (all applicable) information in the QKview.
dest
path
Destination on your local filesystem where you want to save the QKview.
exclude
list / elements=string
Exclude various file from the QKview.
Valid elements of the list include: all, audit, secure, bash_history.
exclude_core
boolean
    Choices:
  • no ←
  • yes
Exclude core files from the QKview.
filename
string
Default:
"localhost.localdomain.qkview"
Name of the QKview file to create on the remote BIG-IP.
force
boolean
    Choices:
  • no
  • yes ←
If false, the file will only be transferred if the destination does not exist.
max_file_size
integer
Maximum file size of the QKview file, in bytes. By default, no max file size is specified.
only_create_file
boolean
added in 1.10.0
    Choices:
  • no ←
  • yes
If true, the file is created on the device and not downloaded. The file will not be deleted by the module from the device.
timeout
integer
Default:
300
The amount of time in seconds to wait for the async interface to complete its task.
The accepted value range is between 10 and 1800 seconds.

Notes

Note

Examples

- name: Fetch a qkview from the remote device
  bigip_qkview:
    asm_request_log: true
    exclude:
      - audit
      - secure
    dest: /tmp/localhost.localdomain.qkview

Status

Authors

  • Wojciech Wypior (@wojtek0806)