SyslogClient
Forward information as syslog messages to a syslog server

SyslogClient — SyslogClient

Forward information as syslog messages to a syslog server

Queries (Overview):

A list of all available queries (check commands)

Command Description
syslog_submit Submit information to remote syslog server.

Commands (Overview):

TODO: Add a list of all external commands (this is not check commands)

Configuration (Overview):

Common Keys:

Path / Section Key Description
/settings/syslog/client channel CHANNEL
/settings/syslog/client hostname HOSTNAME
/settings/syslog/client/targets/default address TARGET ADDRESS
/settings/syslog/client/targets/default critical severity TODO
/settings/syslog/client/targets/default facility TODO
/settings/syslog/client/targets/default message_syntax TODO
/settings/syslog/client/targets/default ok severity TODO
/settings/syslog/client/targets/default severity TODO
/settings/syslog/client/targets/default tag_syntax TODO
/settings/syslog/client/targets/default unknown severity TODO
/settings/syslog/client/targets/default warning severity TODO

Advanced keys:

Path / Section Key Default Value Description
/settings/syslog/client/targets/default alias ALIAS  
/settings/syslog/client/targets/default host TARGET HOST  
/settings/syslog/client/targets/default is template IS TEMPLATE  
/settings/syslog/client/targets/default parent PARENT  
/settings/syslog/client/targets/default port TARGET PORT  

Sample keys:

Path / Section Key Default Value Description
/settings/syslog/client/targets/sample address TARGET ADDRESS  
/settings/syslog/client/targets/sample alias ALIAS  
/settings/syslog/client/targets/sample critical severity TODO  
/settings/syslog/client/targets/sample facility TODO  
/settings/syslog/client/targets/sample host TARGET HOST  
/settings/syslog/client/targets/sample is template IS TEMPLATE  
/settings/syslog/client/targets/sample message_syntax TODO  
/settings/syslog/client/targets/sample ok severity TODO  
/settings/syslog/client/targets/sample parent PARENT  
/settings/syslog/client/targets/sample port TARGET PORT  
/settings/syslog/client/targets/sample severity TODO  
/settings/syslog/client/targets/sample tag_syntax TODO  
/settings/syslog/client/targets/sample unknown severity TODO  
/settings/syslog/client/targets/sample warning severity TODO  

Queries

A quick reference for all available queries (check commands) in the SyslogClient module.

syslog_submit

SyslogClientsyslog_submit
Submit information to remote syslog server.

Usage:

Option Default Value Description
help N/A Show help screen (this screen)
help-pb N/A Show help screen as a protocol buffer payload
show-default N/A Show default values for a given command
help-short N/A Show help screen (short format).
host   The host of the host running the server
port   The port of the host running the server
address   The address (host:port) of the host running the server
timeout   Number of seconds before connection times out (default=10)
target   Target to use (lookup connection info from config)
retry   Number of times ti retry a failed connection attempt (default=2)
command   The name of the command that the remote daemon should run
alias   Same as command
message   Message
result   Result code either a number or OK, WARN, CRIT, UNKNOWN
severity   Severity of error message
unknown-severity   Severity of error message
ok-severity   Severity of error message
warning-severity   Severity of error message
critical-severity   Severity of error message
facility   Facility of error message
tag template   Tag template (TODO)
message template   Message template (TODO)

Arguments

help (SyslogClient, syslog_submit)
Show help screen (this screen)
help-pb (SyslogClient, syslog_submit)
Show help screen as a protocol buffer payload
show-default (SyslogClient, syslog_submit)
Show default values for a given command
help-short (SyslogClient, syslog_submit)
Show help screen (short format).
host (SyslogClient, syslog_submit)
The host of the host running the server
port (SyslogClient, syslog_submit)
The port of the host running the server
address (SyslogClient, syslog_submit)
The address (host:port) of the host running the server
timeout (SyslogClient, syslog_submit)
Number of seconds before connection times out (default=10)
target (SyslogClient, syslog_submit)
Target to use (lookup connection info from config)
retry (SyslogClient, syslog_submit)
Number of times ti retry a failed connection attempt (default=2)
command (SyslogClient, syslog_submit)
The name of the command that the remote daemon should run
alias (SyslogClient, syslog_submit)
Same as command
message (SyslogClient, syslog_submit)
Message
result (SyslogClient, syslog_submit)
Result code either a number or OK, WARN, CRIT, UNKNOWN
severity (SyslogClient, syslog_submit)
Severity of error message
unknown-severity (SyslogClient, syslog_submit)
Severity of error message
ok-severity (SyslogClient, syslog_submit)
Severity of error message
warning-severity (SyslogClient, syslog_submit)
Severity of error message
critical-severity (SyslogClient, syslog_submit)
Severity of error message
facility (SyslogClient, syslog_submit)
Facility of error message
tag template (SyslogClient, syslog_submit)
Tag template (TODO)
message template (SyslogClient, syslog_submit)
Message template (TODO)

