bigip_firewall_log_profile_network – Configures Network Firewall related settings of the log profile — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# bigip_firewall_log_profile_network – Configures Network Firewall related settings of the log profile

New in version 2.9.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## 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 `log_storage_format` of `field-list`. When creating a new profile, if this parameter is not specified, the default value of `,` (the comma character) will be used. This option is valid when the `log_storage_format` is set to `field-list`. It will be ignored otherwise. Depending on the delimiter used, it may be necessary to wrap the delimiter in quotes to prevent YAML errors from occurring. The special character `$` should not be used, and will raise an error if used, as it is reserved for internal use. The maximum length allowed for this parameter is `31` characters.
log_ip_errors dictionary |  | Modify log settings for logging of IP error packets.
| enabled boolean | Choices: no yes | 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 | Choices: no yes | 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 | Choices: no yes | 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 | Choices: no yes | 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 | Choices: acl_policy_name acl_policy_type acl_rule_name action bigip_hostname context_name context_type date_time dest_fqdn dest_geo dest_ip dest_port drop_reason management_ip_address protocol route_domain sa_translation_pool sa_translation_type source_fqdn source_user src_geo src_ip src_port translated_dest_ip translated_dest_port translated_ip_protocol translated_route_domain translated_src_ip translated_src_port translated_vlan vlan | Specifies a set of fields to be logged. This option is valid when the `log_storage_format` is set to `field-list`. It will be ignored otherwise. 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. `/Foobar/log-publisher`, otherwise the partition for log publisher is inferred from `partition` module parameter.
log_storage_format string | Choices: field-list none | Specifies the type of the storage format. When creating a new log profile, if this parameter is not specified, the default is `none`. When `field-list`, specifies that the log displays only the items you specify in the `log_message_fields` list with `log_format_delimiter` as the delimiter between the items. When `none`, the messages will be logged in the default format, which is `"management_ip_address", "bigip_hostname","context_type", "context_name","src_geo","src_ip", "dest_geo","dest_ip","src_port", "dest_port","vlan","protocol","route_domain", "translated_src_ip", "translated_dest_ip", "translated_src_port","translated_dest_port", "translated_vlan","translated_ip_protocol", "translated_route_domain", "acl_policy_type", "acl_policy_name","acl_rule_name","action", "drop_reason","sa_translation_type", "sa_translation_pool","flow_id", "source_user", "source_fqdn","dest_fqdn"`.
log_tcp_errors dictionary |  | Modify log settings for logging of TCP error packets.
| enabled boolean | Choices: no yes | 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 | Choices: no yes | 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 | Choices: no yes | 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 `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`.
| 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 `ANSIBLE_NET_SSH_KEYFILE`.
| 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: cli 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`.
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 `indefinite`. If specifying a numeric rate, the value must be between `1` and `4294967295`.
state string | Choices: present ← absent | When `state` is `present`, ensures the resource exists. 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 `state` is `absent`, ensures that resource is removed. The `absent` state is ignored for global-network log profile.

## 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)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.