Модуль f5networks.f5_modules.bigip_qkview — управление QKview на устройстве

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать её в плейбуке, укажите: f5networks.f5_modules.bigip_qkview.

Добавлено в f5networks.f5_modules 1.0.0

Обзор
Параметры
Примечания
Примеры

Обзор

Управляет созданием и загрузкой QKview с BIG-IP. Утилита qkview автоматически собирает сведения о конфигурации и диагностические данные систем BIG-IP и объединяет их в файл QKView. Служба поддержки F5 может попросить вас отправить или загрузить этот файл QKview для помощи в устранении неполадок.

Параметры

Параметр	Комментарии
asm_request_log boolean	Если `true`, включает данные журнала запросов ASM. Если `False`, исключает данные журнала запросов ASM. Варианты: `false` ← (по умолчанию) `true`
complete_information boolean	Включает в QKview полную (всю применимую) информацию. Варианты: `false` ← (по умолчанию) `true`
dest path	Путь в локальной файловой системе, по которому нужно сохранить QKview.
exclude list / elements=string	Исключает из QKview различные файлы. Варианты: `"all"` `"audit"` `"secure"` `"bash_history"`
exclude_core boolean	Исключает из QKview файлы дампа памяти. Варианты: `false` ← (по умолчанию) `true`
filename string	Имя файла QKview, который нужно создать на удалённом устройстве BIG-IP. По умолчанию: `"localhost.localdomain.qkview"`
force boolean	Если `no`, файл будет передан, только если файл назначения не существует. Варианты: `false` `true` ← (по умолчанию)
max_file_size integer	Максимальный размер файла QKview в байтах. По умолчанию максимальный размер файла не задан.
only_create_file boolean добавлено в f5networks.f5_modules 1.20.0	Если `true`, файл создаётся на устройстве, но не загружается. Модуль не удаляет файл с устройства. Варианты: `false` ← (по умолчанию) `true`
provider dictionary добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider string	Настраивает поставщика аутентификации, используемого для получения токенов аутентификации с удалённого устройства. Этот параметр используется главным образом при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную окружения `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` объявлена устаревшей, так как её название было неоднозначным. Варианты: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd string / обязательный	Пароль учётной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_PASSWORD`.
server string / обязательный	Узел BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER`.
server_port integer	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную окружения `F5_SERVER_PORT`. По умолчанию: `443`
timeout integer	Задаёт время ожидания в секундах при взаимодействии с сетевым устройством — при подключении или отправке команд. Если время ожидания истечёт до завершения операции, модуль завершится с ошибкой.
transport string	Настраивает транспортное соединение для подключения к удалённому устройству. Варианты: `"rest"` ← (по умолчанию)
user string / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную окружения `F5_USER`.
validate_certs boolean	Если `no`, сертификаты SSL не проверяются. Используйте этот параметр только на контролируемых вами сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную окружения `F5_VALIDATE_CERTS`. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Этот модуль не поддерживает параметры «max time» и «restrict to blade».
Если вы используете этот модуль с Ansible Tower или Ansible AWX, учитывайте, как эти продукты Ansible выполняют задания в ограниченных средах. Дополнительную информацию можно найти здесь: https://clouddocs.f5.com/products/orchestration/ansible/devel/usage/module-usage-with-tower.html
Некоторые длительные задачи могут привести к тайм-ауту REST-интерфейса BIG-IP. Чтобы этого избежать, настройте таймеры согласно статье базы знаний: https://support.f5.com/csp/article/K94602685
Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия программного обеспечения BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы обеспечить сохранение конфигурации BIG-IP на диск, включите как минимум одну задачу, использующую модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Правила использования модуля для сохранения текущей конфигурации см. в его документации.

Примеры

- 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

Авторы

Tim Rupp (@caphrim007)

Ссылки на коллекцию

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