f5networks.f5_modules.bigip_profile_analytics – Управление профилями аналитики HTTP на BIG-IP

Примечание

Этот плагин входит в состав коллекции f5networks.f5_modules (версия 1.6.0).

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

Для использования в книге задач укажите: f5networks.f5_modules.bigip_profile_analytics.

Добавлена в версии 1.0.0: коллекции f5networks.f5_modules

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

Обзор

Управление профилями аналитики HTTP на устройстве BIG-IP.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
collect_geo boolean		Варианты: no yes	Включает или отключает сбор имен стран, откуда отправлялся трафик.
collect_ip boolean		Варианты: no yes	Включает или отключает сбор статистики по IP-адресам клиентов.
collect_max_tps_and_throughput boolean		Варианты: no yes	Включает или отключает сбор максимального TPS и пропускной способности для всех собранных сущностей.
collect_page_load_time boolean		Варианты: no yes	Включает или отключает сбор статистики времени загрузки страницы.
collect_url boolean		Варианты: no yes	Включает или отключает сбор статистики запрошенных URL.
collect_user_agent boolean		Варианты: no yes	Включает или отключает сбор информации о user agent.
collect_user_sessions boolean		Варианты: no yes	Включает или отключает сбор уникальных пользовательских сессий.
collected_stats_external_logging boolean		Варианты: no yes	Включает или отключает внешнюю запись собранной статистики.
collected_stats_internal_logging boolean		Варианты: no yes	Включает или отключает внутреннюю запись собранной статистики.
description string			Описание профиля.
external_logging_publisher string			Указывает внешнего издателя журналов, используемого для отправки статистических данных на один или несколько пунктов назначения.
name string / обязательно			Указывает имя профиля.
notification_by_email boolean		Варианты: no yes	Включает или отключает отправку оповещений по аналитике по электронной почте.
notification_by_syslog boolean		Варианты: no yes	Включает или отключает запись оповещений аналитики в Syslog.
notification_email_addresses список / элементы=строка			Указывает электронные адреса, получающие оповещения по электронной почте, когда `notification_by_email` включено.
parent строка			Указывает профиль, от которого данный профиль наследует настройки. При создании нового профиля, если этот параметр не указан, используется стандартный профиль `analytics`.
partition строка		Значение по умолчанию: "Общий"	Раздел устройства для управления ресурсами.
provider словарь добавлено в версии 1.0.0 f5networks.f5_modules			Объект словаря, содержащий данные подключения.
	auth_provider строка		Настраивает поставщика аутентификации для получения токенов аутентификации с удалённого устройства. Этот параметр действительно используется при работе с устройствами BIG-IQ.
	no_f5_teem boolean	Варианты: no yes	Если `yes`, данные телеметрии TEEM не отправляются в F5. Вы можете опустить этот параметр, задав переменную окружения `F5_TEEM`.
	password строка / обязательно		Пароль для учетной записи пользователя, используемой для подключения к BIG-IP. Вы можете опустить этот параметр, задав переменную окружения `F5_PASSWORD`. псевдонимы: pass, pwd
	server строка / обязательно		Хост BIG-IP. Вы можете опустить этот параметр, задав переменную окружения `F5_SERVER`.
	server_port целое число	Значение по умолчанию: 443	Порт сервера BIG-IP. Вы можете опустить этот параметр, задав переменную окружения `F5_SERVER_PORT`.
	timeout целое число		Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку.
	transport строка	Варианты: rest ←	Настраивает транспортное подключение для использования при подключении к удалённому устройству.
	user строка / обязательно		Имя пользователя для подключения к BIG-IP. У этого пользователя должны быть административные привилегии на устройстве. Вы можете опустить этот параметр, задав переменную окружения `F5_USER`.
	validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не проверяются. Используйте только на контролируемых сайтах, использующих самозаверенные сертификаты. Вы можете опустить этот параметр, задав переменную окружения `F5_VALIDATE_CERTS`.
state строка		Варианты: present ← absent	Когда `present`, гарантирует, что профиль существует. Когда `absent`, гарантирует удаление профиля.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только рабочую конфигурацию продукта F5. Чтобы убедиться, что конфигурация, специфичная для BIG-IP, сохраняется на диске, убедитесь, что в задаче используется модуль f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Обратитесь к документации модуля для правильного использования модуля для сохранения текущей конфигурации.

Примеры

- name: Create a profile
  bigip_profile_analytics:
    name: profile1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для данного модуля:

Ключ	Возвращаемое значение	Описание
param1 boolean	changed	Новое значение параметра param1 ресурса. Пример: True
param2 строка	changed	Новое значение параметра param2 ресурса. Пример: Foo is bar

Авторы

Tim Rupp (@caphrim007)

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