W3cubDocs

/Ansible

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.12.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
Parameters
Notes
Examples
Return Values

Synopsis

Manages AFM (Advanced Firewall Manager) logging profiles configured in the system along with basic information about each profile.

Parameters

Parameter		Choices/Defaults	Comments
description string			Description of the log profile.
dos_protection dictionary			Configures DoS related settings of the log profile.
	dns_publisher string		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. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred from the `partition` module parameter.
	network_publisher string		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. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred from the `partition` module parameter.
	sip_publisher string		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. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred from the `partition` module parameter.
ip_intelligence dictionary			Configures IP Intelligence related settings of the log profile.
	log_publisher string		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. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred the from `partition` module parameter.
	log_rtbh boolean	Choices: no yes	When `yes`, specifies remotely triggered blackholing events are logged.
	log_shun boolean	Choices: no yes	When `yes`, specifies IP Intelligence shun list events are logged. This option can only be set on the `global-network` built-in profile.
	log_translation_fields boolean	Choices: no yes	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.
	rate_limit string		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 `indefinite`. If specifying a numeric rate, the value must be between `1` and `4294967295`.
name string / required			Specifies the name of the log profile.
partition string		Default: "Common"	Device partition to create log profile on. Parameter also used when specifying names for log publishers, unless log publisher names are in fullpath format.
port_misuse dictionary			Port Misuse log configuration.
	log_publisher string		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. `/Foobar/log-publisher`, otherwise the partition for the log publisher is inferred from the `partition` module parameter.
	rate_limit string		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 `indefinite`. If specifying a numeric rate, the value must be between `1` and `4294967295`.
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_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. 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 `state` is `present`, ensures the resource exists. When `state` is `absent`, ensures the resource is removed. Attempts to remove built-in system profiles are ignored and no change is returned.

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		Returned	Description
description string		changed	New description of the AFM log profile. Sample: This is my description
dos_protection complex		changed	Log publishers used in DoS related settings of the log profile. Sample: hash/dictionary of values
	dns_publisher string	changed	The name of the log publisher used for DNS DoS events. Sample: /Common/local-db-publisher
	network_publisher string	changed	The name of the log publisher used for DoS Network events. Sample: /Common/local-db-publisher
	sip_publisher string	changed	The name of the log publisher used for SIP DoS events. Sample: /Common/local-db-publisher
ip_intelligence complex		changed	IP Intelligence related settings of the log profile. Sample: hash/dictionary of values
	log_publisher string	changed	The name of the log publisher used for IP Intelligence events. Sample: /Common/local-db-publisher
	log_rtbh boolean	changed	Logging of remotely triggered blackholing events. Sample: True
	log_shun boolean	changed	Logging of IP Intelligence shun list events.
	log_translation_fields boolean	changed	Logging of translated fields in IP Intelligence log messages.
	rate_limit string	changed	The rate limit for all combined IP intelligence log messages per second. Sample: indefinite
port_misuse complex		changed	Port Misuse related settings of the log profile. Sample: hash/dictionary of values
	log_publisher string	changed	The name of the log publisher used for Port Misuse events. Sample: /Common/local-db-publisher
	rate_limit string	changed	The rate limit for all combined Port Misuse log messages per second. Sample: indefinite

Authors

Wojciech Wypior (@wojtek0806)

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