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-ответ считается удовлетворительным, если время ожидания меньше порогового значения удовлетворения. Ответ считается допустимым, если он больше, чем удовлетворительный, но меньше, чем коэффициент допустимого времени ожидания * время_удовлетворительного_ответа. Если время больше этого значения, ответ сервера считается неудовлетворительным. Допустимые значения — от 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) | Контекст API Avi, включающий текущий идентификатор сеанса и токен CSRF. Это позволяет пользователю выполнить единый вход и повторно использовать сеанс. | |
| api_version | По умолчанию: "16.4.4" | Версия API Avi для использования с Avi API и объектами. |
| avi_api_patch_op (добавлено в 2.5) |
| Операция обновления при использовании avi_api_update_method как patch. |
| avi_api_update_method (добавлено в 2.5) |
| Метод по умолчанию для обновления объекта — 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 bool |
| Отключить аналитику на уровне узла (сетевого адаптера) для метрик vs. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| disable_server_analytics bool |
| Отключить аналитику на серверах бэкенда. Это может потребоваться в среде контейнеров, когда имеется большое количество эфемерных серверов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_client_close_before_request_as_error bool |
| Исключить закрытие соединения клиентом до завершения http-запроса из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_dns_policy_drop_as_significant bool (добавлено в 2.5) |
| Исключить падения по политике DNS из списка ошибок. Поле введено в 17.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_gs_down_as_error bool |
| Исключить запросы к gslb-службам, которые не работают, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_http_error_codes | Список кодов состояния HTTP, которые не следует классифицировать как ошибки. Подключения или ответы с ошибками влияют на оценку работоспособности, включаются в значимые логи и могут классифицироваться как часть атаки типа DoS. | |
| exclude_invalid_dns_domain_as_error bool |
| Исключить запросы DNS к доменам, которые не входят в конфигурацию профиля приложения DNS, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_invalid_dns_query_as_error bool |
| Исключить некорректные запросы DNS из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_no_dns_record_as_error bool |
| Исключить запросы к доменам, для которых не были сконфигурированы службы/записи, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_no_valid_gs_member_as_error bool |
| Исключить запросы к gslb-службам, у которых нет доступных членов, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_persistence_change_as_error bool |
| Исключить изменение сервера персистентности во время балансировки нагрузки из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_server_dns_error_as_error bool |
| Исключить ответы с ошибками DNS сервера из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_server_tcp_reset_as_error bool |
| Исключить сброс TCP сервера из списка ошибок. Это часто встречается в приложениях, таких как ms exchange. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_syn_retransmit_as_error bool |
| Исключить «неотвеченные запросы SYN сервера» из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_tcp_reset_as_error bool |
| Исключить сбросы TCP клиентом из потенциального списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| exclude_unsupported_dns_query_as_error bool |
| Исключить неподдерживаемые запросы DNS из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False. |
| hs_event_throttle_window | Временной интервал (в секундах), в течение которого должны происходить только уникальные события изменения состояния. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1209600. | |
| hs_max_anomaly_penalty | Максимальное штрафное значение, которое может быть вычтено из оценки работоспособности за аномалии. Допустимые значения находятся в диапазоне от 0 до 100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10. | |
| hs_max_resources_penalty | Максимальное штрафное значение, которое может быть вычтено из оценки работоспособности за высокую загрузку ресурсов. Допустимые значения находятся в диапазоне от 0 до 100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 25. | |
| hs_max_security_penalty | Максимальное штрафное значение, которое может быть вычтено из оценки работоспособности на основе оценки безопасности. Допустимые значения находятся в диапазоне от 0 до 100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 100. | |
| hs_min_dos_rate | Скорость подключения DoS, ниже которой оценка безопасности DoS не будет активирована. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1000. | |
| hs_performance_boost | Добавляет дополнительные баллы производительности к оценке работоспособности. Может использоваться для компенсации оценки работоспособности для известных медленных приложений. Допустимые значения находятся в диапазоне от 0 до 100. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0. | |
| hs_pscore_traffic_threshold_l4_client | Пороговое значение количества подключений за 5 минут, ниже которого не вычисляются метрики качества сети, такие как apdexr, apdexc, rum_apdex. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10.0. | |
| hs_pscore_traffic_threshold_l4_server | Пороговое значение количества подключений за 5 минут, ниже которого не вычисляются метрики качества сети, такие как apdexr, apdexc, rum_apdex. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 10.0. | |
| hs_security_certscore_expired | Оценка, присваиваемая, когда сертификат истек. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.0. | |
| hs_security_certscore_gt30d | Оценка, присваиваемая, когда сертификат истекает более чем через 30 дней. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 5.0. | |
| hs_security_certscore_le07d | Оценка, присваиваемая, когда сертификат истекает не более чем через 7 дней. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.0. | |
| hs_security_certscore_le30d | Оценка, присваиваемая, когда сертификат истекает не более чем через 30 дней. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 4.0. | |
| hs_security_chain_invalidity_penalty | Штраф за использование сертификатов с невалидной цепочкой. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.0. | |
| hs_security_cipherscore_eq000b | Оценка, присваиваемая, когда минимальная сила шифрования составляет 0 бит. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.0. | |
| hs_security_cipherscore_ge128b | Оценка, присваиваемая, когда минимальная сила шифрования не меньше 128 бит. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 5.0. | |
| hs_security_cipherscore_lt128b | Оценка, присваиваемая, когда минимальная сила шифрования меньше 128 бит. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 3.5. | |
| hs_security_encalgo_score_none | Оценка, присваиваемая, когда для шифрования не используется ни один алгоритм. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 0.0. | |
| hs_security_encalgo_score_rc4 | Оценка, присваиваемая, когда для шифрования используется алгоритм rc4. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 2.5. | |
| hs_security_hsts_penalty | Штраф за отсутствие включения hsts. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.0. | |
| hs_security_nonpfs_penalty | Штраф за использование не-pfs рукопожатий. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.0. | |
| hs_security_selfsignedcert_penalty | Устарело. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 1.0. | |
| hs_security_ssl30_score | Оценка, присваиваемая при поддержке протокола шифрования ssl3.0. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 3.5. | |
| hs_security_tls10_score | Оценка, присваиваемая при поддержке протокола шифрования tls1.0. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 5.0. |
| hs_security_tls11_score | Балл, присваиваемый при поддержке протокола шифрования tls1.1. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 5.0. | |
| hs_security_tls12_score | Балл, присваиваемый при поддержке протокола шифрования tls1.2. Допустимые значения находятся в диапазоне от 0 до 5. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 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 |
| Состояние, которое должно быть применено к сущности. |
| 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 словарь | успех, изменение | Объект AnalyticsProfile (api/analyticsprofile) |
Состояние
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Гaurav Rastogi (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.6/modules/avi_analyticsprofile_module.html