f5networks.f5_modules.bigip_firewall_dos_vector module – Manage attack vector configuration in an AFM DoS profile
Note
This module is part of the f5networks.f5_modules collection (version 1.32.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install f5networks.f5_modules
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: f5networks.f5_modules.bigip_firewall_dos_vector
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage the attack vector configuration in an AFM (Advanced Firewall Manager) DoS profile. In addition to the normal AFM DoS profile vectors, this module can manage the device-configuration vectors. See the module documentation for details about this method.
Requirements
The below requirements are needed on the host that executes this module.
BIG-IP >= v13.0.0
Parameters
Parameter |
Comments |
---|---|
Specifies addresses that are identified for blacklisting are advertised to BGP routers. Choices:
|
|
Specifies the absolute maximum allowable for packets of this type. This setting rate limits packets to the packets per second setting, when specified. To set no hard limit and allow automatic thresholds to manage all rate limiting, set this to |
|
Specifies packets per second to identify an attack. These settings provide an absolute minimum of packets to allow before the attack is identified. As the automatic detection thresholds adjust to traffic and CPU usage on the system over time, this attack floor becomes less relevant. This value may not exceed the value in |
|
Automatically blacklists detected bad actors. To enable this parameter, the This parameter is not supported by the This parameter is not supported by the Choices:
|
|
Whether Bad Actor detection is enabled or disabled for a vector, if available. This parameter must be enabled to enable the This parameter is not supported by the This parameter is not supported by the Choices:
|
|
Detection before blacklisting occurs, in seconds. |
|
Duration the blacklist will last, in seconds. |
|
Lists how many packets per second the system must discover in traffic in order to detect this attack. |
|
Lists the threshold percent increase over time that the system must detect in traffic in order to detect this attack. The |
|
Specifies the maximum number of this type of packet per second the system allows for a vector. The system drops packets once the traffic level exceeds the rate limit. |
|
Specifies the name of the vector to modify. Vectors that ship with the device are “hard-coded” in that the list of vectors is known to the system and users cannot add new vectors. Users only manipulate the existing vectors; all of which are disabled by default. When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When When Choices:
|
|
Device partition to manage resources on. Default: |
|
Specifies the number of packets per second to identify an IP address as a bad actor. |
|
Specifies the rate limit applied to a source IP that is identified as a bad actor. |
|
Specifies the name of the profile to manage vectors in. The name Vectors can be managed in either DoS Profiles or Device Configuration. By specifying a profile of ‘device-config’, this module will specifically tailor configuration of the provided vectors to the Device Configuration. |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
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 |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
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 |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies results of the current automatic thresholds are logged, though manual thresholds are enforced, and no action is taken on automatic thresholds. The Choices:
|
|
When When When When Choices:
|
|
The The The Choices:
|
Notes
Note
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: Enable DNS AAAA vector mitigation
bigip_firewall_dos_vector:
name: aaaa
state: mitigate
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The new Allow External Advertisement setting. Returned: changed Sample: |
|
The new Attack Ceiling EPS setting. Returned: changed Sample: |
|
The new Attack Floor EPS setting. Returned: changed Sample: |
|
The new Auto Blacklist setting. Returned: changed Sample: |
|
The new Bad Actor Detection setting. Returned: changed Sample: |
|
The new Category Name setting. Returned: changed Sample: |
|
The new Sustained Attack Detection Time setting. Returned: changed Sample: |
|
The new Category Duration Time setting. Returned: changed Sample: |
|
The new Detection Threshold EPS setting. Returned: changed Sample: |
|
The new Detection Threshold Percent setting. Returned: changed Sample: |
|
The new Mitigation Threshold EPS setting. Returned: changed Sample: |
|
The new Per Source IP Detection Threshold EPS setting. Returned: changed Sample: |
|
The new Per Source IP Mitigation Threshold EPS setting. Returned: changed Sample: |
|
The new Simulate Auto Threshold setting. Returned: changed Sample: |
|
The new state of the vector. Returned: changed Sample: |
|
The new Mitigation Threshold EPS setting. Returned: changed Sample: |