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

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.31.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

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

Обзор

Управляет созданием и загрузкой QKviews с 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	Объект словаря, содержащий данные подключения.
auth_provider string	Настраивает поставщика авторизации для получения маркеров аутентификации с удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
no_f5_teem boolean	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, установив переменную среды `F5_TELEMETRY_OFF`. Предыдущая переменная `F5_TEEM` устарела, так как её название было запутанным. Варианты: `false` ← (по умолчанию) `true`
password aliases: 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 ← (по умолчанию)

Примечания

Примечание

Этот модуль не включает параметры «максимальное время» или «ограничить до блейда».
Если вы используете этот модуль с 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/f5networks/f5_modules/bigip_qkview_module.html