f5networks.f5_modules.bigip_firewall_log_profile – Manages AFM logging profiles configured in the system
Note
This plugin is part of the f5networks.f5_modules collection (version 1.13.0).
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
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_firewall_log_profile
.
New in version 1.0.0: of f5networks.f5_modules
Synopsis
Manages AFM (Advanced Firewall Manager) logging profiles configured in the system along with basic information about each profile.
Parameters
Parameter |
Comments |
---|---|
Description of the log profile. |
|
Configures DoS related settings of the log profile. |
|
Specifies the name of the log publisher used for DNS DoS events. To specify the log_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. |
|
Specifies the name of the log publisher used for DoS Network events. To specify the log_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. |
|
Specifies the name of the log publisher used for SIP DoS events. To specify the log_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. |
|
Configures IP Intelligence related settings of the log profile. |
|
Specifies the name of the log publisher used for IP Intelligence events. To specify the log_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. |
|
When Choices:
|
|
When This option can only be set on the Choices:
|
|
This option is used to enable or disable the logging of translated (i.e server side) fields in IP Intelligence log messages. Translated fields include (but are not limited to) source address/port, destination address/port, IP protocol, route domain, and VLAN. Choices:
|
|
Defines a rate limit for all combined IP intelligence log messages per second. Beyond this rate limit, log messages are not logged until the threshold drops below the specified rate. To specify an indefinite rate, use the value If specifying a numeric rate, the value must be between |
|
Specifies the name of the log profile. |
|
Device partition to create log profile on. Parameter also used when specifying names for log publishers, unless log publisher names are in fullpath format. Default: “Common” |
|
Port Misuse log configuration. |
|
Specifies the name of the log publisher used for Port Misuse events. To specify the log_publisher on a different partition from the AFM log profile, specify the name in fullpath format, e.g. |
|
Defines a rate limit for all combined port misuse log messages per second. Beyond this rate limit, log messages are not logged until the threshold drops below the specified rate. To specify an indefinite rate, use the value If specifying a numeric rate, the value must be between |
|
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. You may omit this option by setting the environment variable |
|
The BIG-IP 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: 443 |
|
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 with. 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:
|
|
When When 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: Create a basic log profile with port misuse
bigip_firewall_log_profile:
name: barbaz
port_misuse:
rate_limit: 30000
log_publisher: local-db-pub
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Change ip_intelligence settings, publisher on different partition, remove port misuse
bigip_firewall_log_profile:
name: barbaz
ip_intelligence:
rate_limit: 400000
log_translation_fields: yes
log_rtbh: yes
log_publisher: "/foobar/non-local-db"
port_misuse:
log_publisher: ""
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create a log profile with dos protection, different partition
bigip_firewall_log_profile:
name: foobar
partition: foobar
dos_protection:
dns_publisher: "/Common/local-db-pub"
sip_publisher: "non-local-db"
network_publisher: "/Common/local-db-pub"
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove log profile
bigip_firewall_log_profile:
name: barbaz
partition: Common
state: absent
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 |
---|---|
New description of the AFM log profile. Returned: changed Sample: “This is my description” |
|
Log publishers used in DoS related settings of the log profile. Returned: changed Sample: “hash/dictionary of values” |
|
The name of the log publisher used for DNS DoS events. Returned: changed Sample: “/Common/local-db-publisher” |
|
The name of the log publisher used for DoS Network events. Returned: changed Sample: “/Common/local-db-publisher” |
|
The name of the log publisher used for SIP DoS events. Returned: changed Sample: “/Common/local-db-publisher” |
|
IP Intelligence related settings of the log profile. Returned: changed Sample: “hash/dictionary of values” |
|
The name of the log publisher used for IP Intelligence events. Returned: changed Sample: “/Common/local-db-publisher” |
|
Logging of remotely triggered blackholing events. Returned: changed Sample: true |
|
Logging of IP Intelligence shun list events. Returned: changed Sample: false |
|
Logging of translated fields in IP Intelligence log messages. Returned: changed Sample: false |
|
The rate limit for all combined IP intelligence log messages per second. Returned: changed Sample: “indefinite” |
|
Port Misuse related settings of the log profile. Returned: changed Sample: “hash/dictionary of values” |
|
The name of the log publisher used for Port Misuse events. Returned: changed Sample: “/Common/local-db-publisher” |
|
The rate limit for all combined Port Misuse log messages per second. Returned: changed Sample: “indefinite” |
Authors
Wojciech Wypior (@wojtek0806)