W3cubDocs

/Ansible

bigip_qkview - Manage qkviews on the device.

New in version 2.4.

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.

Requirements (on host that executes module)

  • f5-sdk >= 2.2.3

Options

parameter required default choices comments
asm_request_log
 no
  • True
  • False
When True, includes the ASM request log data. When False, excludes the ASM request log data.
complete_information
 no True
  • True
  • False
Include complete information in the qkview.
dest
 yes
Destination on your local filesystem when you want to save the qkview.
exclude
 no
  • all
  • audit
  • secure
  • bash_history
Exclude various file from the qkview.
exclude_core
 no
  • True
  • False
Exclude core files from the qkview.
filename
 no localhost.localdomain.qkview
Name of the qkview to create on the remote BIG-IP.
force
 no True
  • True
  • False
If no, the file will only be transferred if the destination does not exist.
max_file_size
 no
Max file size, in bytes, of the qkview to create. By default, no max file size is specified.
password
 yes
The password for the user account used to connect to the BIG-IP. This option can be omitted if the environment variable F5_PASSWORD is set.
server
 yes
The BIG-IP host. This option can be omitted if the environment variable F5_SERVER is set.
server_port
(added in 2.2)
 no 443
The BIG-IP server port. This option can be omitted if the environment variable F5_SERVER_PORT is set.
user
 yes
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. This option can be omitted if the environment variable F5_USER is set.
validate_certs
(added in 2.0)
 no True
  • True
  • False
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. This option can be omitted if the environment variable F5_VALIDATE_CERTS is set.

Examples

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

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
stdout_lines
The value of stdout split into a list
 always list [['...', '...'], ['...'], ['...']]
stdout
The set of responses from the commands
 always list ['...', '...']

Notes

Note

  • Requires the f5-sdk Python package on the host. This is as easy as pip install f5-sdk.
  • This module does not include the “max time” or “restrict to blade” options.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/bigip_qkview_module.html