avi_analyticsprofile - Модуль для настройки объекта AnalyticsProfile Avi RESTful

Новая версия 2.3.

Обзор
- Требования
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

Этот модуль используется для настройки объекта AnalyticsProfile.
Дополнительные примеры по адресу https://github.com/avinetworks/devops

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

avisdk

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
apdex_response_threshold		Если клиент получает http-ответ за время, меньшее порогового значения удовлетворенности задержкой, запрос считается удовлетворённым. Если запрос не удовлетворён, но время ответа меньше, чем произведение порогового значения удовлетворенности задержкой на коэффициент допустимой задержки, запрос считается допустимым. Если время больше этого значения, запрос клиента считается неудовлетворительным. Допустимые значения: 1-30000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 500. Единицы (МИЛЛИСЕКУНДЫ).
apdex_response_tolerated_factor		Коэффициент допустимой задержки ответа клиента. Клиент должен получить ответ в течение времени, равном произведению этого коэффициента на порог удовлетворенности (apdex_response_threshold), чтобы ответ считался допустимым. Допустимые значения: 1-1000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.0.
apdex_rtt_threshold		Время удовлетворительного ответа клиента до контроллера Avi (rtt). Допустимые значения: 1-2000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 250. Единицы (МИЛЛИСЕКУНДЫ).
apdex_rtt_tolerated_factor		Коэффициент допустимого времени ответа клиента до контроллера Avi (rtt). Он является кратным apdex_rtt_tolerated_factor. Допустимые значения: 1-1000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.0.
apdex_rum_threshold		Если клиент может загрузить страницу за время, меньшее порогового значения удовлетворенности задержкой, загрузка страницы считается удовлетворительной. Она считается допустимой, если больше, чем удовлетворительное значение, но меньше, чем допустимое время задержки, умноженное на удовлетворительное значение задержки. Если время больше этого значения, запрос клиента считается неудовлетворительным. Загрузка страницы включает время поиска DNS, загрузки всех http-объектов и время отрисовки страницы. Допустимые значения: 1-30000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 5000. Единицы (МИЛЛИСЕКУНДЫ).
apdex_rum_tolerated_factor		Коэффициент порогового значения виртуальной службы для допустимого времени загрузки страницы (plt), как кратное apdex_rum_threshold. Допустимые значения: 1-1000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.0.
apdex_server_response_threshold		Серверный http-ответ считается удовлетворительным, если время задержки меньше порогового значения удовлетворенности задержкой. Ответ считается допустимым, если больше, чем удовлетворительное значение, но меньше, чем допустимое время задержки * s_latency. Если время больше этого значения, ответ сервера считается неудовлетворительным. Допустимые значения: 1-30000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 400. Единицы (МИЛЛИСЕКУНДЫ).
apdex_server_response_tolerated_factor		Коэффициент допустимой задержки ответа сервера. Сервер должен ответить в течение времени, равном произведению этого коэффициента на порог удовлетворенности (apdex_server_response_threshold), чтобы ответ считался допустимым. Допустимые значения: 1-1000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.0.
apdex_server_rtt_threshold		Время удовлетворительного ответа клиента до контроллера Avi (rtt). Допустимые значения: 1-2000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 125. Единицы (МИЛЛИСЕКУНДЫ).
apdex_server_rtt_tolerated_factor		Коэффициент допустимого времени ответа клиента до контроллера Avi (rtt). Он является кратным apdex_rtt_tolerated_factor. Допустимые значения: 1-1000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.0.
api_context (добавлен в 2.5)		Контекст Avi API, включающий текущий идентификатор сессии и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сессию.
api_version	По умолчанию: 16.4.4	Версия Avi API для использования с Avi API и объектами.
avi_api_patch_op (добавлен в 2.5)	Варианты: add replace delete	Операция обработки для использования при использовании avi_api_update_method как patch.
avi_api_update_method (добавлен в 2.5)	Варианты: put ← patch	Метод по умолчанию для обновления объекта — HTTP PUT. Установка на patch переопределяет это поведение на использование HTTP PATCH.
avi_credentials (добавлен в 2.5)		Словарь Avi Credentials, который может использоваться вместо перечисления данных входа в систему контроллера Avi.
client_log_config		Настройка журналов, отправляемых контроллеру Avi от ses, и их обработки.
client_log_streaming_config (добавлен в 2.4)		Настройка потоковой передачи журналов на внешний сервер. Поле введено в 17.1.1.
conn_lossy_ooo_threshold		Соединение между клиентом и контроллером Avi считается ненадёжным, когда уровень пакетов, полученных в неправильном порядке, превышает данный процент. Допустимые значения: 1-100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 50. Единицы (ПРОЦЕНТЫ).
conn_lossy_timeo_rexmt_threshold		Соединение между клиентом и контроллером Avi считается ненадёжным, когда уровень пакетов, повторно пересылаемых из-за таймаута, превышает данный процент. Допустимые значения: 1-100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 20. Единицы (ПРОЦЕНТЫ).
conn_lossy_total_rexmt_threshold		Соединение между клиентом и контроллером Avi считается ненадёжным, когда уровень повторно пересылаемых пакетов превышает данный процент. Допустимые значения: 1-100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 50. Единицы (ПРОЦЕНТЫ).
conn_lossy_zero_win_size_event_threshold		Подключение клиента считается ненадежным, когда процент случаев, когда пакет не мог быть передан из-за нулевого размера окна TCP, превышает этот порог. Допустимые значения: 0-100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2. Единицы (ПРОЦЕНТЫ).
conn_server_lossy_ooo_threshold		Подключение между контроллером Avi и сервером считается ненадежным, когда процент пакетов, полученных в неправильном порядке, превышает этот порог. Допустимые значения: 1-100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 50. Единицы (ПРОЦЕНТЫ).
conn_server_lossy_timeo_rexmt_threshold		Подключение между контроллером Avi и сервером считается ненадежным, когда процент пакетов, повторно пересылаемых из-за таймаута, превышает этот порог. Допустимые значения: 1-100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 20. Единицы (ПРОЦЕНТЫ).
conn_server_lossy_total_rexmt_threshold		Соединение между контроллером Avi и сервером считается ненадёжным, когда уровень повторно пересылаемых пакетов превышает данный процент. Допустимые значения: 1-100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 50. Единицы (ПРОЦЕНТЫ).
conn_server_lossy_zero_win_size_event_threshold		Подключение к серверу считается ненадежным, когда процент случаев, когда пакет не мог быть передан из-за нулевого размера окна TCP, превышает этот порог. Допустимые значения: 0-100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2. Единицы (ПРОЦЕНТЫ).
controller	По умолчанию:	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная среды `AVI_CONTROLLER`.
description		Пользовательское описание объекта.
disable_se_analytics	Варианты: no yes	Отключить аналитику на уровне узлов (сервисных модулей) для метрик vs. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
disable_server_analytics	Варианты: no yes	Отключить аналитику на серверах бэкенда. Это может потребоваться в контейнерной среде, когда имеется большое количество кратковременных серверов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_client_close_before_request_as_error	Варианты: no yes	Исключить закрытие подключения клиентом до завершения http-запроса из классификации как ошибки. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_dns_policy_drop_as_significant (добавлен в 2.5)	Варианты: no yes	Исключить падения политики DNS из списка ошибок. Поле введено в 17.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.

