Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

Новинка в f5networks.f5_modules 1.0.0

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

Описание

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

Параметры

Параметр

Комментарии

collect_geo

boolean

Включает или отключает сбор имен стран, из которых был отправлен трафик.

Варианты:

  • false
  • true

collect_ip

boolean

Включает или отключает сбор статистики по IP-адресам клиентов.

Варианты:

  • false
  • true

collect_max_tps_and_throughput

boolean

Включает или отключает сбор максимальных значений TPS и пропускной способности для всех собранных сущностей.

Варианты:

  • false
  • true

collect_page_load_time

boolean

Включает или отключает сбор статистики времени загрузки страницы.

Варианты:

  • false
  • true

collect_url

boolean

Включает или отключает сбор статистики запрошенных URL.

Варианты:

  • false
  • true

collect_user_agent

boolean

Включает или отключает сбор информации о пользовательских агентах.

Варианты:

  • false
  • true

collect_user_sessions

boolean

Включает или отключает сбор уникальных сеансов пользователей.

Варианты:

  • false
  • true

collected_stats_external_logging

boolean

Включает или отключает внешнее протоколирование собранной статистики.

Варианты:

  • false
  • true

collected_stats_internal_logging

boolean

Включает или отключает внутреннее протоколирование собранной статистики.

Варианты:

  • false
  • true

description

string

Описание профиля.

external_logging_publisher

string

Указывает внешнего издателя протоколирования, используемого для отправки статистических данных в один или несколько пунктов назначения.

name

string / обязательно

Указывает имя профиля.

notification_by_email

boolean

Включает или отключает отправку оповещений об аналитике по электронной почте.

Варианты:

  • false
  • true

notification_by_syslog

boolean

Включает или отключает протоколирование оповещений об аналитике в Syslog.

Варианты:

  • false
  • true

notification_email_addresses

список / элементы=строка

Указывает адреса электронной почты, которые получат оповещения по электронной почте, когда notification_by_email включен.

parent

строка

Указывает профиль, унаследующий настройки.

При создании нового профиля, если этот параметр не указан, по умолчанию используется системный профиль analytics.

partition

строка

Раздел устройства для управления ресурсами.

По умолчанию: "Common"

provider

словарь

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

Объект dict, содержащий данные подключения.

auth_provider

строка

Настраивает поставщика аутентификации для получения маркеров аутентификации с удаленного устройства.

Этот параметр действительно используется при работе с устройствами 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 ← (по умолчанию)

state

string

Когда 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

Новое значение параметра param1 ресурса.

Возвращается: changed

Пример: true

param2

string

Новое значение параметра param2 ресурса.

Возвращается: changed

Пример: "Foo is bar"

Авторы

  • 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_profile_analytics_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API