/ settings/ syslog/ client

/settings/syslog/client (SyslogClient)

SYSLOG CLIENT SECTION

Section for SYSLOG passive check module.
Key Default Value Description
channel syslog CHANNEL
hostname   HOSTNAME

Sample:

# SYSLOG CLIENT SECTION
# Section for SYSLOG passive check module.
[/settings/syslog/client]
channel=syslog
hostname=
channel (SyslogClient, /settings/syslog/client)

CHANNEL

The channel to listen to.

Path: /settings/syslog/client

Key: channel

Default value: syslog

Used by: SyslogClient

Sample:

[/settings/syslog/client]
# CHANNEL
channel=syslog
hostname (SyslogClient, /settings/syslog/client)

HOSTNAME

The host name of this host if set to blank (default) the windows name of the computer will be used.

Path: /settings/syslog/client

Key: hostname

Default value:

Used by: SyslogClient

Sample:

[/settings/syslog/client]
# HOSTNAME
hostname=

… / handlers

/settings/syslog/client/handlers (SyslogClient)

CLIENT HANDLER SECTION

Sample:

# CLIENT HANDLER SECTION
#
[/settings/syslog/client/handlers]

… / targets

/settings/syslog/client/targets (SyslogClient)

REMOTE TARGET DEFINITIONS

Sample:

# REMOTE TARGET DEFINITIONS
#
[/settings/syslog/client/targets]

… / targets / default

/settings/syslog/client/targets/default (SyslogClient)

TARGET DEFENITION

Target definition for: default
Key Default Value Description
address   TARGET ADDRESS
alias   ALIAS
critical severity critical TODO
facility kernel TODO
host   TARGET HOST
is template 0 IS TEMPLATE
message_syntax %message% TODO
ok severity informational TODO
parent default PARENT
port 0 TARGET PORT
severity error TODO
tag_syntax NSCA TODO
unknown severity emergency TODO
warning severity warning TODO

Sample:

# TARGET DEFENITION
# Target definition for: default
[/settings/syslog/client/targets/default]
address=
alias=
critical severity=critical
facility=kernel
host=
is template=0
message_syntax=%message%
ok severity=informational
parent=default
port=0
severity=error
tag_syntax=NSCA
unknown severity=emergency
warning severity=warning
address (SyslogClient, /settings/syslog/client/targets/default)

TARGET ADDRESS

Target host address

Path: /settings/syslog/client/targets/default

Key: address

Default value:

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TARGET ADDRESS
address=
alias (SyslogClient, /settings/syslog/client/targets/default)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/syslog/client/targets/default

Key: alias

Default value:

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# ALIAS
alias=
critical severity (SyslogClient, /settings/syslog/client/targets/default)

TODO

Path: /settings/syslog/client/targets/default

Key: critical severity

Default value: critical

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TODO
critical severity=critical
facility (SyslogClient, /settings/syslog/client/targets/default)

TODO

Path: /settings/syslog/client/targets/default

Key: facility

Default value: kernel

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TODO
facility=kernel
host (SyslogClient, /settings/syslog/client/targets/default)

TARGET HOST

The target server to report results to.

Advanced (means it is not commonly used)

Path: /settings/syslog/client/targets/default

Key: host

Default value:

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TARGET HOST
host=
is template (SyslogClient, /settings/syslog/client/targets/default)

IS TEMPLATE

Declare this object as a template (this means it will not be available as a separate object)

Advanced (means it is not commonly used)

Path: /settings/syslog/client/targets/default

Key: is template

Default value: 0

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# IS TEMPLATE
is template=0
message_syntax (SyslogClient, /settings/syslog/client/targets/default)

TODO

Path: /settings/syslog/client/targets/default

Key: message_syntax

Default value: %message%

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TODO
message_syntax=%message%
ok severity (SyslogClient, /settings/syslog/client/targets/default)

TODO

Path: /settings/syslog/client/targets/default

Key: ok severity

Default value: informational

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TODO
ok severity=informational
parent (SyslogClient, /settings/syslog/client/targets/default)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/syslog/client/targets/default

Key: parent

Default value: default

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# PARENT
parent=default
port (SyslogClient, /settings/syslog/client/targets/default)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/syslog/client/targets/default

Key: port

Default value: 0

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TARGET PORT
port=0
severity (SyslogClient, /settings/syslog/client/targets/default)

TODO

Path: /settings/syslog/client/targets/default

Key: severity

Default value: error

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TODO
severity=error
tag_syntax (SyslogClient, /settings/syslog/client/targets/default)

