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 avalible queries (check commands)

Command Description
syslog_submit Submit information to remote syslog server.

Commands (executable): TODO: Add command list

Configuration (Overview):

A list of all configuration options

Path / Section Key Default value Description
/settings/syslog/client hostname   HOSTNAME
/settings/syslog/client channel syslog CHANNEL
/settings/syslog/client/handlers     CLIENT HANDLER SECTION
/settings/syslog/client/targets     REMOTE TARGET DEFINITIONS
/settings/syslog/client/targets/default ok severity informational TODO
/settings/syslog/client/targets/default severity error TODO
/settings/syslog/client/targets/default facility kernel TODO
/settings/syslog/client/targets/default critical severity critical TODO
/settings/syslog/client/targets/default message_syntax %message% TODO
/settings/syslog/client/targets/default unknown severity emergency TODO
/settings/syslog/client/targets/default tag_syntax NSCA TODO
/settings/syslog/client/targets/default address   TARGET ADDRESS
/settings/syslog/client/targets/default warning severity warning TODO

Advanced keys:

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

Sample keys:

Path / Section Key Default value Description
/settings/syslog/client/targets/sample ok severity informational TODO
/settings/syslog/client/targets/sample severity error TODO
/settings/syslog/client/targets/sample parent default PARENT
/settings/syslog/client/targets/sample facility kernel TODO
/settings/syslog/client/targets/sample critical severity critical TODO
/settings/syslog/client/targets/sample message_syntax %message% TODO
/settings/syslog/client/targets/sample port 0 TARGET PORT
/settings/syslog/client/targets/sample alias   ALIAS
/settings/syslog/client/targets/sample host   TARGET HOST
/settings/syslog/client/targets/sample unknown severity emergency TODO
/settings/syslog/client/targets/sample tag_syntax NSCA TODO
/settings/syslog/client/targets/sample address   TARGET ADDRESS
/settings/syslog/client/targets/sample warning severity warning TODO
/settings/syslog/client/targets/sample is template 0 IS TEMPLATE

Queries

A quick reference for all avalible 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-csv N/A Show help screen as a comma separated list.
help-short N/A Show help screen (short format).
host N/A The host of the host running the server
port N/A The port of the host running the server
address N/A The address (host:port) of the host running the server
timeout N/A Number of seconds before connection times out (default=10)
target N/A Target to use (lookup connection info from config)
retry N/A Number of times ti retry a failed connection attempt (default=2)
command N/A The name of the command that the remote daemon should run
alias N/A Same as command
message N/A Message
result N/A Result code either a number or OK, WARN, CRIT, UNKNOWN
severity N/A Severity of error message
unknown-severity N/A Severity of error message
ok-severity N/A Severity of error message
warning-severity N/A Severity of error message
critical-severity N/A Severity of error message
facility N/A Facility of error message
tag template N/A Tag template (TODO)
message template N/A Message template (TODO)

Arguments

help (SyslogClient, syslog_submit)
Show help screen (this screen)
help-csv (SyslogClient, syslog_submit)
Show help screen as a comma separated list.
This is useful for parsing the output in scripts and generate documentation etc
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)

Configuration

A quick reference for all avalible configuration options in the SyslogClient module.

... / client

/settings/syslog/client (SyslogClient)
Key Default Value Description
channel syslog CHANNEL
hostname   HOSTNAME

Sample:

# SYSLOG CLIENT SECTION
# Section for SYSLOG passive check module.
[/settings/syslog/client]
# HOSTNAME
# The host name of this host if set to blank (default) the windows name of the computer will be used.
hostname=
# CHANNEL
# The channel to listen to.
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:

# HOSTNAME
# The host name of this host if set to blank (default) the windows name of the computer will be used.
[/settings/syslog/client]
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:

# CHANNEL
# The channel to listen to.
[/settings/syslog/client]
channel=syslog

... / client / targets / default

/settings/syslog/client/targets/default (SyslogClient)
Key Default Value Description
address   TARGET ADDRESS
critical severity critical TODO
facility kernel TODO
message_syntax %message% TODO
ok severity informational TODO
severity error TODO
tag_syntax NSCA TODO
unknown severity emergency TODO
warning severity warning TODO
alias   ALIAS
host   TARGET HOST
is template 0 IS TEMPLATE
parent default PARENT
port 0 TARGET PORT

Sample:

