bigip_qkview – Manage qkviews on the device — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_qkview – Manage qkviews on the device

New in version 2.4.

- Synopsis
- Parameters
- Notes
- Examples
- Status

## Synopsis

- Manages creating and downloading qkviews from a BIG-IP. Various options can be provided when creating qkviews. The qkview is important when dealing with F5 support. It may be required that you upload this qkview to the supported channels during resolution of an SRs that you may have opened.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
asm_request_log boolean | Choices: no ← yes | When `True`, includes the ASM request log data. When `False`, excludes the ASM request log data.
complete_information boolean | Choices: no ← yes | Include complete information in the qkview.
dest path / required |  | Destination on your local filesystem when you want to save the qkview.
exclude list | Choices: all audit secure bash_history | Exclude various file from the qkview.
exclude_core boolean | Choices: no ← yes | Exclude core files from the qkview.
filename string | Default: "localhost.localdomain.qkview" | Name of the qkview to create on the remote BIG-IP.
force boolean | Choices: no yes ← | If `no`, the file will only be transferred if the destination does not exist.
max_file_size integer | Default: 0 | Max file size, in bytes, of the qkview to create. By default, no max file size is specified.
provider dictionary added in 2.5 |  | 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.
| password 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`. aliases: pass, pwd
| server string / required |  | The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
| server_port integer | Default: 443 | The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
| ssh_keyfile path |  | Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable `ANSIBLE_NET_SSH_KEYFILE`.
| 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 | Choices: cli rest ← | Configures the transport connection to use when connecting to the remote device.
| 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 | Choices: no yes ← | 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`.

## Notes

Note

- This module does not include the “max time” or “restrict to blade” options.
- If you are using this module with either Ansible Tower or Ansible AWX, you should be aware of how these Ansible products execute jobs in restricted environments. More informat can be found here https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/module-usage-with-tower.html
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires BIG-IP software version >= 12.
- The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

## 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

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]

### Authors

- Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.