f5networks.f5_modules.bigip_firewall_log_profile_network module – Configures Network Firewall related settings of the log 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
.
To use it in a playbook, specify: f5networks.f5_modules.bigip_firewall_log_profile_network
.
New in f5networks.f5_modules 1.0.0
Synopsis
Configures Network Firewall related settings of the log profile.
Parameters
Parameter |
Comments |
---|---|
Specifies the delimiter string when using a When creating a new profile, if this parameter is not specified, the default value of This option is valid when the Depending on the delimiter used, it may be necessary to wrap the delimiter in quotes to prevent YAML errors from occurring. The special character The maximum length allowed for this parameter is |
|
Modifies log settings for logging of IP error packets. |
|
This option enables or disables the logging of IP error packets. Choices:
|
|
This option sets rate limits for the logging of IP error packets. This option is effective only if logging of this message type is enabled. |
|
Modifies log settings for ACL rules configured with an “accept” or “accept decisively” action. |
|
This option enables or disables the logging of packets that match ACL rules configured with an “accept” or “accept decisively” action. Choices:
|
|
This option sets rate limits for the logging of packets that match ACL rules configured with an “accept” or “accept decisively” action. This option is effective only if logging of this message type is enabled. |
|
Modifies log settings for ACL rules configured with a drop action. |
|
This option enables or disables the logging of packets that match ACL rules configured with a drop action. Choices:
|
|
This option sets rate limits for the logging of packets that match ACL rules configured with a drop action. This option is effective only if logging of this message type is enabled. |
|
Modifies log settings for ACL rules configured with a reject action. |
|
This option enables or disables the logging of packets that match ACL rules configured with a reject action. Choices:
|
|
This option sets rate limits for the logging of packets that match ACL rules configured with a reject action. This option is effective only if logging of this message type is enabled. |
|
Specifies a set of fields to be logged. This option is valid when the The order of the list is important, as the server displays the selected traffic items in the log sequentially according to it. Choices:
|
|
Specifies the name of the log publisher used for 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 type of the storage format. When creating a new log profile, if this parameter is not specified, the default is When When Choices:
|
|
Modifies log settings for the logging of TCP error packets. |
|
This option enables or disables the logging of TCP error packets. Choices:
|
|
This option sets rate limits for the logging of TCP error packets. This option is effective only if logging of this message type is enabled. |
|
Modifies the log settings for logging of TCP events on the client side. |
|
This option enables or disables the logging of TCP events on the client side. Only Established and Closed states of a TCP session are logged if this option is enabled. Choices:
|
|
This option sets rate limits for the logging of TCP events on the client side. This option is effective only if logging of this message type is enabled. |
|
This option enables or disables the logging of translated (i.e server side) fields in ACL match and TCP events. Translated fields include (but are not limited to) source address/port, destination address/port, IP protocol, route domain, and VLAN. Choices:
|
|
Device partition to create log profile on. This parameter is also used when specifying names for log publishers, unless log publisher names are in fullpath format. Default: |
|
Specifies the name of the AFM (Advanced Firewall Manager) log profile to be updated. |
|
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:
|
|
Defines a rate limit for all combined network firewall log messages per second. Beyond this rate limit, log messages are not logged. To specify an indefinite rate, use the value If specifying a numeric rate, the value must be between |
|
When The only built-in profile that allows updating network log settings is global-network, attempts to do so on other built-in profiles will be ignored. When 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: Add network settings to log profile
bigip_firewall_log_profile_network:
profile_name: barbaz
rate_limit: "150000"
log_publisher: local-db-pub
log_tcp_errors:
enabled: true
rate_limit: "10000"
log_tcp_events:
enabled: true
rate_limit: "40000"
log_storage_format: "field-list"
log_message_fields:
- vlan
- translated_vlan
- src_ip
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Change delimiter and log fields
bigip_firewall_log_profile_network:
profile_name: barbaz
log_format_delimiter: '.'
log_message_fields:
- translated_dest_ip
- translated_dest_port
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Modify built-in profile
bigip_firewall_log_profile_network:
profile_name: "global-network"
log_publisher: "/foobar/log1"
log_ip_errors:
enabled: true
rate_limit: "60000"
log_matches_reject_rule:
enabled: true
rate_limit: "2000"
log_translation_fields: true
log_storage_format: "field-list"
log_format_delimiter: '.'
log_message_fields:
- protocol
- dest_ip
- dest_port
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Remove custom log profile network log settings
bigip_firewall_log_profile_network:
profile_name: "{{ log_profile }}"
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 |
---|---|
The delimiter string when using a log_storage_format of field-list. Returned: changed Sample: |
|
Log settings for logging of IP error packets. Returned: changed Sample: |
|
Enable or disable the logging of IP error packets. Returned: changed Sample: |
|
The rate limit for the logging of IP error packets. Returned: changed Sample: |
|
Log settings for ACL rules configured with an “accept” or “accept decisively” action. Returned: changed Sample: |
|
Enable or disable the logging of packets that match ACL rules. Returned: changed Sample: |
|
The rate limit for the logging of packets that match ACL rules. Returned: changed Sample: |
|
Log settings for ACL rules configured with a drop action. Returned: changed Sample: |
|
Enable or disable the logging of packets that match ACL rules. Returned: changed Sample: |
|
The rate limit for the logging of packets that match ACL rules. Returned: changed Sample: |
|
Log settings for ACL rules configured with a reject action. Returned: changed Sample: |
|
Enable or disable the logging of packets that match ACL rules. Returned: changed Sample: |
|
The rate limit for the logging of packets that match ACL rules. Returned: changed Sample: |
|
The delimiter string when using a log_storage_format of field-list. Returned: changed Sample: |
|
The name of the log publisher used for Network events. Returned: changed Sample: |
|
The type of the storage format. Returned: changed Sample: |
|
Log settings for logging of TCP error packets. Returned: changed Sample: |
|
Enable or disable the logging of TCP error packets. Returned: changed Sample: |
|
The rate limit for the logging of TCP error packets. Returned: changed Sample: |
|
Log settings for logging of TCP events on the client side. Returned: changed Sample: |
|
Enable or disable the logging of TCP events on the client side. Returned: changed Sample: |
|
The rate limit for the logging of TCP events on the client side. Returned: changed Sample: |
|
Enable or disable the logging of translated (i.e server side) fields in ACL match and TCP events. Returned: changed Sample: |
|
The rate limit for all combined network firewall log messages per second. Returned: changed Sample: |
Authors
Wojciech Wypior (@wojtek0806)