f5networks.f5_modules.bigip_log_destination module – Manages log destinations on a BIG-IP.
Note
This module is part of the f5networks.f5_modules collection (version 1.27.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_log_destination
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manages log destinations on a BIG-IP device.
Parameters
Parameter |
Comments |
---|---|
Specifies the IP address that will receive messages from the specified local Log Destination. This parameter is only available when When creating a new log destination and |
|
The description of the log destination. |
|
Specifies the distribution method used by the Remote High Speed Log destination to send messages to pool members. When When When When creating a new log destination and Choices:
|
|
When When When creating a new log destination and |
|
Specifies the name of the log destination. |
|
Device partition to manage resources on. Default: |
|
When When When creating a new destination and |
|
Specifies the port of the IP address that will receive messages from the specified local Log Destination. This parameter is only available when When creating a new log destination and |
|
When When When When Choices:
|
|
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:
|
|
If the An SSL server profile defines how to communicate securely over SSL or Transport Layer Security (TLS). This parameter is only available when |
|
When When Choices:
|
|
Specifies the method to use to format the logs associated with the remote Syslog log destination. When creating a new log destination (and The The Choices:
|
|
Enter the time (in seconds) that the BIG-IP device should pause between deleting an obsolete IPFIX template and reusing its template ID. This feature is useful for systems where you use iRules to create customized IPFIX templates. |
|
Enter the time (in seconds) between each transmission of IPFIX templates to the pool of IPFIX collectors. The logging destination periodically retransmits all of its IPFIX templates at the interval you set in this field. These retransmissions are helpful for UDP, a lossy transport mechanism. This parameter is only available when |
|
Is a transport profile based on either TCP or UDP. This profile defines the TCP or UDP options used to send IP-traffic logs to the pool of collectors. This parameter is only available when |
|
Specifies the type of log destination. Once created, this parameter cannot be changed. 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 high-speed logging destination
bigip_log_destination:
name: foo
type: remote-high-speed-log
pool: my-ltm-pool
provider:
password: secret
server: lb.mydomain.com
user: admin
delegate_to: localhost
- name: Create a remote-syslog logging destination
bigip_log_destination:
name: foo
type: remote-syslog
syslog_format: rfc5424
forward_to: my-destination
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 new Address value. Returned: changed Sample: |
|
The new Distribution Method value. Returned: changed Sample: |
|
The new Forward To value. Returned: changed Sample: |
|
The new Pool value. Returned: changed Sample: |
|
The new Port value. Returned: changed Sample: |
|
The new Protocol value. Returned: changed Sample: |
|
The new Server SSL Profile value. Returned: changed Sample: |
|
The new Syslog format value. Returned: changed Sample: |
|
The new Template Delete Delay value. Returned: changed Sample: |
|
The new Template Retransmit Interval value. Returned: changed Sample: |
|
The new Transport Profile value. Returned: changed Sample: |