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 -		Удовлетворительное время задержки (rtt) клиента до контроллера Avi. Допустимые значения — от 1 до 2000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 250. Единицы (миллисекунды).
apdex_rtt_tolerated_factor -		Фактор терпимого времени задержки (rtt) клиента до контроллера Avi. Он является кратным 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 -		Удовлетворительное время задержки (rtt) клиента до контроллера Avi. Допустимые значения — от 1 до 2000. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как 125. Единицы (миллисекунды).
apdex_server_rtt_tolerated_factor -		Фактор терпимого времени задержки (rtt) клиента до контроллера Avi. Он является кратным 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, который можно использовать вместо перечисления данных входа в систему контроллера 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 boolean	Варианты: нет да	Отключить аналитику на уровне узла (сетевого модуля) для метрик. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
disable_server_analytics boolean	Варианты: нет да	Отключить аналитику на серверах бэкенда. Это может быть желательно в среде контейнеров, когда имеется большое количество эфемерных серверов. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_client_close_before_request_as_error boolean	Варианты: нет да	Исключить закрытие соединения клиентом до завершения запроса HTTP из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_dns_policy_drop_as_significant boolean добавлен в 2.5	Варианты: нет да	Исключить сбросы DNS-политики из списка ошибок. Поле введено в версии 17.2.2. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_gs_down_as_error boolean	Варианты: нет да	Исключить запросы к gslb-сервисам, которые недоступны, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_http_error_codes -		Список кодов состояния HTTP, которые следует исключить из списка ошибок. Ошибка соединений или ответов влияет на рейтинг работоспособности, включены в значимые логи и могут быть классифицированы как часть атаки DoS.
exclude_invalid_dns_domain_as_error boolean	Варианты: нет да	Исключить DNS-запросы к доменам, не включенным в профиль приложения DNS, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_invalid_dns_query_as_error boolean	Варианты: нет да	Исключить некорректные DNS-запросы из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_no_dns_record_as_error boolean	Варианты: нет да	Исключить запросы к доменам, для которых не были настроены службы/записи, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_no_valid_gs_member_as_error boolean	Варианты: нет да	Исключить запросы к gslb-сервисам, у которых нет доступных членов, из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_persistence_change_as_error boolean	Варианты: нет да	Исключить изменение сервера сохранения в процессе балансировки нагрузки из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_server_dns_error_as_error boolean	Варианты: нет да	Исключить ошибки DNS сервера из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_server_tcp_reset_as_error boolean	Варианты: нет да	Исключить сбросы TCP сервера из ошибок. Это распространено для приложений, таких как ms exchange. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_syn_retransmit_as_error boolean	Варианты: нет да	Исключить "неотвеченные сины сервера" из списка ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_tcp_reset_as_error boolean	Варианты: нет да	Исключить сбросы TCP клиентом из списка потенциальных ошибок. Значение по умолчанию, если не указано в API или модуле, интерпретируется контроллером Avi как False.
exclude_unsupported_dns_query_as_error boolean	Варианты: нет да	Исключить неподдерживаемые 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 -	Варианты: absent present ←	Состояние, которое должно быть применено к сущности.
tenant -	По умолчанию: "admin"	Имя арендатора, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref -		Это ссылка на объект типа tenant.
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. [сообщество]

Авторы

Gaurav 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.7/modules/avi_analyticsprofile_module.html