# TARGET DEFENITION
# Target definition for: default
[/settings/syslog/client/targets/default]
# TODO
#
ok severity=informational
# TODO
#
severity=error
# PARENT
# The parent the target inherits from
parent=default
# TODO
#
facility=kernel
# TODO
#
critical severity=critical
# TODO
#
message_syntax=%message%
# TARGET PORT
# The target server port
port=0
# ALIAS
# The alias (service name) to report to server
alias=
# TARGET HOST
# The target server to report results to.
host=
# TODO
#
unknown severity=emergency
# TODO
#
tag_syntax=NSCA
# TARGET ADDRESS
# Target host address
address=
# TODO
#
warning severity=warning
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
is template=0
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:

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

TODO


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

Key: severity

Default value: error

Used by: SyslogClient

Sample:

# TODO
#
[/settings/syslog/client/targets/default]
severity=error
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:

# PARENT
# The parent the target inherits from
[/settings/syslog/client/targets/default]
parent=default
facility (SyslogClient, /settings/syslog/client/targets/default)

TODO


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

Key: facility

Default value: kernel

Used by: SyslogClient

Sample:

# TODO
#
[/settings/syslog/client/targets/default]
facility=kernel
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:

# TODO
#
[/settings/syslog/client/targets/default]
critical severity=critical
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:

# TODO
#
[/settings/syslog/client/targets/default]
message_syntax=%message%
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:

# TARGET PORT
# The target server port
[/settings/syslog/client/targets/default]
port=0
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:

# ALIAS
# The alias (service name) to report to server
[/settings/syslog/client/targets/default]
alias=
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:

# TARGET HOST
# The target server to report results to.
[/settings/syslog/client/targets/default]
host=
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:

# TODO
#
[/settings/syslog/client/targets/default]
unknown severity=emergency
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:

# TODO
#
[/settings/syslog/client/targets/default]
tag_syntax=NSCA
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:

# TARGET ADDRESS
# Target host address
[/settings/syslog/client/targets/default]
address=
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:

# TODO
#
[/settings/syslog/client/targets/default]
warning severity=warning
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:

# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
[/settings/syslog/client/targets/default]
is template=0

... / client / targets

/settings/syslog/client/targets (SyslogClient)

Sample:

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

... / client / targets / sample

/settings/syslog/client/targets/sample (SyslogClient)
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]
# TODO
#
ok severity=informational
# TODO
#
severity=error
# PARENT
# The parent the target inherits from
parent=default
# TODO
#
facility=kernel
# TODO
#
critical severity=critical
# TODO
#
message_syntax=%message%
# TARGET PORT
# The target server port
port=0
# ALIAS
# The alias (service name) to report to server
alias=
# TARGET HOST
# The target server to report results to.
host=
# TODO
#
unknown severity=emergency
# TODO
#
tag_syntax=NSCA
# TARGET ADDRESS
# Target host address
address=
# TODO
#
warning severity=warning
# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
is template=0
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:

# TODO
#
[/settings/syslog/client/targets/sample]
ok severity=informational
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:

# TODO
#
[/settings/syslog/client/targets/sample]
severity=error
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:

# PARENT
# The parent the target inherits from
[/settings/syslog/client/targets/sample]
parent=default
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:

# TODO
#
[/settings/syslog/client/targets/sample]
facility=kernel
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:

# TODO
#
[/settings/syslog/client/targets/sample]
critical severity=critical
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:

# TODO
#
[/settings/syslog/client/targets/sample]
message_syntax=%message%
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:

# TARGET PORT
# The target server port
[/settings/syslog/client/targets/sample]
port=0
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:

# ALIAS
# The alias (service name) to report to server
[/settings/syslog/client/targets/sample]
alias=
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:

# TARGET HOST
# The target server to report results to.
[/settings/syslog/client/targets/sample]
host=
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:

# TODO
#
[/settings/syslog/client/targets/sample]
unknown severity=emergency
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:

# TODO
#
[/settings/syslog/client/targets/sample]
tag_syntax=NSCA
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:

# TARGET ADDRESS
# Target host address
[/settings/syslog/client/targets/sample]
address=
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:

# TODO
#
[/settings/syslog/client/targets/sample]
warning severity=warning
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:

# IS TEMPLATE
# Declare this object as a template (this means it will not be available as a separate object)
[/settings/syslog/client/targets/sample]
is template=0

... / client / handlers

/settings/syslog/client/handlers (SyslogClient)

Sample:

# CLIENT HANDLER SECTION
#
[/settings/syslog/client/handlers]
comments powered by Disqus