ansible / ansible.builtin / v2.5.6 / module / bigip_qkview Manage qkviews on the device | "added in version" 2.4 of ansible.builtin" Authors: Tim Rupp (@caphrim007) preview | supported by communityansible.builtin.bigip_qkview (v2.5.6) — module
pip
Install with pip install ansible==2.5.6
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.
- 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
dest: description: - Destination on your local filesystem when you want to save the qkview. required: true 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. filename: default: localhost.localdomain.qkview description: - Name of the qkview to create on the remote BIG-IP. 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: default: 0 description: - Max file size, in bytes, of the qkview to create. By default, no max file size is specified. asm_request_log: default: false description: - When C(True), includes the ASM request log data. When C(False), excludes the ASM request log data. type: bool complete_information: default: true description: - Include complete information in the qkview. type: bool
stdout: description: The set of responses from the commands returned: always sample: - '...' - '...' type: list stdout_lines: description: The value of stdout split into a list returned: always sample: - - '...' - '...' - - '...' - - '...' type: list