TODO

Path: /settings/syslog/client/targets/default

Key: tag_syntax

Default value: NSCA

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TODO
tag_syntax=NSCA
unknown severity (SyslogClient, /settings/syslog/client/targets/default)

TODO

Path: /settings/syslog/client/targets/default

Key: unknown severity

Default value: emergency

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TODO
unknown severity=emergency
warning severity (SyslogClient, /settings/syslog/client/targets/default)

TODO

Path: /settings/syslog/client/targets/default

Key: warning severity

Default value: warning

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/default]
# TODO
warning severity=warning

… / targets / sample

/settings/syslog/client/targets/sample (SyslogClient)

TARGET DEFENITION

Target definition for: sample
Key Default Value Description
address   TARGET ADDRESS
alias   ALIAS
critical severity critical TODO
facility kernel TODO
host   TARGET HOST
is template 0 IS TEMPLATE
message_syntax %message% TODO
ok severity informational TODO
parent default PARENT
port 0 TARGET PORT
severity error TODO
tag_syntax NSCA TODO
unknown severity emergency TODO
warning severity warning TODO

Sample:

# TARGET DEFENITION
# Target definition for: sample
[/settings/syslog/client/targets/sample]
address=
alias=
critical severity=critical
facility=kernel
host=
is template=0
message_syntax=%message%
ok severity=informational
parent=default
port=0
severity=error
tag_syntax=NSCA
unknown severity=emergency
warning severity=warning
address (SyslogClient, /settings/syslog/client/targets/sample)

TARGET ADDRESS

Target host address

Path: /settings/syslog/client/targets/sample

Key: address

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TARGET ADDRESS
address=
alias (SyslogClient, /settings/syslog/client/targets/sample)

ALIAS

The alias (service name) to report to server

Advanced (means it is not commonly used)

Path: /settings/syslog/client/targets/sample

Key: alias

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# ALIAS
alias=
critical severity (SyslogClient, /settings/syslog/client/targets/sample)

TODO

Path: /settings/syslog/client/targets/sample

Key: critical severity

Default value: critical

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TODO
critical severity=critical
facility (SyslogClient, /settings/syslog/client/targets/sample)

TODO

Path: /settings/syslog/client/targets/sample

Key: facility

Default value: kernel

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TODO
facility=kernel
host (SyslogClient, /settings/syslog/client/targets/sample)

TARGET HOST

The target server to report results to.

Advanced (means it is not commonly used)

Path: /settings/syslog/client/targets/sample

Key: host

Default value:

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TARGET HOST
host=
is template (SyslogClient, /settings/syslog/client/targets/sample)

IS TEMPLATE

Declare this object as a template (this means it will not be available as a separate object)

Advanced (means it is not commonly used)

Path: /settings/syslog/client/targets/sample

Key: is template

Default value: 0

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# IS TEMPLATE
is template=0
message_syntax (SyslogClient, /settings/syslog/client/targets/sample)

TODO

Path: /settings/syslog/client/targets/sample

Key: message_syntax

Default value: %message%

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TODO
message_syntax=%message%
ok severity (SyslogClient, /settings/syslog/client/targets/sample)

TODO

Path: /settings/syslog/client/targets/sample

Key: ok severity

Default value: informational

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TODO
ok severity=informational
parent (SyslogClient, /settings/syslog/client/targets/sample)

PARENT

The parent the target inherits from

Advanced (means it is not commonly used)

Path: /settings/syslog/client/targets/sample

Key: parent

Default value: default

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# PARENT
parent=default
port (SyslogClient, /settings/syslog/client/targets/sample)

TARGET PORT

The target server port

Advanced (means it is not commonly used)

Path: /settings/syslog/client/targets/sample

Key: port

Default value: 0

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TARGET PORT
port=0
severity (SyslogClient, /settings/syslog/client/targets/sample)

TODO

Path: /settings/syslog/client/targets/sample

Key: severity

Default value: error

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TODO
severity=error
tag_syntax (SyslogClient, /settings/syslog/client/targets/sample)

TODO

Path: /settings/syslog/client/targets/sample

Key: tag_syntax

Default value: NSCA

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TODO
tag_syntax=NSCA
unknown severity (SyslogClient, /settings/syslog/client/targets/sample)

TODO

Path: /settings/syslog/client/targets/sample

Key: unknown severity

Default value: emergency

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TODO
unknown severity=emergency
warning severity (SyslogClient, /settings/syslog/client/targets/sample)

TODO

Path: /settings/syslog/client/targets/sample

Key: warning severity

Default value: warning

Sample key: This key is provided as a sample to show how to configure objects

Used by: SyslogClient

Sample:

[/settings/syslog/client/targets/sample]
# TODO
warning severity=warning
comments powered by Disqus