exclude_gs_down_as_error	Варианты: нет да	Исключить запросы к gslb-сервисам, которые не работают, из списка ошибок. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
exclude_http_error_codes		Список кодов состояния HTTP, которые следует исключить из классификации как ошибка. Проблемы с соединениями или ответами влияют на балл работоспособности, добавляются в значимые журналы и могут быть классифицированы как часть атаки типа DoS.
exclude_invalid_dns_domain_as_error	Варианты: нет да	Исключить запросы DNS к доменам, не включённым в профиль приложения DNS, из списка ошибок. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
exclude_invalid_dns_query_as_error	Варианты: нет да	Исключить некорректные запросы DNS из списка ошибок. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
exclude_no_dns_record_as_error	Варианты: нет да	Исключить запросы к доменам, для которых не были настроены сервисы/записи, из списка ошибок. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
exclude_no_valid_gs_member_as_error	Варианты: нет да	Исключить запросы к gslb-сервисам, у которых нет доступных членов, из списка ошибок. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
exclude_persistence_change_as_error	Варианты: нет да	Исключить изменения сервера персистентности во время балансировки нагрузки из списка ошибок. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
exclude_server_dns_error_as_error	Варианты: нет да	Исключить ошибки DNS сервера из списка ошибок. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
exclude_server_tcp_reset_as_error	Варианты: нет да	Исключить сброс TCP сервера из списка ошибок. Это распространено для таких приложений, как ms exchange. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
exclude_syn_retransmit_as_error	Варианты: нет да	Исключить «неотвеченные синки сервера» из списка ошибок. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
exclude_tcp_reset_as_error	Варианты: нет да	Исключить сбросы TCP клиентом из потенциальных ошибок. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
exclude_unsupported_dns_query_as_error	Варианты: нет да	Исключить неподдерживаемые запросы DNS из списка ошибок. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как False.
hs_event_throttle_window		Временной интервал (в секундах), в течение которого должны происходить только уникальные события изменения состояния. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 1209600.
hs_max_anomaly_penalty		Максимальное наказание, которое может быть вычтено из балла работоспособности за аномалии. Допустимые значения от 0 до 100. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 10.
hs_max_resources_penalty		Максимальное наказание, которое может быть вычтено из балла работоспособности за высокую загрузку ресурсов. Допустимые значения от 0 до 100. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 25.
hs_max_security_penalty		Максимальное наказание, которое может быть вычтено из балла работоспособности на основе оценки безопасности. Допустимые значения от 0 до 100. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 100.
hs_min_dos_rate		Скорость соединения DoS, ниже которой оценка безопасности DoS не будет активирована. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 1000.
hs_performance_boost		Добавляет дополнительные баллы производительности в балл работоспособности. Можно использовать для компенсации балла работоспособности для известных медленных приложений. Допустимые значения от 0 до 100. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 0.
hs_pscore_traffic_threshold_l4_client		Пороговое значение числа подключений за 5 минут, ниже которого не рассчитываются метрики качества сети, такие как apdexr, apdexc, rum_apdex и другие. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 10.0.
hs_pscore_traffic_threshold_l4_server		Пороговое значение числа подключений за 5 минут, ниже которого не рассчитываются метрики качества сети, такие как apdexr, apdexc, rum_apdex и другие. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 10.0.
hs_security_certscore_expired		Балл, присваиваемый, когда сертификат истек. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 0.0.
hs_security_certscore_gt30d		Балл, присваиваемый, когда сертификат истекает через более чем 30 дней. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 5.0.
hs_security_certscore_le07d		Балл, присваиваемый, когда сертификат истекает не более чем через 7 дней. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 2.0.
hs_security_certscore_le30d		Балл, присваиваемый, когда сертификат истекает не более чем через 30 дней. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 4.0.
hs_security_chain_invalidity_penalty		Штраф за разрешение сертификатов с невалидной цепочкой. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 1.0.
hs_security_cipherscore_eq000b		Балл, присваиваемый, когда минимальная сила шифра равна 0 бит. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 0.0.
hs_security_cipherscore_ge128b		Балл, присваиваемый, когда минимальная сила шифра больше или равна 128 битам. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 5.0.
hs_security_cipherscore_lt128b		Балл, присваиваемый, когда минимальная сила шифра меньше 128 бит. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 3.5.
hs_security_encalgo_score_none		Балл, присваиваемый, когда для шифрования не используется алгоритм. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 0.0.
hs_security_encalgo_score_rc4		Балл, присваиваемый, когда для шифрования используется алгоритм rc4. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 2.5.
hs_security_hsts_penalty		Штраф за отсутствие включения hsts. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 1.0.
hs_security_nonpfs_penalty		Штраф за разрешение не-pfs рукопожатий. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 1.0.
hs_security_selfsignedcert_penalty		Устарело. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 1.0.
hs_security_ssl30_score		Балл, присваиваемый при поддержке протокола шифрования ssl3.0. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 3.5.
hs_security_tls10_score		Балл, присваиваемый при поддержке протокола шифрования tls1.0. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 5.0.
hs_security_tls11_score		Балл, присваиваемый при поддержке протокола шифрования tls1.1. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 5.0.
hs_security_tls12_score		Балл, присваиваемый при поддержке протокола шифрования tls1.2. Допустимые значения от 0 до 5. По умолчанию, если не указано в API или модуле, Avi Controller интерпретирует значение как 5.0.

