JBoss EAP 6.3 Model Reference

  1. JBoss EAP 6.3
  2. core-service=management
  3. access=audit
  4. syslog-handler

A syslog handler for use with the management audit logging service.

Children (1)

  • protocol The protocol to use for the syslog handler. Must be one and only one of 'udp', 'tcp' or 'tls'.
    • tcp Configuration to append to syslog over tcp/ip.
    • tls Configuration to append to syslog over tls over tcp/ip.
    • udp Configuration to append to syslog over udp/ip.

Attributes (9)

  • app-name The application name to add to the syslog records as defined in section 6.2.5 of RFC-5424. If not specified it will default to the name of the product.
    • Attribute Value
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • disabled-due-to-failure Whether this handler has been disabled due to logging failures.
    • Attribute Value
    Type BOOLEAN
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • facility The facility to use for syslog logging as defined in section 6.2.1 of RFC-5424, and section 4.1.1 of RFC-3164.
    • Attribute Value
    Default Value USER_LEVEL
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values KERNEL
    USER_LEVEL
    MAIL_SYSTEM
    SYSTEM_DAEMONS
    SECURITY
    SYSLOGD
    LINE_PRINTER
    NETWORK_NEWS
    UUCP
    CLOCK_DAEMON
    SECURITY2
    FTP_DAEMON
    NTP
    LOG_AUDIT
    LOG_ALERT
    CLOCK_DAEMON2
    LOCAL_USE_0
    LOCAL_USE_1
    LOCAL_USE_2
    LOCAL_USE_3
    LOCAL_USE_4
    LOCAL_USE_5
    LOCAL_USE_6
    LOCAL_USE_7
  • failure-count The number of logging failures since the handler was initialized.
    • Attribute Value
    Type INT
    Nillable false
    Expressions Allowed false
    Storage runtime
    Access Type read-only
  • formatter The formatter used to format the log messages.
    • Attribute Value
    Type STRING
    Nillable false
    Expressions Allowed false
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • max-failure-count The maximum number of logging failures before disabling this handler.
    • Attribute Value
    Default Value 10
    Type INT
    Nillable true
    Expressions Allowed true
    Min 0
    Max 2,147,483,647
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • max-length The maximum length in bytes a log message, including the header, is allowed to be. If undefined, it will default to 1024 bytes if the syslog-format is RFC3164, or 2048 bytes if the syslog-format is RFC5424.
    • Attribute Value
    Type INT
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
  • syslog-format Whether to set the syslog format to the one specified in RFC-5424 or RFC-3164.
    • Attribute Value
    Default Value RFC5424
    Type STRING
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services
    Allowed Values RFC5424
    RFC3164
  • truncate Whether or not a message, including the header, should truncate the message if the length in bytes is greater than the maximum length. If set to false messages will be split and sent with the same header values.
    • Attribute Value
    Default Value false
    Type BOOLEAN
    Nillable true
    Expressions Allowed true
    Storage configuration
    Access Type read-write
    Restart Required no-services

Operations (3)

  • add Adds an audit log syslog handler.
    Request Parameter Type Required Expressions Allowed Default value Description
    formatter STRING true false The formatter used to format the log messages.
    app-name STRING false true The application name to add to the syslog records as defined in section 6.2.5 of RFC-5424. If not specified it will default to the name of the product.
    max-length INT false true The maximum length in bytes a log message, including the header, is allowed to be. If undefined, it will default to 1024 bytes if the syslog-format is RFC3164, or 2048 bytes if the syslog-format is RFC5424.
    facility STRING false true USER_LEVEL The facility to use for syslog logging as defined in section 6.2.1 of RFC-5424, and section 4.1.1 of RFC-3164.
    truncate BOOLEAN false true false Whether or not a message, including the header, should truncate the message if the length in bytes is greater than the maximum length. If set to false messages will be split and sent with the same header values.
    max-failure-count INT false true 10 The maximum number of logging failures before disabling this handler.
    syslog-format STRING false true RFC5424 Whether to set the syslog format to the one specified in RFC-5424 or RFC-3164.
  • recycle Resets the syslog handler failure count, disconnects and reconnects to the syslog server.
  • remove Removes an audit log syslog handler.