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. Единицы (ПРОЦЕНТЫ).

контроллер строка	По умолчанию: ""	IP-адрес или имя хоста контроллера. Значение по умолчанию — переменная окружения `AVI_CONTROLLER`.
описание -		Определяемое пользователем описание объекта.
disable_se_analytics логическое	Варианты: нет да	Отключить аналитику на уровне узла (сервисного движка) для показателей метрик. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
disable_server_analytics логическое	Варианты: нет да	Отключить аналитику на серверах бэкенда. Это может быть желательно в контейнерной среде, когда имеется большое количество эфемерных серверов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_client_close_before_request_as_error логическое	Варианты: нет да	Исключить закрытие соединения клиентом до завершения запроса HTTP из числа ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_dns_policy_drop_as_significant логическое добавлено в 2.5	Варианты: нет да	Исключить отбрасывания политики DNS из списка ошибок. Поле добавлено в 17.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_gs_down_as_error логическое	Варианты: нет да	Исключить запросы к службам gslb, которые не работают, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_http_error_codes -		Список кодов состояния HTTP, которые нужно исключить из ошибок. Ошибка соединения или ответа влияет на оценку работоспособности, добавляется в значимые логи и может классифицироваться как часть атаки типа DoS.
exclude_invalid_dns_domain_as_error логическое	Варианты: нет да	Исключить запросы DNS к доменам, не включённым в профиль приложения DNS, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_invalid_dns_query_as_error логическое	Варианты: нет да	Исключить неверные запросы DNS из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_no_dns_record_as_error логическое	Варианты: нет да	Исключить запросы к доменам, для которых не были настроены службы/записи, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_no_valid_gs_member_as_error логическое	Варианты: нет да	Исключить запросы к службам gslb, у которых нет доступных членов, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_persistence_change_as_error логическое	Варианты: нет да	Исключить изменение сервера сохранения состояния при балансировке нагрузки из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_server_dns_error_as_error логическое	Варианты: нет да	Исключить ошибку DNS сервера из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_server_tcp_reset_as_error логическое	Варианты: нет да	Исключить сброс TCP сервера из ошибок. Это распространено для приложений, таких как ms exchange. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_syn_retransmit_as_error логическое	Варианты: нет да	Исключить «неответные сины сервера» из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_tcp_reset_as_error логическое	Варианты: нет да	Исключить сброс TCP клиентом из потенциальных ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_unsupported_dns_query_as_error логическое	Варианты: нет да	Исключить неподдерживаемые запросы 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 Network см. на странице 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. [community]

Авторы

Gaurav Rastogi (@grastogi23) <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.8/modules/avi_analyticsprofile_module.html