hs_security_weak_signature_algo_penalty		Штраф за разрешение слабого(ых) алгоритма(ов) цифровой подписи. Допустимые значения — от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1,0.
name обязательно		Название профиля аналитики.
password	Значение по умолчанию:	Пароль пользователя Avi в контроллере Avi. Значение по умолчанию — переменная среды `AVI_PASSWORD`.
ranges		Список диапазонов кодов состояния HTTP, которые не следует классифицировать как ошибки.
resp_code_block		Блок кодов ответов HTTP, которые не следует классифицировать как ошибки. Варианты перечисления — AP_HTTP_RSP_4XX, AP_HTTP_RSP_5XX.
state	Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
tenant	Значение по умолчанию: admin	Имя арендатора, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref		Ссылка на объект типа арендатор.
tenant_uuid	Значение по умолчанию:	UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.
url		URL контроллера Avi для объекта.
username	Значение по умолчанию:	Имя пользователя, используемого для доступа к контроллеру Avi. Значение по умолчанию — переменная среды `AVI_USERNAME`.
uuid		Uuid профиля аналитики.

Примечания

Примечание

Дополнительную информацию об использовании Ansible для управления устройствами сети Avi см. на странице https://www.ansible.com/ansible-avi-networks.

Примеры

- name: Create a custom Analytics profile object
  avi_analyticsprofile:
    controller: '{{ controller }}'
    username: '{{ username }}'
    password: '{{ password }}'
    apdex_response_threshold: 500
    apdex_response_tolerated_factor: 4.0
    apdex_rtt_threshold: 250
    apdex_rtt_tolerated_factor: 4.0
    apdex_rum_threshold: 5000
    apdex_rum_tolerated_factor: 4.0
    apdex_server_response_threshold: 400
    apdex_server_response_tolerated_factor: 4.0
    apdex_server_rtt_threshold: 125
    apdex_server_rtt_tolerated_factor: 4.0
    conn_lossy_ooo_threshold: 50
    conn_lossy_timeo_rexmt_threshold: 20
    conn_lossy_total_rexmt_threshold: 50
    conn_lossy_zero_win_size_event_threshold: 2
    conn_server_lossy_ooo_threshold: 50
    conn_server_lossy_timeo_rexmt_threshold: 20
    conn_server_lossy_total_rexmt_threshold: 50
    conn_server_lossy_zero_win_size_event_threshold: 2
    disable_se_analytics: false
    disable_server_analytics: false
    exclude_client_close_before_request_as_error: false
    exclude_persistence_change_as_error: false
    exclude_server_tcp_reset_as_error: false
    exclude_syn_retransmit_as_error: false
    exclude_tcp_reset_as_error: false
    hs_event_throttle_window: 1209600
    hs_max_anomaly_penalty: 10
    hs_max_resources_penalty: 25
    hs_max_security_penalty: 100
    hs_min_dos_rate: 1000
    hs_performance_boost: 20
    hs_pscore_traffic_threshold_l4_client: 10.0
    hs_pscore_traffic_threshold_l4_server: 10.0
    hs_security_certscore_expired: 0.0
    hs_security_certscore_gt30d: 5.0
    hs_security_certscore_le07d: 2.0
    hs_security_certscore_le30d: 4.0
    hs_security_chain_invalidity_penalty: 1.0
    hs_security_cipherscore_eq000b: 0.0
    hs_security_cipherscore_ge128b: 5.0
    hs_security_cipherscore_lt128b: 3.5
    hs_security_encalgo_score_none: 0.0
    hs_security_encalgo_score_rc4: 2.5
    hs_security_hsts_penalty: 0.0
    hs_security_nonpfs_penalty: 1.0
    hs_security_selfsignedcert_penalty: 1.0
    hs_security_ssl30_score: 3.5
    hs_security_tls10_score: 5.0
    hs_security_tls11_score: 5.0
    hs_security_tls12_score: 5.0
    hs_security_weak_signature_algo_penalty: 1.0
    name: jason-analytics-profile
    tenant_ref: Demo

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

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

Ключ	Возвращённое значение	Описание
obj dict	success, changed	Объект AnalyticsProfile (api/analyticsprofile)

Статус

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

Автор

Г. Растоги (grastogi@avinetworks.com)

Подсказка

Если вы обнаружите какие-либо проблемы в данной документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/avi_analyticsprofile_module.html