f5networks.f5_bigip.bigip_qkview (1.13.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_bigip:==1.13.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_bigip
      version: 1.13.0

Description

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.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- hosts: all
  collections:
    - f5networks.f5_bigip
  connection: httpapi

  vars:
    ansible_host: "lb.mydomain.com"
    ansible_user: "admin"
    ansible_httpapi_password: "secret"
    ansible_network_os: f5networks.f5_bigip.bigip
    ansible_httpapi_use_ssl: yes

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

Inputs

    
dest:
    description:
    - Destination on your local filesystem where you want to save the QKview.
    type: path

force:
    default: true
    description:
    - If C(no), the file will only be transferred if the destination does not exist.
    type: bool

exclude:
    choices:
    - all
    - audit
    - secure
    - bash_history
    description:
    - Exclude various file from the QKview.
    elements: str
    type: list

timeout:
    default: 300
    description:
    - The amount of time in seconds to wait for the async interface to complete its task.
    - The accepted value range is between C(10) and C(1800) seconds.
    type: int

filename:
    default: localhost.localdomain.qkview
    description:
    - Name of the QKview file to create on the remote BIG-IP.
    type: str

exclude_core:
    default: false
    description:
    - Exclude core files from the QKview.
    type: bool

max_file_size:
    default: 0
    description:
    - Maximum file size of the QKview file, in bytes. By default, no max file size is
      specified.
    type: int

asm_request_log:
    default: false
    description:
    - When C(true), includes ASM request log data. When C(False), excludes ASM request
      log data.
    type: bool

only_create_file:
    default: false
    description:
    - If C(yes), the file is created on the device and not downloaded. The file will not
      be deleted by the module from the device.
    type: bool
    version_added: 1.10.0
    version_added_collection: f5networks.f5_bigip

complete_information:
    default: false
    description:
    - Include complete (all applicable) information in the QKview.
    type: bool