Модуль f5networks.f5_modules.bigip_asm_dos_application — управление параметрами приложения для профиля DOS

Примечание

Этот модуль входит в коллекцию f5networks.f5_modules (версия 1.39.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить ее, используйте: ansible-galaxy collection install f5networks.f5_modules.

Чтобы использовать ее в плейбуке, укажите: f5networks.f5_modules.bigip_asm_dos_application.

Добавлено в f5networks.f5_modules 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Управляет параметрами приложения для профиля ASM/AFM DOS.

Параметры

Параметр	Комментарии
geolocations словарь	Управляет списками стран, разрешенных и запрещенных по геолокации.
blacklist список / элементы=строка	Список стран для добавления в черный список. Элементы не должны пересекаться со списком `whitelist`.
whitelist список / элементы=строка	Список стран для добавления в белый список. Элементы не должны пересекаться со списком `blacklist`.
heavy_urls словарь	Управляет защитой от ресурсоемких URL. Ресурсоемкие URL — это небольшое число URL-адресов сайта, которые при каждом запросе могут потреблять значительные ресурсы сервера.
auto_detect логическое значение	Включает или отключает автоматическое обнаружение ресурсоемких URL. Допустимые значения: `false` `true`
exclude список / элементы=строка	Задает список URL-адресов или шаблонов, которые следует исключить из списка ресурсоемких URL.
include список / элементы=словарь	Настраивает дополнительные URL-адреса для включения в список автоматически обнаруженных ресурсоемких URL.
threshold строка	Задает пороговое значение количества запросов в секунду, при превышении которого соответствующий URL считается подвергшимся атаке. Допустимый диапазон — от 1 до 4294967295 включительно или `auto`.
url строка / обязательный	Задает URL-адрес для добавления в список ресурсоемких URL в дополнение к автоматически обнаруженным адресам.
latency_threshold целое число	Задает пороговое значение задержки для автоматического обнаружения ресурсоемких URL. Допустимый диапазон — от 0 до 4294967295 миллисекунд включительно.
mobile_detection словарь	Настраивает обнаружение мобильных приложений, созданных с помощью Anti-Bot Mobile SDK, и определяет обработку запросов от клиентов этих мобильных приложений.
allow_android_rooted_device логическое значение	Если `true`, устройство разрешает трафик с устройств Android с root-доступом. Допустимые значения: `false` `true`
allow_any_android_package логическое значение	Если `true`, разрешается любой издатель приложений. Издатель определяется сертификатом, использованным для подписи приложения. Допустимые значения: `false` `true`
allow_any_ios_package логическое значение	Если `true`, разрешается любой пакет iOS. Имя пакета — уникальный идентификатор мобильного приложения. Допустимые значения: `false` `true`
allow_emulators логическое значение	Если `true`, разрешается трафик от приложений, запущенных в эмуляторах. Допустимые значения: `false` `true`
allow_jailbroken_devices логическое значение	Если `true`, разрешается трафик с устройств iOS с джейлбрейком. Допустимые значения: `false` `true`
android_publishers список / элементы=строка	Этот параметр не действует, если для `allow_any_android_package` задано значение `true`. Указывает сертификаты издателей, которым разрешено публиковать приложения для Android. Сертификат издателя необходимо предварительно установить на BIG-IP. Имя сертификата, находящегося в разделе, отличном от указанного в параметре `partition`, необходимо указывать в формате `full_path`, например `/Foo/cert.crt`.
client_side_challenge_mode строка	Действие, выполняемое при необходимости показать CAPTCHA или проверку целостности на стороне клиента. Пользователь мобильного приложения не увидит проверку CAPTCHA, а мобильному приложению не будет показана проверка целостности на стороне клиента. Для мобильных приложений доступны варианты `pass` или `cshui`. При значении `pass` трафик пропускается без каких-либо действий. При значении `cshui` SDK проверяет, взаимодействовал ли пользователь с экраном в последние несколько секунд. Если взаимодействие не обнаружено, трафик блокируется. Допустимые значения: `"pass"` `"cshui"`
enabled логическое значение	Если `true`, обнаруживаются запросы от мобильных приложений, созданных с помощью Anti-Bot Mobile SDK, и обрабатываются в соответствии с заданными параметрами. Если `false`, эти запросы обрабатываются как любые другие, что может привести к пропуску атак или ложным срабатываниям. Допустимые значения: `false` `true`
ios_allowed_package_names список / элементы=строка	Указывает имена пакетов iOS, для которых разрешен трафик. Этот параметр не действует, если для `allow_any_ios_package` задано значение `true`.
partition строка	Раздел устройства, в котором будут управляться ресурсы. По умолчанию: `"Common"`
profile строка / обязательный	Задает имя профиля, параметры приложения в котором будут настраиваться.
provider словарь добавлено в f5networks.f5_modules 1.0.0	Объект dict, содержащий сведения о подключении.
auth_provider строка	Настраивает поставщика аутентификации для получения токенов аутентификации с удаленного устройства. Этот параметр используется главным образом при работе с устройствами BIG-IQ.
no_f5_teem логическое значение	Если `yes`, телеметрические данные TEEM не отправляются в F5. Этот параметр можно не указывать, задав переменную среды `F5_TELEMETRY_OFF`. Ранее использовавшаяся переменная `F5_TEEM` устарела, поскольку ее имя вводило в заблуждение. Допустимые значения: `false` ← (по умолчанию) `true`
password псевдонимы: pass, pwd строка / обязательный	Пароль учетной записи пользователя, используемой для подключения к BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_PASSWORD`.
server строка / обязательный	Имя хоста BIG-IP или BIG-IQ. Этот параметр можно не указывать, задав переменную среды `F5_SERVER`.
server_port целое число	Порт сервера BIG-IP. Этот параметр можно не указывать, задав переменную среды `F5_SERVER_PORT`. По умолчанию: `443`
timeout целое число	Задает время ожидания в секундах при подключении к сетевому устройству или отправке ему команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку.
transport строка	Настраивает транспортное соединение для подключения к удаленному устройству. Допустимые значения: `"rest"` ← (по умолчанию)
user строка / обязательный	Имя пользователя для подключения к BIG-IP или BIG-IQ. У этого пользователя должны быть права администратора на устройстве. Этот параметр можно не указывать, задав переменную среды `F5_USER`.
validate_certs логическое значение	Если `no`, SSL-сертификаты не проверяются. Используйте этот параметр только на подконтрольных вам сайтах с самоподписанными сертификатами. Этот параметр можно не указывать, задав переменную среды `F5_VALIDATE_CERTS`. Допустимые значения: `false` `true` ← (по умолчанию)
rtbh_duration целое число	Задает длительность объявления маршрута RTBH BGP в секундах. Допустимый диапазон — от 0 до 4294967295 включительно.
rtbh_enable логическое значение	Указывает, следует ли включить удаленное инициирование черной дыры (RTBH) для `RTBH` атакующих IP-адресов путем объявления маршрутов BGP. Допустимые значения: `false` `true`
scrubbing_duration целое число	Задает длительность объявления маршрута BGP для очистки трафика в секундах. Допустимый диапазон — от 0 до 4294967295 включительно.
scrubbing_enable логическое значение	Указывает, следует ли включить очистку трафика во время атак путем объявления маршрутов BGP. Допустимые значения: `false` `true`
single_page_application логическое значение	Если `true`, указывает, что система поддерживает одностраничные приложения. Допустимые значения: `false` `true`
state строка	Если для `state` задано значение `present`, обеспечивает наличие объекта Application. Если для `state` задано значение `absent`, обеспечивает удаление объекта Application. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`
trigger_irule логическое значение	Если `true`, указывает, что система активирует событие iRule для Application DoS. Допустимые значения: `false` `true`

Примечания

Примечание

Требуется BIG-IP версии >= 13.1.0
Дополнительные сведения об использовании Ansible для управления устройствами F5 Networks см. на странице https://www.ansible.com/integrations/networks/f5.
Требуется версия ПО BIG-IP >= 12.
Модули F5 изменяют только текущую конфигурацию продукта F5. Чтобы сохранить конфигурацию BIG-IP на диск, обязательно включите хотя бы одну задачу с модулем f5networks.f5_modules.bigip_config для сохранения текущей конфигурации. Инструкции по правильному использованию модуля для сохранения текущей конфигурации см. в документации к модулю.

Примеры

- name: Create an ASM dos application profile
  bigip_asm_dos_application:
    profile: dos_foo
    geolocations:
      blacklist:
        - Afghanistan
        - Andora
      whitelist:
        - Cuba
    heavy_urls:
      auto_detect: true
      latency_threshold: 1000
    rtbh_duration: 3600
    rtbh_enable: true
    single_page_application: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Update an ASM dos application profile
  bigip_asm_dos_application:
    profile: dos_foo
    mobile_detection:
      enabled: true
      allow_any_ios_package: true
      allow_emulators: true
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Remove an ASM dos application profile
  bigip_asm_dos_application:
    profile: dos_foo
    state: absent
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

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

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

Ключ	Описание
geolocations complex	Задает белый и черный списки стран для геолокации. Возвращается: при изменении Пример: `"hash/dictionary of values"`
blacklist list / elements=string	Список стран, которые следует добавить в черный список. Возвращается: при изменении Пример: `["Russia", "Germany"]`
whitelist list / elements=string	Список стран, которые следует добавить в белый список. Возвращается: при изменении Пример: `["United States, United Kingdom"]`
heavy_urls complex	Управляет защитой от ресурсоемких URL-адресов. Возвращается: при изменении Пример: `"hash/dictionary of values"`
auto_detect boolean	Включает или отключает автоматическое обнаружение ресурсоемких URL-адресов. Возвращается: при изменении Пример: `true`
exclude list / elements=string	Задает список URL-адресов или шаблонов, исключаемых из ресурсоемких URL-адресов. Возвращается: при изменении Пример: `["/exclude.html", "/exclude2.html"]`
include complex	Настраивает дополнительные URL-адреса, включаемые в список ресурсоемких URL-адресов. Возвращается: при изменении Пример: `"hash/dictionary of values"`
threshold string	Пороговое значение количества запросов в секунду. Возвращается: при изменении Пример: `"auto"`
url string	URL-адрес, добавляемый в список ресурсоемких URL-адресов. Возвращается: при изменении Пример: `"/include.html"`
latency_threshold integer	Задает пороговое значение задержки для автоматического обнаружения ресурсоемких URL-адресов. Возвращается: при изменении Пример: `2000`
mobile_detection complex	Настраивает обнаружение мобильных приложений, созданных с помощью Anti-Bot Mobile SDK. Возвращается: при изменении Пример: `"hash/dictionary of values"`
allow_android_rooted_device boolean	Разрешает трафик с устройств Android с root-доступом. Возвращается: при изменении Пример: `false`
allow_any_android_package boolean	Разрешает любого издателя приложений. Возвращается: при изменении Пример: `false`
allow_any_ios_package boolean	Разрешает любой пакет iOS. Возвращается: при изменении Пример: `true`
allow_emulators boolean	Разрешает трафик от приложений, запущенных в эмуляторах. Возвращается: при изменении Пример: `true`
allow_jailbroken_devices boolean	Разрешает трафик с устройств iOS со взломанной защитой. Возвращается: при изменении Пример: `false`
android_publishers list / elements=string	Разрешенные сертификаты издателей для приложений Android. Возвращается: при изменении Пример: `["/Common/cert1.crt", "/Common/cert2.crt"]`
client_side_challenge_mode string	Действие, выполняемое при необходимости предъявить CAPTCHA или проверку целостности на стороне клиента. Возвращается: при изменении Пример: `"pass"`
enable boolean	Включает или отключает автоматическое обнаружение мобильных приложений. Возвращается: при изменении Пример: `true`
ios_allowed_package_names list / elements=string	Названия пакетов iOS, трафик для которых разрешен. Возвращается: при изменении Пример: `["package1", "package2"]`
rtbh_duration integer	Длительность анонса маршрута RTBH по протоколу BGP. Возвращается: при изменении Пример: `3600`
rtbh_enable boolean	Включает удаленную активацию черной дыры для атакующих IP-адресов. Возвращается: при изменении Пример: `false`
scrubbing_duration integer	Длительность анонса маршрута очистки трафика по протоколу BGP. Возвращается: при изменении Пример: `3600`
scrubbing_enable boolean	Включает очистку трафика во время атак. Возвращается: при изменении Пример: `true`
single_page_application boolean	Включает поддержку одностраничных приложений. Возвращается: при изменении Пример: `false`
trigger_irule boolean	Активирует событие iRule защиты приложений от DoS-атак. Возвращается: при изменении Пример: `true`

Авторы

Wojciech Wypior (@wojtek0806)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/f5networks/f5_modules/bigip_asm_dos_application_module.html