f5networks.f5_modules.bigip_qkview module – Manage QKviews on the device

Note

This module is part of the f5networks.f5_modules collection (version 1.17.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_qkview.

New in version 1.0.0: of f5networks.f5_modules

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

Comments

asm_request_log

boolean

When true, includes ASM request log data. When False, excludes ASM request log data.

Choices:

  • no ← (default)

  • yes

complete_information

boolean

Include complete (all applicable) information in the QKview.

Choices:

  • no ← (default)

  • yes

dest

path / required

Destination on your local filesystem where you want to save the QKview.

exclude

list / elements=string

Exclude various file from the QKview.

Choices:

  • all

  • audit

  • secure

  • bash_history

exclude_core

boolean

Exclude core files from the QKview.

Choices:

  • no ← (default)

  • yes

filename

string

Name of the QKview file to create on the remote BIG-IP.

Default: “localhost.localdomain.qkview”

force

boolean

If no, the file will only be transferred if the destination does not exist.

Choices:

  • no

  • yes ← (default)

max_file_size

integer

Maximum file size of the QKview file, in bytes. By default, no max file size is specified.

Default: 0

provider

dictionary

added in 1.0.0 of f5networks.f5_modules

A dict object containing connection details.

auth_provider

string

Configures the auth provider for to obtain authentication tokens from the remote device.

This option is really used when working with BIG-IQ devices.

no_f5_teem

boolean

If yes, TEEM telemetry data is not sent to F5.

You may omit this option by setting the environment variable F5_TELEMETRY_OFF.

Previously used variable F5_TEEM is deprecated as its name was confusing.

Choices:

  • no ← (default)

  • yes

password

aliases: pass, pwd

string / required

The password for the user account used to connect to the BIG-IP.

You may omit this option by setting the environment variable F5_PASSWORD.

server

string / required

The BIG-IP host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

integer

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

Default: 443

timeout

integer

Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.

transport

string

Configures the transport connection to use when connecting to the remote device.

Choices:

  • rest ← (default)

user

string / required

The username to connect to the BIG-IP with. This user must have administrative privileges on the device.

You may omit this option by setting the environment variable F5_USER.

validate_certs

boolean

If no, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.

You may omit this option by setting the environment variable F5_VALIDATE_CERTS.

Choices:

  • no

  • yes ← (default)

Notes

Note

Examples

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

Authors

  • Tim Rupp (@caphrim007)