Spec-Zone.ru › Ansible 2.4

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
нет
Ответ сервера считается удовлетворительным, если задержка меньше порога удовлетворения задержки.
Ответ считается допустимым, если он больше удовлетворительного, но меньше допустимого коэффициента задержки * 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_version
нет
Версия Avi API для использования с Avi API и объектами.
client_log_config
нет
Настройка отправки логов с SES в контроллер Avi и их обработки.
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
нет
Отключить аналитику на уровне узлов (сервисных модулей) для метрик vs.
По умолчанию, если не указано в API или модуле, контроллер Avi интерпретирует значение как False.
disable_server_analytics
нет
Отключить аналитику на серверах бэкэнда.
Это может быть желательно в средах контейнеров с большим количеством эфемерных серверов.
По умолчанию, если не указано в API или модуле, контроллер Avi интерпретирует значение как False.
exclude_client_close_before_request_as_error
нет
Исключить закрытие подключения клиентом до завершения http-запроса из списка ошибок.
По умолчанию, если не указано в API или модуле, контроллер Avi интерпретирует значение как False.
exclude_gs_down_as_error
нет
Исключить запросы к gslb-сервисам, которые не работают, из списка ошибок.
По умолчанию, если не указано в API или модуле, контроллер Avi интерпретирует значение как False.
exclude_http_error_codes
нет
Список http-кодов состояния, которые нужно исключить из списка ошибок.
Ошибка соединения или ответа влияет на рейтинг работоспособности, включает важные логи и может быть классифицирована как часть атаки типа DDoS.
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
нет админ
Имя арендатора, используемого для всех вызовов API Avi и контекста объекта.
tenant_ref
нет
Ссылка на объект типа арендатор.
tenant_uuid
нет
UUID арендатора, используемого для всех вызовов API Avi и контекста объекта.
url
нет
URL контроллера Avi для объекта.
username
нет
Имя пользователя для доступа к контроллеру Avi. Значение по умолчанию — переменная окружения AVI_USERNAME.
uuid
нет
Uuid профиля аналитики.

Примеры

- name: Create a custom Analytics profile object
  avi_analyticsprofile:
    controller: ''
    username: ''
    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 и Разработка модулей.

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

Spec-Zone.ru

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