Last updated on: 2024-04-01 03:24:20.
bigip_asm_dos_application – Manage application settings for a DOS profile¶
New in version 1.0.0.
Parameters¶
Parameter | Choices/Defaults | Configuration | Comments | ||
---|---|---|---|---|---|
geolocations
dictionary
|
Manages the geolocations countries whitelist, blacklist.
|
||||
blacklist
list
/ elements=string
|
A list of countries to be put on the blacklist, must not have overlapping elements with
whitelist . |
||||
whitelist
list
/ elements=string
|
A list of countries to be put on the whitelist, must not have overlapping elements with
blacklist . |
||||
heavy_urls
dictionary
|
Manages Heavy URL protection.
Heavy URLs are a small number of site URLs that might consume considerable server resources per request.
|
||||
auto_detect
boolean
|
|
Enables or disables automatic heavy URL detection.
|
|||
exclude
list
/ elements=string
|
Specifies a list of URLs or wildcards to exclude from the heavy URLs.
|
||||
include
list
/ elements=dictionary
|
Configures additional URLs to include in the heavy URLs that were auto-detected.
|
||||
threshold
string
|
Specifies the threshold of requests per second, where the URL in question is considered under attack.
The acceptable range is between 1 and 4294967295 inclusive, or
auto . |
||||
url
string
/ required
|
Specifies the URL to be added to the list of heavy URLs, in addition to those automatically detected.
|
||||
latency_threshold
integer
|
Specifies the latency threshold for automatic heavy URL detection.
The acceptable range is between 0 and 4294967295 miliseconds inclusive.
|
||||
mobile_detection
dictionary
|
Configures detection of mobile applications built with the Anti-Bot Mobile SDK and defines how requests from these mobile application clients are handled.
|
||||
allow_android_rooted_device
boolean
|
|
When
true , the device allows traffic from rooted Android devices. |
|||
allow_any_android_package
boolean
|
|
When
true , allows any application publisher.A publisher is identified by the certificate used to sign the application.
|
|||
allow_any_ios_package
boolean
|
|
When
true , allows any iOS package.A package name is the unique identifier of the mobile application.
|
|||
allow_emulators
boolean
|
|
When
true , allows traffic from applications run on emulators. |
|||
allow_jailbroken_devices
boolean
|
|
When
true , allows traffic from jailbroken iOS devices. |
|||
android_publishers
list
/ elements=string
|
This option has no effect when
allow_any_android_package is set to true .Specifies the allowed publisher certificates for android applications.
The publisher certificate needs to be installed on the BIG-IP beforehand.
The certificate name located on a different partition than the one specified in the
partition parameter needs to be provided in full_path format, e.g. /Foo/cert.crt . |
||||
client_side_challenge_mode
string
|
|
Action to take when a CAPTCHA or Client Side Integrity challenge needs to be presented.
The mobile application user will not see a CAPTCHA challenge and the mobile application will not be presented with the Client Side Integrity challenge. The such options for mobile applications are
pass or cshui .When
pass the traffic is passed without incident.When
cshui the SDK checks for human interactions with the screen in the last few seconds. If none are detected, the traffic is blocked. |
|||
enabled
boolean
|
|
When
true , requests from mobile applications built with Anti-Bot Mobile SDK are detected and handled according to the parameters set.When
false , these requests are handled like any other request which may let attacks in, or cause false positives. |
|||
ios_allowed_package_names
list
/ elements=string
|
Specifies the names of iOS packages to allow traffic on.
This option has no effect when
allow_any_ios_package is set to true . |
||||
partition
string
|
Default: "Common"
|
Device partition to manage resources on.
|
|||
profile
string
/ required
|
Specifies the name of the profile to manage application settings in.
|
||||
provider
dictionary
added in 1.0.0 |
A dict object containing connection details.
|
||||
auth_provider
string
|
Configures the auth provider for to obtain authentication tokens from the remote device.
This option is really used when working with BIG-IQ devices.
|
||||
no_f5_teem
boolean
|
|
If
yes , TEEM telemetry data is not sent to F5.You may omit this option by setting the environment variable
F5_TELEMETRY_OFF .Previously used variable
F5_TEEM is deprecated as its name was confusing. |
|||
password
string
/ required
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ.
You may omit this option by setting the environment variable
F5_PASSWORD .aliases: pass, pwd |
||||
server
string
/ required
|
The BIG-IP host or the BIG-IQ host.
You may omit this option by setting the environment variable
F5_SERVER . |
||||
server_port
integer
|
Default: 443
|
The BIG-IP server port.
You may omit this option by setting the environment variable
F5_SERVER_PORT . |
|||
timeout
integer
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
||||
transport
string
|
|
Configures the transport connection to use when connecting to the remote device.
|
|||
user
string
/ required
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable
F5_USER . |
||||
validate_certs
boolean
|
|
If
no , SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates.You may omit this option by setting the environment variable
F5_VALIDATE_CERTS . |
|||
rtbh_duration
integer
|
Specifies the duration of the RTBH BGP route advertisement, in seconds.
The acceptable range is between 0 and 4294967295 inclusive.
|
||||
rtbh_enable
boolean
|
|
Specifies whether to enable Remote Triggered Black Hole
RTBH of attacking IPs by advertising BGP routes. |
|||
scrubbing_duration
integer
|
Specifies the duration of the Traffic Scrubbing BGP route advertisement, in seconds.
The acceptable range is between 0 and 4294967295 inclusive.
|
||||
scrubbing_enable
boolean
|
|
Specifies whether to enable Traffic Scrubbing during attacks by advertising BGP routes.
|
|||
single_page_application
boolean
|
|
When
true , specifies the system supports a Single Page Applications. |
|||
state
string
|
|
When
state is present , ensures that the Application object exists.When
state is absent , ensures that the Application object is removed. |
|||
trigger_irule
boolean
|
|
When
true , specifies the system activates an Application DoS iRule event. |
Notes¶
Note
- Requires BIG-IP >= 13.1.0
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires BIG-IP software version >= 12.
- The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.
Examples¶
- 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
Return Values¶
The following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
geolocations
complex
|
changed |
Specifies geolocations countries whitelist, blacklist.
Sample:
hash/dictionary of values
|
||
blacklist
list
|
changed |
A list of countries to be put on the blacklist.
Sample:
['Russia', 'Germany']
|
||
whitelist
list
|
changed |
A list of countries to be put on the whitelist.
Sample:
['United States, United Kingdom']
|
||
heavy_urls
complex
|
changed |
Manages Heavy URL protection.
Sample:
hash/dictionary of values
|
||
auto_detect
boolean
|
changed |
Enables or disables automatic heavy URL detection.
Sample:
True
|
||
exclude
list
|
changed |
Specifies a list of URLs or wildcards to exclude from the heavy URLs.
Sample:
['/exclude.html', '/exclude2.html']
|
||
include
complex
|
changed |
Configures additional URLs to include in the heavy URLs.
Sample:
hash/dictionary of values
|
||
threshold
string
|
changed |
The threshold of requests per second.
Sample:
auto
|
||
url
string
|
changed |
The URL to be added to the list of heavy URLs.
Sample:
/include.html
|
||
latency_threshold
integer
|
changed |
Specifies the latency threshold for automatic heavy URL detection.
Sample:
2000
|
||
mobile_detection
complex
|
changed |
Configures detection of mobile applications built with the Anti-Bot Mobile SDK.
Sample:
hash/dictionary of values
|
||
allow_android_rooted_device
boolean
|
changed |
Allows traffic from rooted Android devices.
|
||
allow_any_android_package
boolean
|
changed |
Allows any application publisher.
|
||
allow_any_ios_package
boolean
|
changed |
Allows any iOS package.
Sample:
True
|
||
allow_emulators
boolean
|
changed |
Allows traffic from applications run on emulators.
Sample:
True
|
||
allow_jailbroken_devices
boolean
|
changed |
Allows traffic from jailbroken iOS devices.
|
||
android_publishers
list
|
changed |
The allowed publisher certificates for android applications.
Sample:
['/Common/cert1.crt', '/Common/cert2.crt']
|
||
client_side_challenge_mode
string
|
changed |
Action to take when a CAPTCHA or Client Side Integrity challenge needs to be presented.
Sample:
pass
|
||
enable
boolean
|
changed |
Enables or disables automatic mobile detection.
Sample:
True
|
||
ios_allowed_package_names
list
|
changed |
The names of iOS packages to allow traffic on.
Sample:
['package1', 'package2']
|
||
rtbh_duration
integer
|
changed |
The duration of the RTBH BGP route advertisement.
Sample:
3600
|
||
rtbh_enable
boolean
|
changed |
Enables Remote Triggered Black Hole of attacking IPs.
|
||
scrubbing_duration
integer
|
changed |
The duration of the Traffic Scrubbing BGP route advertisement.
Sample:
3600
|
||
scrubbing_enable
boolean
|
changed |
Enables Traffic Scrubbing during attacks.
Sample:
True
|
||
single_page_application
boolean
|
changed |
Enables support of Single Page Applications.
|
||
trigger_irule
boolean
|
changed |
Activates an Application DoS iRule event.
Sample:
True
|