W3cubDocs

/Ansible 2.10

f5networks.f5_modules.bigip_firewall_dos_profile – Manage AFM DoS profiles on a BIG-IP

Note

This plugin is part of the f5networks.f5_modules collection.

To install it use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_firewall_dos_profile.

New in version 1.0.0: of f5networks.f5_modules

Synopsis

  • Manages AFM (Advanced Firewall Manager) Denial of Service (DoS) profiles on a BIG-IP. To manage the vectors associated with a DoS profile, refer to the bigip_firewall_dos_vector module.

Parameters

Parameter Choices/Defaults Comments
default_whitelist
string
The default whitelist address list for the system to use to determine which IP addresses are legitimate.
The system does not examine traffic from the IP addresses in the list when performing DoS prevention.
To define a new whitelist, use the bigip_firewall_address_list module.
description
string
The description of the DoS profile.
name
string / required
Specifies the name of the profile.
partition
string
Default:
"Common"
Device partition to manage resources on.
provider
dictionary
added in 1.0.0 of f5networks.f5_modules
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
    Choices:
  • no
  • yes
If yes, TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TEEM.
password
string / required
The password for the user account used to connect to the BIG-IP.
You may omit this option by setting the environment variable F5_PASSWORD.

aliases: pass, pwd
server
string / required
The BIG-IP 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
    Choices:
  • rest ←
Configures the transport connection to use when connecting to the remote device.
user
string / required
The username to connect to the BIG-IP with. This user must have administrative privileges on the device.
You may omit this option by setting the environment variable F5_USER.
validate_certs
boolean
    Choices:
  • no
  • yes ←
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.
state
string
    Choices:
  • present ←
  • absent
When present, ensures the resource exists.
When absent, ensures the resource is removed.
threshold_sensitivity
string
    Choices:
  • low
  • medium
  • high
Specifies the threshold sensitivity for the DoS profile.
Thresholds for detecting attacks are higher when sensitivity is low, and lower when sensitivity is high.
When creating a new profile, if this parameter is not specified, the default is medium.

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: Create a new DoS profile
  bigip_firewall_dos_profile:
    name: profile1
    description: DoS profile 1
    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 Returned Description
default_whitelist
string
changed
The new whitelist attached to the profile.

Sample:
/Common/whitelist1
description
string
changed
The description of the profile.

Sample:
New description
threshold_sensitivity
string
changed
The new threshold sensitivity of the profile.

Sample:
low


Authors

  • Tim Rupp (@caphrim007)

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