f5networks.f5_modules.bigip_device_syslog (1.28.0) — module

Manage system-level syslog settings on BIG-IP

| "added in version" 1.0.0 of f5networks.f5_modules"

Authors: Tim Rupp (@caphrim007)

Install collection

Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0


Add to requirements.yml

  collections:
    - name: f5networks.f5_modules
      version: 1.28.0

Description

Manage system-level syslog settings on BIG-IP.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create a syslog config
  bigip_device_syslog:
    name: foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

Inputs

    
cron_to:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the highest level of messages about time-based scheduling to include in
      the system log.
    type: str

include:
    description:
    - Syslog-NG configuration to include in the device syslog config.
    type: str

kern_to:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the highest level of kernel messages to include in the system log.
    type: str

mail_to:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the highest level of mail log messages to include in the system log.
    type: str

iso_date:
    description:
    - Enables or disables the ISO date format for messages in the log files.
    type: bool

provider:
    description:
    - A dict object containing connection details.
    suboptions:
      auth_provider:
        description:
        - Configures the auth provider for to obtain authentication tokens from the remote
          device.
        - This option is really used when working with BIG-IQ devices.
        type: str
      no_f5_teem:
        default: false
        description:
        - If C(yes), TEEM telemetry data is not sent to F5.
        - You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
        - Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
        type: bool
      password:
        aliases:
        - pass
        - pwd
        description:
        - 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 C(F5_PASSWORD).
        required: true
        type: str
      server:
        description:
        - The BIG-IP host or the BIG-IQ host.
        - You may omit this option by setting the environment variable C(F5_SERVER).
        required: true
        type: str
      server_port:
        default: 443
        description:
        - The BIG-IP server port.
        - You may omit this option by setting the environment variable C(F5_SERVER_PORT).
        type: int
      timeout:
        description:
        - 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.
        type: int
      transport:
        choices:
        - rest
        default: rest
        description:
        - Configures the transport connection to use when connecting to the remote device.
        type: str
      user:
        description:
        - 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 C(F5_USER).
        required: true
        type: str
      validate_certs:
        default: true
        description:
        - If C(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 C(F5_VALIDATE_CERTS).
        type: bool
    type: dict
    version_added: 1.0.0
    version_added_collection: f5networks.f5_modules

cron_from:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the lowest level of messages about time-based scheduling to include in
      the system log.
    type: str

daemon_to:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the highest level of messages about daemon performance to include in the
      system log.
    type: str

kern_from:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the lowest level of kernel messages to include in the system log.
    type: str

local6_to:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the highest error level for messages from the local6 facility to include
      in the log.
    type: str

mail_from:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the lowest level of mail log messages to include in the system log.
    type: str

console_log:
    description:
    - Enables or disables logging emergency syslog messages to the console.
    type: bool

daemon_from:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the lowest level of messages about daemon performance to include in the
      system log.
    type: str

local6_from:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the lowest error level for messages from the local6 facility to include
      in the log.
    type: str

messages_to:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the highest level of system messages to include in the system log.
    type: str

user_log_to:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the highest level of user account messages to include in the system log.
    type: str

auth_priv_to:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the highest level of messages about user authentication to include in
      the system log.
    type: str

messages_from:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the lowest level of system messages to include in the system log.
    type: str

user_log_from:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the lowest level of user account messages to include in the system log.
    type: str

auth_priv_from:
    choices:
    - alert
    - crit
    - debug
    - emerg
    - err
    - info
    - notice
    - warning
    description:
    - Specifies the lowest level of messages about user authentication to include in the
      system log.
    type: str

Outputs

auth_priv_from:
  description: The new lowest user authentication logging level.
  returned: changed
  sample: alert
  type: str
auth_priv_to:
  description: The new highest user authentication logging level.
  returned: changed
  sample: emerg
  type: str
console_log:
  description: Whether logging to the console is enabled or not.
  returned: changed
  sample: true
  type: bool
cron_from:
  description: The new lowest time-based scheduling logging level.
  returned: changed
  sample: emerg
  type: str
cron_to:
  description: The new highest time-based scheduling logging level.
  returned: changed
  sample: alert
  type: str
daemon_from:
  description: The new lowest daemon performance logging level.
  returned: changed
  sample: alert
  type: str
daemon_to:
  description: The new highest daemon performance logging level.
  returned: changed
  sample: alert
  type: str
include:
  description: The new extra syslog-ng configuration to include in syslog config.
  returned: changed
  sample: filter f_remote_syslog { not (facility(local6)) };
  type: str
iso_date:
  description: Whether ISO date format in logs is enabled or not.
  returned: changed
  sample: false
  type: bool
kern_from:
  description: The new lowest kernel messages logging level.
  returned: changed
  sample: alert
  type: str
kern_to:
  description: The new highest kernel messages logging level.
  returned: changed
  sample: alert
  type: str
local6_from:
  description: The new lowest local6 facility logging level.
  returned: changed
  sample: alert
  type: str
local6_to:
  description: The new highest local6 facility logging level.
  returned: changed
  sample: alert
  type: str
mail_from:
  description: The new lowest mail log logging level.
  returned: changed
  sample: alert
  type: str
mail_to:
  description: The new highest mail log logging level.
  returned: changed
  sample: alert
  type: str
messages_from:
  description: The new lowest system logging level.
  returned: changed
  sample: alert
  type: str
messages_to:
  description: The new highest system logging level.
  returned: changed
  sample: alert
  type: str
user_log_from:
  description: The new lowest user account logging level.
  returned: changed
  sample: alert
  type: str
user_log_to:
  description: The new highest user account logging level.
  returned: changed
  sample: alert
  type: str