SMTPClient#
SMTP client can be used both from command line and from queries to check remote systes via SMTP
List of commands#
A list of all available queries (check commands)
Command | Description |
---|---|
submit_smtp | Submit information to the remote SMTP server. |
List of Configuration#
Common Keys#
Path / Section | Key | Description |
---|---|---|
/settings/SMTP/client | channel | CHANNEL |
/settings/SMTP/client/targets/default | address | TARGET ADDRESS |
/settings/SMTP/client/targets/default | retries | RETRIES |
/settings/SMTP/client/targets/default | timeout | TIMEOUT |
Advanced keys#
Path / Section | Key | Description |
---|---|---|
/settings/SMTP/client/targets/default | host | TARGET HOST |
/settings/SMTP/client/targets/default | port | TARGET PORT |
Sample keys#
Path / Section | Key | Description |
---|---|---|
/settings/SMTP/client/targets/sample | address | TARGET ADDRESS |
/settings/SMTP/client/targets/sample | host | TARGET HOST |
/settings/SMTP/client/targets/sample | port | TARGET PORT |
/settings/SMTP/client/targets/sample | retries | RETRIES |
/settings/SMTP/client/targets/sample | timeout | TIMEOUT |
Queries#
A quick reference for all available queries (check commands) in the SMTPClient module.
submit_smtp#
Submit information to the remote SMTP 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) | |
retries | legacy version of retry | |
source-host | Source/sender host name (default is auto which means use the name of the actual host) | |
sender-host | Source/sender host name (default is auto which means use the name of the actual host) | |
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 | |
separator | Separator to use for the batch command (default is | |
batch | Add multiple records using the separator format is: command | |
sender | Length of payload (has to be same as on the server) | |
recipient | Length of payload (has to be same as on the server) | |
template | Do not initial an ssl handshake with the server, talk in plain text. | |
source-host | Source/sender host name (default is auto which means use the name of the actual host) | |
sender-host | Source/sender host name (default is auto which means use the name of the actual host) |
help#
Description: Show help screen (this screen)
help-pb#
Description: Show help screen as a protocol buffer payload
show-default#
Description: Show default values for a given command
help-short#
Description: Show help screen (short format).
host#
Description: The host of the host running the server
port#
Description: The port of the host running the server
address#
Description: The address (host:port) of the host running the server
timeout#
Description: Number of seconds before connection times out (default=10)
target#
Description: Target to use (lookup connection info from config)
retry#
Description: Number of times ti retry a failed connection attempt (default=2)
retries#
Description: legacy version of retry
source-host#
Description: Source/sender host name (default is auto which means use the name of the actual host)
sender-host#
Description: Source/sender host name (default is auto which means use the name of the actual host)
command#
Description: The name of the command that the remote daemon should run
alias#
Description: Same as command
message#
Description: Message
result#
Description: Result code either a number or OK, WARN, CRIT, UNKNOWN
separator#
Description: Separator to use for the batch command (default is |)
batch#
Description: Add multiple records using the separator format is: command|result|message
sender#
Description: Length of payload (has to be same as on the server)
recipient#
Description: Length of payload (has to be same as on the server)
template#
Description: Do not initial an ssl handshake with the server, talk in plain text.
source-host#
Description: Source/sender host name (default is auto which means use the name of the actual host)
sender-host#
Description: Source/sender host name (default is auto which means use the name of the actual host)
Configuration#
SMTP CLIENT SECTION#
Section for SMTP passive check module.
# Section for SMTP passive check module. [/settings/SMTP/client] channel=SMTP
Key | Default Value | Description |
---|---|---|
channel | SMTP | CHANNEL |
channel#
CHANNEL
The channel to listen to.
Key | Description |
---|---|
Path: | /settings/SMTP/client |
Key: | channel |
Default value: | SMTP |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client] # CHANNEL channel=SMTP
CLIENT HANDLER SECTION#
# [/settings/SMTP/client/handlers]
REMOTE TARGET DEFINITIONS#
# [/settings/SMTP/client/targets]
TARGET#
Target definition for: default
# Target definition for: default [/settings/SMTP/client/targets/default] retries=3 timeout=30
Key | Default Value | Description |
---|---|---|
address | TARGET ADDRESS | |
host | TARGET HOST | |
port | TARGET PORT | |
retries | 3 | RETRIES |
timeout | 30 | TIMEOUT |
address#
TARGET ADDRESS
Target host address
Key | Description |
---|---|
Path: | /settings/SMTP/client/targets/default |
Key: | address |
Default value: | N/A |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client/targets/default] # TARGET ADDRESS address=
host#
TARGET HOST
The target server to report results to.
Key | Description |
---|---|
Path: | /settings/SMTP/client/targets/default |
Key: | host |
Advanced: | Yes (means it is not commonly used) |
Default value: | N/A |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client/targets/default] # TARGET HOST host=
port#
TARGET PORT
The target server port
Key | Description |
---|---|
Path: | /settings/SMTP/client/targets/default |
Key: | port |
Advanced: | Yes (means it is not commonly used) |
Default value: | N/A |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client/targets/default] # TARGET PORT port=
retries#
RETRIES
Number of times to retry sending.
Key | Description |
---|---|
Path: | /settings/SMTP/client/targets/default |
Key: | retries |
Default value: | 3 |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client/targets/default] # RETRIES retries=3
timeout#
TIMEOUT
Timeout when reading/writing packets to/from sockets.
Key | Description |
---|---|
Path: | /settings/SMTP/client/targets/default |
Key: | timeout |
Default value: | 30 |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client/targets/default] # TIMEOUT timeout=30
TARGET#
Target definition for: sample
# Target definition for: sample [/settings/SMTP/client/targets/sample] retries=3 timeout=30
Key | Default Value | Description |
---|---|---|
address | TARGET ADDRESS | |
host | TARGET HOST | |
port | TARGET PORT | |
retries | 3 | RETRIES |
timeout | 30 | TIMEOUT |
address#
TARGET ADDRESS
Target host address
Key | Description |
---|---|
Path: | /settings/SMTP/client/targets/sample |
Key: | address |
Default value: | N/A |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client/targets/sample] # TARGET ADDRESS address=
host#
TARGET HOST
The target server to report results to.
Key | Description |
---|---|
Path: | /settings/SMTP/client/targets/sample |
Key: | host |
Advanced: | Yes (means it is not commonly used) |
Default value: | N/A |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client/targets/sample] # TARGET HOST host=
port#
TARGET PORT
The target server port
Key | Description |
---|---|
Path: | /settings/SMTP/client/targets/sample |
Key: | port |
Advanced: | Yes (means it is not commonly used) |
Default value: | N/A |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client/targets/sample] # TARGET PORT port=
retries#
RETRIES
Number of times to retry sending.
Key | Description |
---|---|
Path: | /settings/SMTP/client/targets/sample |
Key: | retries |
Default value: | 3 |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client/targets/sample] # RETRIES retries=3
timeout#
TIMEOUT
Timeout when reading/writing packets to/from sockets.
Key | Description |
---|---|
Path: | /settings/SMTP/client/targets/sample |
Key: | timeout |
Default value: | 30 |
Sample key: | Yes (This section is only to show how this key is used) |
Used by: | SMTPClient |
Sample#
[/settings/SMTP/client/targets/sample] # TIMEOUT timeout=30