bigip_device_syslog – Manage system-level syslog settings on BIG-IP

New in version 1.0.0.

Synopsis

  • Manage system-level syslog settings on BIG-IP.

Parameters

Parameter Choices/Defaults Configuration Comments
auth_priv_from
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the lowest level of messages about user authentication to include in the system log.
auth_priv_to
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the highest level of messages about user authentication to include in the system log.
console_log
boolean
    Choices:
  • no
  • yes
Enables or disables logging emergency syslog messages to the console.
cron_from
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the lowest level of messages about time-based scheduling to include in the system log.
cron_to
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the highest level of messages about time-based scheduling to include in the system log.
daemon_from
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the lowest level of messages about daemon performance to include in the system log.
daemon_to
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the highest level of messages about daemon performance to include in the system log.
include
string
Syslog-NG configuration to include in the device syslog config.
iso_date
boolean
    Choices:
  • no
  • yes
Enables or disables the ISO date format for messages in the log files.
kern_from
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the lowest level of kernel messages to include in the system log.
kern_to
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the highest level of kernel messages to include in the system log.
local6_from
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the lowest error level for messages from the local6 facility to include in the log.
local6_to
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the highest error level for messages from the local6 facility to include in the log.
mail_from
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the lowest level of mail log messages to include in the system log.
mail_to
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the highest level of mail log messages to include in the system log.
messages_from
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the lowest level of system messages to include in the system log.
messages_to
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the highest level of system messages to include in the system log.
provider
dictionary
added in 1.0.0
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.
no_f5_teem
boolean
    Choices:
  • no
  • yes
If yes, TEEM telemetry data is not sent to F5.
You may omit this option by setting the environment variable F5_TEEM.
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.
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:
  • 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.
user_log_from
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the lowest level of user account messages to include in the system log.
user_log_to
string
    Choices:
  • alert
  • crit
  • debug
  • emerg
  • err
  • info
  • notice
  • warning
Specifies the highest level of user account messages to include in the system log.

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

The following are the fields unique to this module:

Key Returned Description
auth_priv_from
string
changed
The new lowest user authentication logging level.

Sample:
alert
auth_priv_to
string
changed
The new highest user authentication logging level.

Sample:
emerg
console_log
boolean
changed
Whether logging to the console is enabled or not.

Sample:
True
cron_from
string
changed
The new lowest time-based scheduling logging level.

Sample:
emerg
cron_to
string
changed
The new highest time-based scheduling logging level.

Sample:
alert
daemon_from
string
changed
The new lowest daemon performance logging level.

Sample:
alert
daemon_to
string
changed
The new highest daemon performance logging level.

Sample:
alert
include
string
changed
The new extra syslog-ng configuration to include in syslog config.

Sample:
filter f_remote_syslog { not (facility(local6)) };
iso_date
boolean
changed
Whether ISO date format in logs is enabled or not.

kern_from
string
changed
The new lowest kernel messages logging level.

Sample:
alert
kern_to
string
changed
The new highest kernel messages logging level.

Sample:
alert
local6_from
string
changed
The new lowest local6 facility logging level.

Sample:
alert
local6_to
string
changed
The new highest local6 facility logging level.

Sample:
alert
mail_from
string
changed
The new lowest mail log logging level.

Sample:
alert
mail_to
string
changed
The new highest mail log logging level.

Sample:
alert
messages_from
string
changed
The new lowest system logging level.

Sample:
alert
messages_to
string
changed
The new highest system logging level.

Sample:
alert
user_log_from
string
changed
The new lowest user account logging level.

Sample:
alert
user_log_to
string
changed
The new highest user account logging level.

Sample:
alert


Status

Authors

  • Tim Rupp (@caphrim007)