SMTPClient
SMTP client can be used both from command line and from queries to check remote systes via SMTP
Queries
A quick reference for all available queries (check commands) in the SMTPClient module.
List of commands:
A list of all available queries (check commands)
| Command | Description |
|---|---|
| submit_smtp | Submit information to the remote SMTP server. |
submit_smtp
Submit information to the remote SMTP server.
Command-line Arguments
| 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) |
Configuration
| Path / Section | Description |
|---|---|
| /settings/SMTP/client | SMTP CLIENT SECTION |
| /settings/SMTP/client/handlers | CLIENT HANDLER SECTION |
| /settings/SMTP/client/targets | REMOTE TARGET DEFINITIONS |
SMTP CLIENT SECTION
Section for SMTP passive check module.
| Key | Default Value | Description |
|---|---|---|
| channel | SMTP | CHANNEL |
# Section for SMTP passive check module.
[/settings/SMTP/client]
channel=SMTP
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
This is a section of objects. This means that you will create objects below this point by adding sections which all look the same.
REMOTE TARGET DEFINITIONS
This is a section of objects. This means that you will create objects below this point by adding sections which all look the same.
Keys:
| Key | Default Value | Description |
|---|---|---|
| address | TARGET ADDRESS | |
| host | TARGET HOST | |
| port | TARGET PORT | |
| retries | 3 | RETRIES |
| timeout | 30 | TIMEOUT |
Sample:
# An example of a REMOTE TARGET DEFINITIONS section
[/settings/SMTP/client/targets/sample]
#address=...
#host=...
#port=...
retries=3
timeout=30