bigip_firewall_log_profile_network – Configures Network Firewall related settings of the log profile
Synopsis
- Configures Network Firewall related settings of the log profile.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
log_format_delimiter string |
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 | ||
log_ip_errors dictionary |
Modify log settings for logging of IP error packets. | ||
enabled boolean |
|
This option is used to enable or disable the logging of IP error packets. | |
rate_limit integer |
This option is used to set rate limits for the logging of IP error packets. This option is effective only if logging of this message type is enabled. | ||
log_matches_accept_rule dictionary |
Modify log settings for ACL rules configured with an "accept" or "accept decisively" action. | ||
enabled boolean |
|
This option is used to enable or disable the logging of packets that match ACL rules configured with an "accept" or "accept decisively" action. | |
rate_limit integer |
This option is used to set 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. | ||
log_matches_drop_rule dictionary |
Modify log settings for ACL rules configured with a drop action. | ||
enabled boolean |
|
This option is used to enable or disable the logging of packets that match ACL rules configured with a drop action. | |
rate_limit integer |
This option is used to set 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. | ||
log_matches_reject_rule dictionary |
Modify log settings for ACL rules configured with a reject action. | ||
enabled boolean |
|
This option is used to enable or disable the logging of packets that match ACL rules configured with a reject action. | |
rate_limit integer |
This option is used to set 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. | ||
log_message_fields list |
|
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. | |
log_publisher string |
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. | ||
log_storage_format string |
|
Specifies the type of the storage format. When creating a new log profile, if this parameter is not specified, the default is When When | |
log_tcp_errors dictionary |
Modify log settings for logging of TCP error packets. | ||
enabled boolean |
|
This option is used to enable or disable the logging of TCP error packets. | |
rate_limit integer |
This option is used to set rate limits for the logging of TCP error packets. This option is effective only if logging of this message type is enabled. | ||
log_tcp_events dictionary |
Modify log settings for logging of TCP events on the client side. | ||
enabled boolean |
|
This option is used to enable or disable 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. | |
rate_limit integer |
This option is used to set 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. | ||
log_translation_fields boolean |
|
This option is used to enable or disable 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. | |
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. | |
profile_name string / required |
Specifies the name of the AFM log profile to be updated. | ||
provider dictionary added in 2.5 |
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. | ||
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
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
ssh_keyfile path |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable | ||
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 |
|
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
rate_limit string |
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 | ||
state string |
|
When 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 |
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 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: yes
rate_limit: 10000
log_tcp_events:
enabled: yes
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: yes
rate_limit: 60000
log_matches_reject_rule:
enabled: yes
rate_limit: 2000
log_translation_fields: yes
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 | Returned | Description | |
---|---|---|---|
log_format_delimiter string |
changed |
The delimiter string when using a log_storage_format of field-list.
Sample: . | |
log_ip_errors complex |
changed |
Log settings for logging of IP error packets.
Sample: hash/dictionary of values | |
enabled boolean |
changed |
Enable or disable the logging of IP error packets.
Sample: True | |
rate_limit string |
changed |
The rate limit for the logging of IP error packets.
Sample: indefinite | |
log_matches_accept_rule complex |
changed |
Log settings for ACL rules configured with an "accept" or "accept decisively" action.
Sample: hash/dictionary of values | |
enabled boolean |
changed |
Enable or disable the logging of packets that match ACL rules.
Sample: True | |
rate_limit string |
changed |
The rate limit for the logging of packets that match ACL rules.
Sample: indefinite | |
log_matches_drop_rule complex |
changed |
Log settings for ACL rules configured with a drop action.
Sample: hash/dictionary of values | |
enabled boolean |
changed |
Enable or disable the logging of packets that match ACL rules.
Sample: True | |
rate_limit string |
changed |
The rate limit for the logging of packets that match ACL rules.
Sample: indefinite | |
log_matches_reject_rule complex |
changed |
Log settings for ACL rules configured with a reject action.
Sample: hash/dictionary of values | |
enabled boolean |
changed |
Enable or disable the logging of packets that match ACL rules.
Sample: True | |
rate_limit string |
changed |
The rate limit for the logging of packets that match ACL rules.
Sample: indefinite | |
log_message_fields list |
changed |
The delimiter string when using a log_storage_format of field-list.
Sample: ['acl_policy_name', 'acl_policy_type'] | |
log_publisher string |
changed |
The name of the log publisher used for Network events.
Sample: /Common/log-publisher | |
log_storage_format string |
changed |
The type of the storage format.
Sample: field-list | |
log_tcp_errors complex |
changed |
Log settings for logging of TCP error packets.
Sample: hash/dictionary of values | |
enabled boolean |
changed |
Enable or disable the logging of TCP error packets.
Sample: True | |
rate_limit string |
changed |
The rate limit for the logging of TCP error packets.
Sample: indefinite | |
log_tcp_events complex |
changed |
Log settings for logging of TCP events on the client side.
Sample: hash/dictionary of values | |
enabled boolean |
changed |
Enable or disable the logging of TCP events on the client side.
Sample: True | |
rate_limit string |
changed |
The rate limit for the logging of TCP events on the client side.
Sample: indefinite | |
log_translation_fields boolean |
changed |
Enable or disable the logging of translated (i.e server side) fields in ACL match and TCP events.
Sample: True | |
rate_limit string |
changed |
The rate limit for all combined network firewall log messages per second.
Sample: indefinite |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
Authors
- Wojciech Wypior (@wojtek0806)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/bigip_firewall_log_profile_network_module.html