f5networks.f5_modules.bigip_qkview (1.28.0) — module

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0

Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.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.

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

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

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

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - The password for the user account used to connect to the BIG-IP or the BIG-IQ.
        - You may omit this option by setting the environment variable C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - 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.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative
          privileges on the device.
        - You may omit this option by setting the environment variable C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(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 C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules

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

max_file_size:
    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(true), 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.20.0
    version_added_collection: f5networks.f5_modules

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