f5networks.f5_modules.bigip_device_syslog module – Manage system-level syslog settings on BIG-IP
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_device_syslog
.
New in f5networks.f5_modules 1.0.0
Synopsis
Manage system-level syslog settings on BIG-IP.
Parameters
Parameter |
Comments |
---|---|
Specifies the lowest level of messages about user authentication to include in the system log. Choices:
|
|
Specifies the highest level of messages about user authentication to include in the system log. Choices:
|
|
Enables or disables logging emergency syslog messages to the console. Choices:
|
|
Specifies the lowest level of messages about time-based scheduling to include in the system log. Choices:
|
|
Specifies the highest level of messages about time-based scheduling to include in the system log. Choices:
|
|
Specifies the lowest level of messages about daemon performance to include in the system log. Choices:
|
|
Specifies the highest level of messages about daemon performance to include in the system log. Choices:
|
|
Syslog-NG configuration to include in the device syslog config. |
|
Enables or disables the ISO date format for messages in the log files. Choices:
|
|
Specifies the lowest level of kernel messages to include in the system log. Choices:
|
|
Specifies the highest level of kernel messages to include in the system log. Choices:
|
|
Specifies the lowest error level for messages from the local6 facility to include in the log. Choices:
|
|
Specifies the highest error level for messages from the local6 facility to include in the log. Choices:
|
|
Specifies the lowest level of mail log messages to include in the system log. Choices:
|
|
Specifies the highest level of mail log messages to include in the system log. Choices:
|
|
Specifies the lowest level of system messages to include in the system log. Choices:
|
|
Specifies the highest level of system messages to include in the system log. 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:
|
|
Specifies the lowest level of user account messages to include in the system log. Choices:
|
|
Specifies the highest level of user account messages to include in the system log. 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 syslog config
bigip_device_syslog:
name: foo
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 lowest user authentication logging level. Returned: changed Sample: |
|
The new highest user authentication logging level. Returned: changed Sample: |
|
Whether logging to the console is enabled or not. Returned: changed Sample: |
|
The new lowest time-based scheduling logging level. Returned: changed Sample: |
|
The new highest time-based scheduling logging level. Returned: changed Sample: |
|
The new lowest daemon performance logging level. Returned: changed Sample: |
|
The new highest daemon performance logging level. Returned: changed Sample: |
|
The new extra syslog-ng configuration to include in syslog config. Returned: changed Sample: |
|
Whether ISO date format in logs is enabled or not. Returned: changed Sample: |
|
The new lowest kernel messages logging level. Returned: changed Sample: |
|
The new highest kernel messages logging level. Returned: changed Sample: |
|
The new lowest local6 facility logging level. Returned: changed Sample: |
|
The new highest local6 facility logging level. Returned: changed Sample: |
|
The new lowest mail log logging level. Returned: changed Sample: |
|
The new highest mail log logging level. Returned: changed Sample: |
|
The new lowest system logging level. Returned: changed Sample: |
|
The new highest system logging level. Returned: changed Sample: |
|
The new lowest user account logging level. Returned: changed Sample: |
|
The new highest user account logging level. Returned: changed Sample: |